Дані вивантаження зберігаються на сервері один місяць від дати створення запиту. Один клієнт може мати на сервері не більше 5 запитаних вивантажень. Щоб зробити шосте, попереднє потрібно видалити окремим методом. У запиті на формування вивантаження рядок зі значенням null дорівнює невказаному параметру, і навпаки.
Запит на вивантаження статистики
Детальна статистика повідомлень
Дані вивантаження зберігаються на сервері один місяць від дати створення запиту. Один клієнт може мати на сервері не більше 5 запитаних вивантажень. Щоб зробити шосте, попереднє потрібно видалити окремим методом. У запиті на формування вивантаження рядок зі значенням null дорівнює невказаному параметру, і навпаки.
Щоб вивантажити статистику, надішліть запит на цей URL:
POST https://api.bsg.world/rest/stat/create
Тіло запиту
Передається один з таких обовʼязкових параметрів:
- message_id — вкажіть “message_id”. Якщо це значення задано, всі наступні поля ігноруються, навіть якщо там вказано дані. Масив. Максимум 300 значень у масиві. Якщо вказано порожній масив або параметр є, але ключ не є масивом, параметр ігнорується.
АБО проміжок часу:
- time_in_from — дата й час, коли повідомлення надійшли на платформу.
- time_in_to — дата й час, коли повідомлення надійшли на платформу.
Передаються необовʼязкові параметри
| Параметр | Тип | Опис |
|---|---|---|
| msisdn | Масив значень для вказання номерів. Якщо вказано порожній масив або параметр є, але ключ не є масивом, параметр ігнорується. | |
| originator | string | Імʼя відправника. |
| source_type | string | Джерело, з якого повідомлення надійшло на платформу. Може набувати одного з таких значень: api, web, smpp, xml, http, json. |
| message_type | string | Тип повідомлення. Може набувати одного з таких значень: sms, hlr, viber. |
| time_sent_from | Час надсилання повідомлень із платформи — “from”. | |
| time_sent_to | Час надсилання повідомлень із платформи — “to”. | |
| country_name | string | Назва країни для пошуку. |
| operator_id | Зазначення оператора країни, якщо присутнє поле Country_name. Якщо оператора вказано без країни, він ігнорується. | |
| status | string | Статус повідомлень для відображення. Може набувати одного з таких значень: Delivered, Rejected, Scheduled, Moderation, Accepted, Sending, Sent, Expired, Failed, Undelivered, Unknown, Read, not-viber-user. |
| sl_clicks | Чи потрібно враховувати кількість кліків. Поле доступне лише клієнтам з увімкненим сервісом Short URL. | |
| sl_clicks_comp | Оператор порівняння зі значенням кількості кліків. Може набувати одного з таких значень: “<”, “>”, “=”. Поле доступне лише клієнтам з увімкненим сервісом Short URL. | |
| sl_clicks_count | Значення для порівняння. Верхня межа — 999999. Поле доступне лише клієнтам з увімкненим сервісом Short URL. |
якщо запит успішний, ви отримаєте відповідь:
{
"error":0,
"key": {}
}