Пример: общий отчет
Пример демонстрирует получение общего отчета.
1. Допустимый период отчета
Запрос
curl -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037' https://adfox.yandex.ru/api/report/date/interval/owner?name=days
Ответ
{
"result": {
"dateFrom": "2011-01-01",
"dateTo": "2021-08-20"
},
"error": null
}
2. Формирование отчета
Запрос
curl -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037' https://adfox.yandex.ru/api/report/owner?name=days&dateFrom=2021-08-19&dateTo=2021-08-19
Запрос для нескольких кампаний
curl -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037' https://adfox.yandex.ru/api/report/campaign?name=days&dateFrom=2022-04-28&dateTo=2022-04-29&campaignId=[1891306,1891313,1891312,1860311]
Ответ
{
"result": {
"taskId": "819f97bf-3b73-4617-905f-51789199de1d"
},
"error": null
}
3. Получение готового отчета
Запрос
curl -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037' https://adfox.yandex.ru/api/report/result?taskId=819f97bf-3b73-4617-905f-51789199de1d
Отчет
{
"result": {
"taskId": "819f97bf-3b73-4617-905f-51789199de1d",
"state": "SUCCESS",
"fields": [
"correct",
"ownerId",
"date",
"loadsCommercial",
"impressionsCommercial",
"loadsDefault",
"clicksCommercial",
"clicksDefault",
"ctrCommercial",
"loadsTotal"
],
"fieldsInfo": {
"correct": {
"deprecated": "",
"groupby": "",
"orderby": "",
"purpose": "System",
"totals": "",
"type": "UInt8",
"title": "Полнота данных"
},
"ownerId": {
"deprecated": "",
"groupby": "1",
"orderby": "1",
"purpose": "Id",
"totals": "",
"type": "UInt32",
"title": "Id владельца"
},
"date": {
"deprecated": "",
"groupby": "1",
"orderby": "1",
"purpose": "Key",
"totals": "",
"type": "Date",
"title": "Дата"
},
"loadsCommercial": {
"deprecated": "",
"groupby": "",
"orderby": "1",
"purpose": "Value",
"totals": "1",
"type": "UInt64",
"title": "Загрузки баннеров"
},
"impressionsCommercial": {
"deprecated": "",
"groupby": "",
"orderby": "1",
"purpose": "Value",
"totals": "1",
"type": "UInt64",
"title": "Показы"
},
"loadsDefault": {
"deprecated": "",
"groupby": "",
"orderby": "1",
"purpose": "Value",
"totals": "1",
"type": "UInt64",
"title": "Загрузки по умолчанию"
},
"clicksCommercial": {
"deprecated": "",
"groupby": "",
"orderby": "1",
"purpose": "Value",
"totals": "1",
"type": "UInt64",
"title": "Переходы"
},
"clicksDefault": {
"deprecated": "",
"groupby": "",
"orderby": "1",
"purpose": "Value",
"totals": "1",
"type": "UInt64",
"title": "Переходы по умолчанию"
},
"ctrCommercial": {
"deprecated": "",
"groupby": "",
"orderby": "1",
"purpose": "Value",
"totals": "",
"type": "Percent",
"title": "CTR"
},
"loadsTotal": {
"deprecated": "",
"groupby": "",
"orderby": "1",
"purpose": "Value",
"totals": "1",
"type": "UInt64",
"title": "Запросы кода"
}
},
"table": [
[
1,
123456,
"2021-08-19",
123456,
123456,
12,
123,
12,
0.1,
123468
]
],
"totals": {
"loadsCommercial": 123456,
"impressionsCommercial": 123456,
"loadsDefault": 12,
"clicksCommercial": 123,
"clicksDefault": 12,
"loadsTotal": 123468
},
"eventHorizon": "2021-08-20 18:16:11"
},
"error": null
}