Skip to main content

Адрес сервиса статистики: https://adm.spotsnetwork.com/api/dsp/

Спецификация

Обращение к сервису выполняется по протоколу JSON-RPC 2.0. Подробнее о спецификации протокола можете прочитать в официальных источниках. Доступ к защищенным ресурсам осуществляется с помощью передачи JWT токена.

Авторизация и Токен доступа

Токен доступа нужен, чтобы иметь возможность выполнять доступные пользователю методы API. Создание токенов доступно администратору системы в разделе DSP.

Запрос к API должен содержать HTTP-заголовок Authorization с OAuth-токеном пользователя, от имени которого выполняется запрос:

-H 'Authorization: Bearer TOKEN'
  • Authorization - название HTTP-заголовка.
  • Bearer - служебная константа протокола OAuth (обязательна к указанию).
  • TOKEN - полученный пользователем токен.

Получение статистики

Для получения статистики необходимо вызвать метод "statistics.getList".

Параметры запроса

НазваниеОписаниеТип
filterФильтрobject

Параметры объекта filter

В таблице ниже описаны все возможные фильтры. В зависимости прав пользователя могут быть не доступны некоторые фильтры.

НазваиниеОписаниеТип
date_fromДата начала периода. Строка в формате “YYYY-MM-DD”. По умолчанию начало текущего месяцаstring
date_toДата окончания периода. Строка в формате “YYYY-MM-DD”. По умолчанию текущая датаstring

Обратите внимание: Период должен быть не более 90 дней.

Параметры ответа

В ответе будет возвращен массив объектов, содержащих следующие поля:

  • "date" - дата из выбранного временного периода,
  • "shows" - показы за эту дату,
  • "amount" - расход за эту дату.

Пример использования метода

//Пример запроса с токеном доступа (токен передается в заголовке)
// где TOKEN - access токен, полученный после авторизации
curl -H 'Authorization: Bearer TOKEN' -X POST -d '
{
"jsonrpc": "2.0",
"method":"statistics.getList",
"params": {
"filter": {
"dateFrom": "2024-10-04",
"dateTo": "2024-10-08"
}
},
"id": 1
}' http://localhost/api/

// Ответ
{
"jsonrpc": "2.0",
"result": {
"rows": [
{
"date": "2024-10-08",
"shows": 3002407,
"amount": 135108.315
},
{
"date": "2024-10-07",
"shows": 2645861,
"amount": 119063.745
},
{
"date": "2024-10-06",
"shows": 2019774,
"amount": 90889.83
},
{
"date": "2024-10-05",
"shows": 2051029,
"amount": 92296.305
},
{
"date": "2024-10-04",
"shows": 2777738,
"amount": 124998.21
}
],
"total": {
"shows": 12496809,
"amount": 562356.405
}
},
"id": 1
}