Skip to Content
1MSG
ReferenceCampaigns API

Сводка аналитики

GET
/api/v1/campaigns/{campaignId}/analytics

Цифры по снимку, сделанному при отправке. dailyLimit — лимит канала, а не настройка рассылки. Доли — от 0 до 1.

Authorization

bearer
headerAuthorizationBearer <API key>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Path Parameters

campaignId*string

id рассылки из ответа на создание или из списка.

Response Body

application/json
  1. response
campaignId*string

id рассылки.

status*string

Статус рассылки.

Value in"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, если следующая порция не ждёт.

Formatdate-time
Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics'
Example Response200
{  "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}