Перейти к содержанию

Статистика отправок

Информация

  • Для получения статистики по заказам должен быть настроен WebSDK.
  • Статистика по заказам формируется на основании данных, переданных в событии DevinoOrderEvent.

Общая статистика

Для получения общей статистики отправок необходимо вызвать GET /statistics/sales/by-event-time, передавая параметры статистики и данные авторизации в заголовке.

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

Параметр Тип данных Описание
dateTimeFrom datetime Дата начала поиска.
dateTimeTo datetime Дата окончания поиска.
groupBy string

Тип группировки.

Возможные значения:
NONE, YEAR, MONTH, DAY, HOUR, WEEK.
zoneOffset
(optional)		 integer Смещение времени для контакта от UTC+0 в минутах.
cartId
(optional)		 string ID корзины.
contactId
(optional)		 string ID контакта.
contactGroup
(optional)		 string Список, к которому принадлежит контакт.
contactPhone
(optional)		 string Номер телефона контакта.
contactEmail
(optional)		 string Email контакта.
userId
(optional)		 string ID пользователя.
utmSource
(optional)		 string Данные метки utmSource.
webSdkSettingsId
(optional)		 string ID параметров Web SDK.

Пример запроса

curl -X GET "https://api.devino.online/statistics/sales/by-event-time?dateTimeFrom=2021-01-01T00%3A00%3A00Z&dateTimeTo=2021-03-01T00%3A00%3A00Z&groupBy=DAY" \
-H "Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ=="

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

Параметр Тип данных Описание
{date} object Дата, по которой собирается статистика.

{Date}

Параметр Тип данных Описание
totalCount integer Количество заказов.
totalSum number Общая выручка.
averageCheck number Средний чек по заказам.

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

{
  "result": {
    "2021-02-04T00:00": {
      "totalCount": 9,
      "totalSum": 33456.451,
      "averageCheck": 3717.3834444444446
    },
    "2021-02-03T00:00": {
      "totalCount": 1,
      "totalSum": 120.52,
      "averageCheck": 120.52
    }
  }
}

Статистика по рассылкам

Для получения статистики по рассылкам необходимо вызвать GET /statistics/sales/by-task, передавая параметры статистики и данные авторизации в заголовке.

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

Параметр Тип данных Описание
taskIds array[integer] ID рассылок.
dateTimeFrom
(optional)		 datetime Дата начала поиска.
dateTimeTo
(optional)		 datetime Дата окончания поиска.
zoneOffset
(optional)		 integer Смещение времени для контакта от UTC+0 в минутах.
cartId
(optional)		 string ID корзины.
contactId
(optional)		 string ID контакта.
contactGroup
(optional)		 string Список, к которому принадлежит контакт.
contactPhone
(optional)		 string Номер телефона контакта.
contactEmail
(optional)		 string Email контакта.
userId
(optional)		 string ID пользователя.
utmSource
(optional)		 string Данные метки utmSource.
webSdkSettingsId
(optional)		 string ID параметров Web SDK.

Пример запроса

curl -X GET "https://api.devino.online/statistics/sales/by-event-time?dateTimeFrom=2021-02-01%2000:00:00&dateTimeTo=2021-02-05%2000:00:00" \
-H "Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ==" \
-H "Content-Type: application/json"

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

Параметр Тип данных Описание
taskId integer ID рассылки.
totalCount integer Количество заказов.
totalSum number Общая выручка.
averageCheck number Средний чек по заказам.

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

{
  "result": [
    {
      "taskId": 384,
      "totalCount": 10,
      "totalSum": 33576.971,
      "averageCheck": 3357.6971
    },
    {
      "taskId": 385,
      "totalCount": 8,
      "totalSum": 12581.54,
      "averageCheck": 1572.6925
    }
  ]
}