Skip to content
Tallyraydocs

Change a schedule's time, period, recipients or status, or copy its view's name and query again (from_view)

PATCH
/v1/buyer/reports/schedules/{id}
curl --request PATCH \
  --url https://example.com/v1/buyer/reports/schedules/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "destination_ids": [ 1 ], "frequency": "daily", "from_view": true, "hour": 1, "log": { "bot": true, "filter_labels": [ { "dimension": "hour", "label": "example", "value": "example" } ], "filters": [ { "dimension": "hour", "exclude": true, "values": [ "example" ] } ], "kind": "visits", "range": { "dates": { "from": "example", "to": "example" }, "preset": "today" }, "time_zone": "example" }, "month_day": 1, "period": "previous", "recipients": [ { "recipient_id": 1, "user_id": "example" } ], "status": "active", "weekday": 1 }'

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
destination_ids
Array<integer> | null
frequency
string | null
Allowed values: daily weekly monthly
from_view
boolean
hour
integer | null format: int32
log
Any of:
object
bot
boolean | null
filter_labels
Array<object>
object
dimension
required
string
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
label
required
string
value
required
string
filters
Array<object>
object
dimension
required
string
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
exclude
boolean
values
required
Array<string>
kind
required
string
Allowed values: visits clicks
range
required
object
dates
Any of:
object
from
required
string
to
required
string
preset
string
Allowed values: today yesterday last_7_days last_30_days last_90_days month_to_date last_month
time_zone
string
month_day
integer | null format: int32
period
string | null
Allowed values: previous query
recipients
Array<object> | null
object
recipient_id
integer format: int64
user_id
string
status
string | null
Allowed values: active paused
weekday
integer | null format: int32

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
behind_view
required
boolean
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
destination_ids
required
Array<integer>
frequency
required
string | null
Allowed values: daily weekly monthly
hour
required
integer format: int32
id
required
integer format: int64
last_run_at
required
string | null format: date-time
last_run_status
required
string | null
Allowed values: running succeeded failed skipped
left_users
required
Array<object>
object
id
required
string
name
string
log
required
Any of:
object
bot
required
boolean | null
filter_labels
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
label
required
string
value
required
string
filters
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
exclude
required
boolean
values
required
Array<string>
kind
required
string | null
Allowed values: visits clicks
range
required
object
dates
required
Any of:
object
from
required
string
to
required
string
preset
required
string | null
Allowed values: today yesterday last_7_days last_30_days last_90_days month_to_date last_month
time_zone
required
string
month_day
required
integer format: int32
name
required
string
next_run_at
required
string | null format: date-time
owner
required
Any of:
object
id
required
string
name
string
pause_reason
required
string | null
Allowed values: person no_recipients
period
required
string | null
Allowed values: previous query
query
required
object
columns
required
Array<string | null>
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
compare
required
Any of:
object
dates
required
Any of:
object
from
required
string
to
required
string
preset
required
string | null
Allowed values: previous_period
currency
required
string
filter_labels
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
label
required
string
value
required
string
filters
required
Array<object>
object
dimension
required
string | null
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
exclude
required
boolean
values
required
Array<string>
group_by
required
Array<string | null>
Allowed values: hour day week month hour_of_day day_of_week campaign connection flow rule path lander offer network country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain bot_reason event_type conversion_status placement source_campaign creative site keyword v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 v17 v18 v19 v20 step step_lander coupon channel attribution_basis
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
range
required
object
dates
required
Any of:
object
from
required
string
to
required
string
preset
required
string | null
Allowed values: today yesterday last_7_days last_30_days last_90_days month_to_date last_month
sort
required
Array<string>
time_basis
required
string | null
Allowed values: visit conversion
time_zone
required
string
trends
required
Array<object>
object
kind
required
string | null
Allowed values: moving_average linear
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
window
required
integer format: int32
recipients
required
Array<object>
object
recipient_id
required
integer | null format: int64
user
required
Any of:
object
id
required
string
name
string
sequence
required
integer format: int64
status
required
string | null
Allowed values: active paused
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
view_id
required
integer format: int64
weekday
required
integer format: int32
workspace_id
required
integer format: int64

Example 

{
  "created_by": {
    "kind": "user"
  },
  "frequency": "daily",
  "last_run_status": "running",
  "log": {
    "filter_labels": [
      {
        "dimension": "hour"
      }
    ],
    "filters": [
      {
        "dimension": "hour"
      }
    ],
    "kind": "visits",
    "range": {
      "preset": "today"
    }
  },
  "pause_reason": "person",
  "period": "previous",
  "query": {
    "columns": [
      "visits"
    ],
    "compare": {
      "preset": "previous_period"
    },
    "filter_labels": [
      {
        "dimension": "hour"
      }
    ],
    "filters": [
      {
        "dimension": "hour"
      }
    ],
    "group_by": [
      "hour"
    ],
    "model": "last_click",
    "range": {
      "preset": "today"
    },
    "time_basis": "visit",
    "trends": [
      {
        "kind": "moving_average",
        "measure": "visits"
      }
    ]
  },
  "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"
  }
}