Request body:
{
"GroupBy":["<поле группировки1>, <поле группировки2>", ...], // обязательно
"StartDate":"<начало периода (yyyy-MM-dd)>", // обязательно
"EndDate":"<конец периода (yyyy-MM-dd)>", // обязательно
"OrderBy":[
{"field": "<поле сортировки>", "order":"<направление сортировки (asc/desc)>"},
...
],
"Filter": [ //фильтры
{
"Field":"<поле фильтрации>",
"Values":["<значение1>", "<значение2>", ...], // между значениями одного поля используется логическое ИЛИ
"Op":"<операция (=, <>, >, <, >=, <=, like)>"
}, // между фильтрами по разным полям используется логическое И
...
],
"DataFields":["<поле1>", "<поле2>", ...], // обязательно. Список запрашиваемых полей.
"Timezone":180, // Опционально. Таймзона, в которой требуется получить данные (в минутах относительно UTC. 180 - UTC+3). Работает только в специальных платформах.
"PlaformName":"<имя_платформы>" // Опционально. Заполняется, если пользователю доступны несколько платформ.
}
Response (Success):
{
"Total":{
"DataCount": [
{
"Field":"<имя поля>",
"Value":"<значение поля>"
},
...
],
"RecCount":<общее количество различных значений поля, указанного в GroupBy>
},
"Data": [
{
"DataFields": [
{"Field":"<имя поля>", "Value":"<значение поля>" },
...
],
"GroupingFields": [
{"Field":"<поле группировки1>","Value":"<значение>"},
{"Field":"<поле группировки2>","Value":"<значение>"},
…
]
},
...
]
}
Response (в случае незаполнения обязательных полей или использования несуществующих полей данных):
{
"Type": "exception",
"Message": "<сообщение, поясняющее, в чём ошибка>"
}
Response (в случае неверного token'а):
{
"Type": "access",
"Message": "Token invalid"
}
Пример запроса:
{
"GroupBy": ["placement_id"],
"StartDate": "2014-01-01",
"EndDate": "2014-01-07",
"DataFields": ["bids", "imps", "clicks", "adv_payout", "pub_payout"],
"Filter": [{
"Field": "publisher_id", "Values": [41], "Match": "equals"
}]
}
Пример ответа:
{
"Total": {
"DataCount": [
{"Field": "bids", "Value": "12345678"},
{"Field": "imps", "Value": "1365872" },
{"Field": "clicks", "Value": "21621"},
{"Field": "adv_payout", "Value": "30733.028700000148"},
{"Field": "pub_payout", "Value": "0.0"}
],
"RecCount": 1
},
"Data": [
{
"DataFields":
[
{"Field": "bids", "Value": "12345678"},
{"Field": "imps", "Value": "1365872" },
{"Field": "clicks", "Value": "21621"},
{"Field": "adv_payout", "Value": "30733.028700000148"},
{"Field": "pub_payout", "Value": "0.0"}
],
"GroupingFields":
[
{"Field":"placement_id","Value":"1519"}
]
}
]
}