/v2/Api/MessageStatistics/{ID} GET
Возвращает статистику по указанному сообщению. Можно выбрать период времени, за который нужна статистика. Статистика содержит количество отправок, доставок, ошибок, кликов, отписок и так далее.
Формат данных
Параметры запроса:
| Параметры | Тип | Описание |
|---|---|---|
| apiKey | string | Ваш API-key, необходимый для авторизации. Обязательный. |
| ID | int | ID сообщения. Обязательный. Является частью адреса, а не параметром. Смотрите примеры. |
| startDate | date | Необязательный. Если не указан, то будет использована дата создания сообщения. Формат — YYYY-MM-DD. |
| endDate | date | Необязательный. Если не указан, то будет использована текущая дата. Формат — YYYY-MM-DD. |
Примеры:
https://api.esv2.com/v2/Api/MessageStatistics/123?apiKey=Ваш_API-ключ https://api.esv2.com/v2/Api/MessageStatistics/123?apiKey=Ваш_API-ключ&startDate=2010-05-20&endDate=2010-05-22
Ответ
Элементы тега Data в ответе:
| Элемент/Атрибут | Тип | Описание |
|---|---|---|
| Sent | int | Количество отправленных сообщений. |
| Bounced | int | Количество Bounced-сообщений. |
| Delivered | int | Количество доставленных сообщений (Sent - Bounced). |
| Opens | int | Количество открытых сообщений. |
| UniqueOpens | int | Количество открытий сообщений уникальными подписчиками. |
| Clicks | int | Количество кликов по ссылкам. |
| UniqueClicks | int | Количество кликов по ссылкам уникальными подписчиками. |
| Clickers | int | Количество уникальных подписчиков, которые кликнули по любой из ссылок. |
| Complaints | int | Количество жалоб на спам. |
| Unsubscribes | int | Количество кликнувших по ссылке отписки. |
Пример
Запрос:
GET https://api.esv2.com/v2/Api/MessageStatistics/764?apiKey=Ваш_API-ключ HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: api.esv2.com
Ответ:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=conq5cmaq3mmpy455bkihvyd; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 24 May 2010 13:03:04 GMT
Content-Length: 351
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Data>
<Sent>9</Sent>
<Bounced>0</Bounced>
<Delivered>9</Delivered>
<Opens>19</Opens>
<UniqueOpens>1</UniqueOpens>
<Clicks>12</Clicks>
<UniqueClicks>3</UniqueClicks>
<Clickers>3</Clickers>
<Complaints>0</Complaints>
<Unsubscribes>0</Unsubscribes>
</Data>
</ApiResponse>