Получить аналитику шаблонов
Аналитика доступна с дневной гранулярностью. По умолчанию данные в UTC, либо в таймзоне WABA при use_waba_timezone=true.
Ограничения:
- Метрики кликов доступны только для шаблонов MARKETING или UTILITY.
- Максимум 10 template_ids за запрос.
Если аналитика шаблонов отключена для канала, API вернет ошибку: Template analytics is disabled for this channel.
JWT tokentoken<token>start*stringНачало диапазона. Unix timestamp или YYYY-MM-DD. Если use_waba_timezone=true, используйте YYYY-MM-DD.
end*stringКонец диапазона. Unix timestamp или YYYY-MM-DD. Если use_waba_timezone=true, используйте YYYY-MM-DD.
granularity*"DAILY"Гранулярность. Поддерживается только DAILY.
"DAILY"template_ids*array<string>Массив template ID для аналитики. Максимум 10.
metric_types?array<>Типы метрик. Если не указано, возвращаются все метрики.
product_type?stringФильтр по типу продукта. Если не указано, возвращаются только метрики Cloud API.
"CLOUD_API""MARKETING_MESSAGES_LITE_API"use_waba_timezone?booleanПоказывать метрики в таймзоне WABA. При true start/end должны быть YYYY-MM-DD.
Пример ответа сервера
application/json- response
data?array<>paging?curl -X GET 'https://api.1msg.io/123/templateAnalytics?start=2024-01-01&end=2024-01-07&granularity=DAILY&template_ids=1156697826259690&template_ids=1309207764213383&metric_types=SENT&metric_types=DELIVERED&metric_types=READ&product_type=CLOUD_API&use_waba_timezone=true'{ "data": [ { "granularity": "DAILY", "product_type": "CLOUD_API", "waba_timezone": "America/Los_Angeles", "data_points": [ { "template_id": "1156697826259690", "start": 1759708800, "end": 1759795200, "sent": 3, "delivered": 3, "read": 3, "replied": 0, "clicked": [ { "type": "url_button", "button_content": "Buy Now", "count": 3 } ], "cost": [ { "type": "amount_spent", "value": 0.26 } ] } ] } ], "paging": { "cursors": { "before": "MAZDZD", "after": "MjQZD" } }}