Skip to content
Tallyraydocs

Send a schedule's report now, off its clock, paused or not, 10 times a day at most, and answer its run once it's made

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

Who: a workspace’s buyer, or its key. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
<= 64 characters

Made once per action and sent again on every retry of it, so the service acts once: the request_id of the create or money-moving call; a new one when left out

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
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

Example 

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