...
| Parameter | Description | Required | Values | Default | Example |
|---|---|---|---|---|---|
| token | User's 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 |
| 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 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 - results can be grouped by desired keys. Available key fields values can be found at Meta Data (retrieved by meta_data API) | noComma | -separated field namesReporting keys | null | ../reports?token=<token>&keys=country,os |
| filter[] | Filtering options. | 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 (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 |
| limit | Output rows limit. | no | Max rows number expected | 10000 | ../reports?token=<token>&limit=2000 |
Meta Data
Returns Meta Data for report building.
| Блок кода | ||
|---|---|---|
| ||
GET https://ui.getintent.com/api/v1/bigdata/reports/meta_data?token=<token> |
Returns Meta Data for report building.output example:
| Блок кода | ||||
|---|---|---|---|---|
| ||||
{
"datasets": [
{
"name": "browser_traffic",
"display_name": {
"en": "Campaigns",
"ru": "Кампании"
},
"bq_dataset_name": "browser_traffic",
"key_fields": {
"deal_id": "STRING",
"geo_available": "STRING",
"day": "TIMESTAMP",
...
"zip_code": "STRING"
},
"value_fields": {
"imps": "INTEGER",
"deliv_imps": "INTEGER",
"unique_imps": "INTEGER",
"clicks": "INTEGER",
...
"p_convs": "FLOAT"
},
"dates": [
"2013_12_25",
"2013_12_26",
"2013_12_27",
"2013_12_28",
...
"2015_07_11",
"2015_07_12",
"2015_07_13"
],
"sorting_key_default": {
"day": "asc",
"hour": "asc",
"month": "asc"
}
},
...
{
"name": "pixel_traffic",
...
}
]
} |