...
Retrieve report data
| Блок кода | ||
|---|---|---|
| ||
GET https://uireporting.getintent.com/api/v1/bigdatav2/reports?token=<token>&dataset_name=<dataset>&start=<start_date>&end=<end_date> |
Parameters:
| 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 | text | ../reports?token=<token>&format=json |
csv_separator | Single character which is used as a separator in case format is CSV. | no | ; - semicolon , - comma | \t - tab | ../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 | |
values | Only specified "value_fields" will be outputed. | no |
| Value fields names (available values can be retrieved by meta_data API) | all columns |
../reports?token=<token>& |
values= |
imps, |
cpm | |
filter[] | Filtering |
by 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) / ne (is not equal). Backwards compatibility: you can use is_not |
for "is not equal |
". field - field name values - CSV values for filtered key. | null | ../reports?token=<token>&filter[]=eq:country:RU,UA&filter[]= |
ne:advertiser_id:27 | |||||
having[] | Filtering by value. | no | Having value's format is <op>:<field>:<values> Each separated value should be specified at new having[] key op - comparison operation. Available options: lt (less than) / le (less or equal) / gt (greater than) / ge (greater or equal). field - field name values - CSV values for filtered key. | null | ../reports?token=<token>&having[]=ge:clicks:100&having[]=lt:imps:1000000 |
limit | Output rows limit. | no |
| Integer max rows number |
| 10000 |
| ||||
relations | Adds a node with relations info (e.g. for campaigns:
| no | binary value (0 or 1) | 0 | ../reports?token=<token>&relations=1 |
Meta Data
Returns Meta Data for report building.
| Блок кода | ||
|---|---|---|
| ||
GET https://uireporting.getintent.com/api/v1/bigdata/reports/meta_datav2/metadata?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",
...
}
]
} |
...