Skip to content
Tallyraydocs

Export a report's query, a view (with buyer:read for a key) or a log in the background: a gzipped CSV kept 7 days, its link mailed to you once it's made, and sent to the ready destinations named, a buyer's or a key's with buyer:write. 2 under way per member or key, 10 per workspace, 100 a day, 10 GiB of files

POST
/v1/buyer/exports
curl --request POST \
  --url https://example.com/v1/buyer/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "destination_ids": [ 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" }, "name": "example", "report": { "columns": [ "visits" ], "compare": { "dates": { "from": "example", "to": "example" }, "preset": "previous_period" }, "currency": "example", "filter_labels": [ { "dimension": "hour", "label": "example", "value": "example" } ], "filters": [ { "dimension": "hour", "exclude": true, "values": [ "example" ] } ], "group_by": [ "hour" ], "model": "last_click", "range": { "dates": { "from": "example", "to": "example" }, "preset": "today" }, "sort": [ "example" ], "time_basis": "visit", "time_zone": "example", "trends": [ { "kind": "moving_average", "measure": "visits", "window": 1 } ] }, "view_id": 1 }'

Who: a workspace’s buyer or viewer, or its key. API keys with the stats:read scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
destination_ids
Array<integer>
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
name
string
report
Any of:
object
columns
Array<string>
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
Any of:
object
dates
Any of:
object
from
required
string
to
required
string
preset
string
Allowed values: previous_period
currency
string
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>
group_by
Array<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
model
string
Allowed values: last_click first_click linear time_decay position_based
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
sort
Array<string>
time_basis
string
Allowed values: visit conversion
time_zone
string
trends
Array<object>
object
kind
required
string
Allowed values: moving_average linear
measure
required
string
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
integer format: int32
view_id
integer format: int64

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
bytes
required
integer format: int64
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
deliveries
required
Array<object>
object
attempts
required
integer format: int32
delivered_at
required
string | null format: date-time
destination_id
required
integer format: int64
destination_name
required
string
message
required
string
object_name
required
string
reason
required
string
status
required
string | null
Allowed values: pending delivered failed
expires_at
required
string | null format: date-time
filename
required
string
finished_at
required
string | null format: date-time
from
required
string format: date-time
id
required
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
name
required
string
reason
required
string
report
required
Any of:
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
rows
required
integer format: int64
run_id
required
string
schedule_id
required
integer format: int64
started_at
required
string | null format: date-time
status
required
string | null
Allowed values: queued running succeeded failed expired
time_zone
required
string
to
required
string format: date-time
total_rows
required
integer format: int64
truncated
required
boolean
view_id
required
integer format: int64
workspace_id
required
integer format: int64

Example 

{
  "created_by": {
    "kind": "user"
  },
  "deliveries": [
    {
      "status": "pending"
    }
  ],
  "log": {
    "filter_labels": [
      {
        "dimension": "hour"
      }
    ],
    "filters": [
      {
        "dimension": "hour"
      }
    ],
    "kind": "visits",
    "range": {
      "preset": "today"
    }
  },
  "report": {
    "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": "queued"
}

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