Получите аналитику рассылки по шагам

GET /analytics/campaigns/{campaignId}/by-sequence

Аутентификация

Передавайте API-ключ организации как Bearer-токен.

Authorization: Bearer YOUR_API_KEY

Параметры пути

campaignId string обязательное

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

period string

Допустимые значения: 7d, 1m, 3m, 6m, 1y, all

start_date string

end_date string

type string

Допустимые значения: event, cohort

Пример: event

event_types string[]

Ответ

application/json

Аналитика по шагам цепочки писем успешно получена.

items object[] обязательное

Показать вложенные поля Скрыть вложенные поля

items.sequence_id number обязательное

Пример: 101

items.step number обязательное

Пример: 1

items.contacted number обязательное

Пример: 50

items.opened number обязательное

Пример: 30

items.replied number обязательное

Пример: 8

items.bounced number обязательное

Пример: 2

items.sent number обязательное

Пример: 61

meta object обязательное

Показать вложенные поля Скрыть вложенные поля

meta.open_tracking_enabled boolean обязательное

Доступны ли открытые метрики для этой рассылки и домена отслеживания.

Пример: true

Запрос

curl --request GET \
  --url https://developer.coldy.ai/api/v1/analytics/campaigns/{campaignId}/by-sequence \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

{
  "items": [
    {
      "sequence_id": 101,
      "step": 1,
      "contacted": 50,
      "opened": 30,
      "replied": 8,
      "bounced": 2,
      "sent": 61
    }
  ],
  "meta": {
    "open_tracking_enabled": true
  }
}

{
  "message": [
    "You put invalid API key. Verify your key with the key from your account in Coldy. Check documenation for info"
  ],
  "statusCode": 400,
  "error": "Invalid API key"
}