-
Создана пользователем
пользователь-1e7cc. Последнее обновление: дек. 20, 2024 ( Иван Сахаров)
Время чтения: 2 мин.
Получить данные отчета:
GET https://reporting.getintent.com/api/v2/reports?token=<token>&dataset_name=<dataset>&start=<start_date>&end=<end_date>
Параметры:
| Параметр | Описание | Обязательно | Значения | По умолчанию | Пример |
|---|---|---|---|---|---|
token | Токен доступа пользователя, влияет на доступность информации из отчетов. | да | Токен пользователя | отсутствует | ../reports?token=tokenstring |
format | Формат отчетности | нет | json - формат отчетности json text - текстовый формат отчетности, представленный таблицой csv - значения, разделенные запятыми, см. параметр csv_separator | текст | ../reports?token=<token>&format=json |
csv_separator | Отдельный символ, который используется в качестве разделителя в случае использования формата CSV. | нет | ; -точка с запятой , - запятая | \t - tab | ../reports?token=<token>&format=json&csv_separator=; |
dataset_name | Наименование набора данных | да | Указанное наименование отчета | отсутствует | ../reports?token=<token>&dataset_name=available_inventory |
start | Дата начала в отчете | да | Дата в формате YYYY-mm-dd | отсутствует | ../reports?token=<token>&start=2015-05-01&end=2015-05-31 |
end | Дата окончания в отчете | да | Дата в формате YYYY-mm-dd | отсутствует | ../reports?token=<token>&start=2015-05-01&end=2015-05-31 |
timezone | Часовой пояс в отчете | нет | Наименование часового пояса | UTC | ../reports?token=<token>&timezone=Europe/Moscow |
keys | Опция «Группировать по» - данные отчета могут быть сгруппированы по нужным ключам. | нет | Группировка ключей (доступные значения можно получить с помощью API meta_data) | отсутствует | ../reports?token=<token>&keys=country,os |
values | Будут выведены только указанные поля значений | нет | Имена полей значений (доступные значения можно получить с помощью API meta_data) | все колонки | ../reports?token=<token>&values=imps,cpm |
filter[] | Фильтровать по ключу | нет | Формат значения фильтра: <op>: <field>: <values> Каждое отдельное значение должно быть указано в новом ключе фильтра <op>- операция сравнения. Доступные опции: eq (равно) / ne (не равно). Обратная совместимость: вы можете использовать is_not для «не равно». field - имя поля values - значения CSV для отфильтрованного ключа. | отсутствует | ../reports?token=<token>&filter[]=eq:country:RU,UA&filter[]=ne:advertiser_id:27 |
having[] | Фильтровать по значению | нет | Формат значения фильтра: <op>: <field>: <values> Каждое отдельное значение должно быть указано в новом ключе фильтра <op>- операция сравнения. Доступные опции: eq (равно) / ne (не равно). Обратная совместимость: вы можете использовать is_not для «не равно». field - имя поля values - значения CSV для отфильтрованного ключа. | отсутствует | ../reports?token=<token>&having[]=ge:clicks:100&having[]=lt:imps:1000000 |
limit | Предел выводных строк | нет | Максимальное число строк | 10000 |
|
relations | Добавляет ноду с информацией о
| нет | двоичное значение (0 или 1) | 0 | ../reports?token=<token>&relations=1 |
| timezone | Учитывает тайм-зону при формировании отчета (по умолчанию UTC 0) | ytn | Europe%2FMoscow Asia%2FNovosibirsk Asia%2FVladivostok Europe%2FBerlin America%2FNew_York | UTC | ../reports?token=<token>&timezone=Europe%2FMoscow |
Meta Data
Возвращает метаданные для построения отчета.
Пример:
{
"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",
...
}
]
}