Skip to content
Tallyraydocs

A schedule's runs, the latest first

GET
/v1/buyer/reports/schedules/{id}/runs
curl --request GET \
  --url https://example.com/v1/buyer/reports/schedules/example/runs \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

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

status
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
as_of
required
string | null format: date-time
by_hand
required
boolean
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
due_at
required
string format: date-time
export_id
required
string
finished_at
required
string | null format: date-time
from
required
string | null format: date-time
id
required
string
reason
required
string
recipients
required
integer format: int32
rows
required
integer format: int64
schedule_id
required
integer format: int64
started_at
required
string | null format: date-time
status
required
string | null
Allowed values: running succeeded failed skipped
time_zone
required
string
to
required
string | null format: date-time
truncated
required
boolean
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"
      },
      "status": "running"
    }
  ]
}

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"
  }
}