Skip to content
Tallyraydocs

Source schedules: active, in dry run and paused unless status says

GET
/v1/buyer/automation/schedules
curl --request GET \
  --url 'https://example.com/v1/buyer/automation/schedules?sort=id' \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

status
string
connection_id
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
id
required
integer format: int64
last_transition_at
required
string | null format: date-time
last_transition_id
required
string
name
required
string
next_boundary_at
required
string | null format: date-time
objects
required
Array<object>
object
connection
required
object
id
required
integer format: int64
name
string
key
required
object
country
required
string
source_campaign
required
string
values
required
Array<string>
level
required
string | null
Allowed values: campaign ad_group ad placement
sequence
required
integer format: int64
status
required
string | null
Allowed values: active dry_run paused archived
updated_at
required
string format: date-time
updated_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
week
required
object
hours
required
Array<integer>
time_zone
required
string
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "created_by": {
        "kind": "user"
      },
      "objects": [
        {
          "level": "campaign"
        }
      ],
      "status": "active",
      "updated_by": {
        "kind": "user"
      }
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}