Получить сводную аналитику рассылки

GET /analytics/campaigns/{campaignId}/summary

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

Передавайте 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

Сводка рассылки успешно получена.

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

Пример: 125

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

Пример: 73

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

Пример: 18

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

Пример: 4

interested number обязательное

Пример: 7

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

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

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

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

Пример: true

Запрос

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

{
  "contacted": 125,
  "opened": 73,
  "replied": 18,
  "bounced": 4,
  "interested": 7,
  "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"
}