...
| Parameter | Description | Required | Values | Default | Example |
|---|---|---|---|---|---|
token | User's access token, affects available reporting info. | yes | User's token | null | ../reports?token=tokenstring |
format | Reporting format. | no | json - json report format text - text report format divided by tab csv - comma separated values, see csv_separator parameter for possible options csv - text report formart divided by tab | text | ../reports?token=<token>&format=json |
csv_separator | Single character which is used in case format is CSV, defaults to tab. | no | Single character, e.g. semicolon | ../reports?token=<token>&format=json&csv_separator=; | |
dataset_name | Dataset name. | yes | Registered reporting data set name | null | ../reports?token=<token>&dataset_name=available_inventory |
start | Report start date. | yes | Date at YYYY-mm-dd format | null | ../reports?token=<token>&start=2015-05-01&end=2015-05-31 |
end | Report end date. | yes | Date at YYYY-mm-dd format | null | ../reports?token=<token>&start=2015-05-01&end=2015-05-31 |
timezone | Reporting timezone. | no | Timezone name | UTC | ../reports?token=<token>&timezone=Europe/Moscow |
keys | "Group by" reporting option - reporting data can be grouped by desired keys. | no | Grouping keys (available values can be retrieved by meta_data API) | null | ../reports?token=<token>&keys=country,os |
filter[] | Filtering optionsby key. | no | Filter value's format is <op>:<field>:<values> Each separated value should be specified at new filter[] key op - comparison operation. Available options: eq (is equal) / is_not ne (is not equal). field - field name values - CSV values for filtered key. | null | ../reports?token=<token>&filter[]=eq:country:RU,UA&filter[]=is_not:advertiser_id:27 |
having[] | Filtering by value. | no | |||
limit | Output rows limit. | no | Integer max rows number | 10000 |
|
| Separator character for fields delimiting, | no | ; | \t |
|
...