Create a query task

post

https://{buzz_key}.api.beeswax.com/rest/v2/reporting/run-query

Creates a query task to run a query asynchronously. Returns a Query Task ID. The user must have the appropriate permissions to create a query task.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

fields

array of strings

required

length ≥ 1

Which fields to include in the query, e.g. ["advertiser_id", "average_bid_price"]

fields*

view

string

required

The name of the report, retrieved from /reporting/reports, e.g. performance_agg

filters

object

Object of filters in format "field":"filter", e.g. "filters": {"bid_day": "1000 days"}

query_timezone

string

Defaults to your account timezone

pivots

array of strings

List of fields to pivot in the report

pivots

sorts

array of strings

Array of fields to sort by, e.g. ["performance_agg.impression DESC"]

sorts

total

boolean

true, to include calculated totals in output. Defaults to false.

result_format

string

enum

Defaults to json

Allowed:

limit

integer

1 to 30000

Defaults to 30000

Row limit when running a query (maximum 30000)

200