Сводка аналитики
Цифры по снимку, сделанному при отправке. dailyLimit — лимит канала, а не настройка рассылки. Доли — от 0 до 1.
bearerAuthorizationBearer <API key>Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.
campaignId*stringid рассылки из ответа на создание или из списка.
application/json- response
campaignId*stringid рассылки.
status*stringСтатус рассылки.
"draft""sending""pause""completed""failed""scheduled"recipients*numberПолучатели в снимке отправки.
sent*numberПолучатели со статусом sent, delivered или read.
delivered*numberПолучатели со статусом delivered или read.
read*numberПолучатели со статусом read.
failed*numberПолучатели со статусом failed.
skipped*numberПолучатели со статусом skipped.
cancelled*numberПолучатели, убранные из очереди до отправки.
queued*numberПолучатели со статусом queued или leasing.
replied*numberПолучатели, которые ответили хотя бы раз.
textReplies*numberПолучатели, которые хотя бы раз ответили текстом.
clicks*numberОтветы кнопками в снимке.
uniqueClicks*numberПолучатели, которые нажали хотя бы одну кнопку.
rates*Доли получателей, от 0 до 1, с округлением до 4 знаков. Если получателей нет, все доли равны 0.
buttons*array<>Нажатия кнопок по id кнопки.
queuedRemaining*numberПолучатели, которым ещё не отправили.
sentThisPortion*numberОтправки шаблонов, уже начатые в текущем окне лимита.
dailyLimit*|Сколько отправок шаблонов этот канал может начать за скользящие 24 часа, или null, если лимит неизвестен или его нет.
nextPortionAt*|Когда может начаться следующая порция шаблонов, или null, если следующая порция не ждёт.
date-timecurl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics'{ "campaignId": "cm3campaign01", "status": "draft", "recipients": 12, "sent": 10, "delivered": 8, "read": 4, "failed": 1, "skipped": 1, "cancelled": 0, "queued": 0, "replied": 2, "textReplies": 1, "clicks": 3, "uniqueClicks": 2, "rates": { "sent": 0.5, "delivery": 0.4, "read": 0.25, "reply": 0.1, "click": 0.05, "failed": 0 }, "buttons": [ { "id": "shop", "title": "Shop", "clicks": 4, "uniqueClicks": 3 } ], "queuedRemaining": 0, "sentThisPortion": 0, "dailyLimit": 1000, "nextPortionAt": null}