...
Parameters:
| Parameter | Description | Required | Values | Default | Example |
|---|---|---|---|---|---|
| token It's required. Validates if method is available for particular user. Affects on data available for report building according to access settings. | User RTBSuite UI access token. Is always required, affects available reporting info. | yes | It's string value. Can be found at "My Settings" menu at API tab | null | ../reports?token=tokenstring |
| formatManages report's format | Reporting format | no | json - json report format text - text report format divided by tab | text | ../reports?token=<token>&format=json |
| dataset_name | Dataset name | yes | The name of registered reporting data set
| null | ../reports?token=<token>&dataset_name=available_inventory |
| start | Report 's period start date.End date is required also. | yes | Date at YYYY-mm-dd format | null | ../reports?token=<token>&start=2015-05-01&end=2015-05-31 |
| end | Report 's period end date.Start date is required also. | yes | Date at YYYY-mm-dd format | null | ../reports?token=<token>&start=2015-05-01&end=2015-05-31 |
| timezone | Timezone report's period | no | Timezone name | UTC | ../reports?token=<token>&timezone=Europe/Moscow |
| keys | "Group by" report data fields.reporting option - results can be grouped by desired keys. Available key fields Fields can be found at Meta Data (meta_data API) | no | Comma-separated field names | null | ../reports?token=<token>&keys=country,os |
| filter[] | Array for report's output data filtering valuesFiltering options. | no | Filter value's format is op<op>:field<field>:values<values> Each separated value should be specified at new filter[] key op - comparison operation. Available options are : eq (is equal) and / is_not (is not equal). field - field name values - CSV values for filtered field. If several values are needed, just list them with comma.key. | null | ../reports?token=<token>&filter[]=eq:country:RU,UA&filter[]=is_not:advertiser_id:27 |
| limit | Output rows number cap. | no | Max rows number expected | 10000 | ../reports?token=<token>&limit=2000 |
...