/v2/Api/SubscriberStatistics GET
Метод SubscriberStatistics позволяет получить информацию о состоянии листов подписчиков - например: размер текущего листа, количество отписавшихся или подписавшихся за определенный период времени и т.д.
Формат запроса
Параметры URL запроса
| Параметры | Тип | Описание |
|---|---|---|
| apiKey | string | Ваш API-key, необходимый для авторизации. Обязательный. |
| startDate | date | Начальная дата. Необязательный. Если не указан, будет взята дата создания. Формат — YYYY-MM-DD |
| endDate | date | Конечная дата. Необязательный. Если не указан, будет использована текущая дата.Формат — YYYY-MM-DD |
| scope | string | Пределы фильтрации. Необязательный. Если не задан, то фильтрация не будет применяться (будут предоставлены данные по всему Субаккаунту). Доступные границы определены аналогично методу (SummaryStatistics) Получить сводную статистику |
| scopeValue | string | Значение границ фильтрации. Необходим если определен параметр scope. Параметр смешанного типа, тип зависит от выбранных границ |
| scope2 | string | Вторые границы фильтрации. Работает аналогично "scope" |
| scope2Value | string | Значение границ фильтрации для scope2 |
| grouping | string | Группировка результатов. Необязательный. Если не задан, результаты будут сгруппированы по Субаккаунту (одна строка с суммой значений). Доступны способы группировки аналогично методу (SummaryStatistics) Получить сводную статистику |
Примеры:
https://api.esv2.com/v2/Api/SubscriberStatistics?apiKey=Ваш_API-ключ https://api.esv2.com/v2/Api/SubscriberStatistics?apiKey=Ваш_API-ключ&scope=List&scopeValue=1&grouping=Vendor
Ответ
Элементы тега Data:
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| SubscriberStatistics | array[complex] | Массив элементов SubscriberStatistics. |
Элементы тега SubscriberStatistics:
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| IsSummaryRow | boolean | true отмечает строку сводной статистики (значение сумм других строк).* |
| Date | date | Дата. Возвращается только если в запросе есть группировка по датам |
| Month | string | Месяц, представляется как период дат. Возвращается только если в запросе есть группировка по месяцам. Пример: Month |
| MessageId | int | ID сообщения.Возвращается только если в запросе есть группировка по ID сообщения. |
| MessageSubject | string | Тема сообщения.ID сообщения.Возвращается только если в запросе есть группировка по теме сообщения |
| ListId | int | ID листа подписчиков. Возвращается только если в запросе есть группировка по ID листа подписчиков. |
| ListName | string | Название листа подписчиков. Возвращается только если в запросе есть группировка по названию листа подписчиков. |
| SegmentId | int | Id сегмента. Возвращается только если в запросе есть группировка по Id сегмента. |
| SegmentName | string | Название сегмента. Возвращается только если в запросе есть группировка по названию сегмента. Если строка содержит данные о несегментированных подписчиках, будет возвращено тире ("-") в качестве значения |
| IP | string | IP адрес канала. Возвращается только если в запросе есть группировка по IP |
| Domain | string | Домен. Возвращается только если в запросе есть группировка по домену |
| DomainFamily | string | Домен. Возвращается только если в запросе есть группировка по доменному семейству |
| Vendors | string | Источник траффика. Возвращается только если в запросе есть группировка по источнику траффика |
| GoalId | int | ID цели. Возвращается только если в запросе есть группировка по ID цели |
| GoalName | string | Имя цели. Возвращается только если в запросе есть группировка по имени цели |
| SendTimeOptimization | string | Оптимизация по времени отправки. Возвращается только если в запросе есть группировка по времени отправки. Может принимать значения OptimizationNotUsed", "TimeOptimized", "TimeNotOptimized" или тире "-" если не применяется. |
| TimeTravelOptimization | string | Оптимизация по часовому поясу. Возвращается только если в запросе есть группировка по часовому поясу. Может принимать значения OptimizationNotUsed", "TimeOptimized", "TimeNotOptimized" или тире "-" если не применяется. |
| ReadingEnvironments | string | Среда открытия. Возвращается только если в запросе есть группировка по среде открытия. Может принимать значения "Other", "Desktop", "Mobile", "Webmail", "NoActivity" или тире "-" если не применяется. |
| ListSize | int | Размер выбранного листа |
| Growth | int | Прирост/убыль листа. |
| Added | int | Общее количество добавленных в лист подписчиков. |
| AddedUi | int | Количество добавленных в лист подписчиков через веб интерфейс вручную. |
| AddedImport | int | Количество добавленных в лист подписчиков через автоматический импорт. |
| AddedApi | int | Количество добавленных в лист подписчиков через API. |
| AddedWeb | int | Количество добавленных в лист подписчиков через веб формы. |
| Removed | int | Общее количество удаленных из листа подписчиков. |
| RemovedOptOut | int | Количество удаленных из листа подписчиков по причине отписки. |
| RemovedUser | int | Количество удаленных в ручную из листа подписчиков через веб интерфейс. |
| RemovedBounceLimit | int | Количество удаленных из листа подписчиков по причине превышения числа ошибок доставки. |
| RemovedSpam | int | Количество удаленных из листа подписчиков по причине жалоб. |
| RemovedUserUnknown | int | Количество удаленных из листа подписчиков по причине ошибки доставки Несуществующий адрес - "User Unknown". |
| RemovedBlacklist | int | Количество удаленных из листа подписчиков по причине добавления в черный список. |
| RemovedApi | int | Количество удаленных из листа подписчиков через API. |
*Строки сводной статистики не содержат группирующих столбцов (Date, Month и т.п.)
Пример
Запрос (без группировки):
GET https://api.esv2.com/v2/Api/SubscriberStatistics?apiKey=Ваш_API-ключ&scope=List&scopeValue=1&scope2=DomainFamily&scopeValue2=Gmail HTTP/1.1 Accept-Encoding: gzip,deflate Host: api.esv2.com Connection: Keep-Alive User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
ОК ответ:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=b8567a11-cbb2-4525-b355-782b8b3ea005; path=/
X-Powered-By: ASP.NET
Date: Wed, 29 Jul 2015 14:44:34 GMT
Content-Length: 870
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Data>
<SubscriberStatistics>
<SubscriberStatistic>
<IsSummaryRow>true</IsSummaryRow>
<ListSize>469</ListSize>
<Growth>469</Growth>
<Added>470</Added>
<AddedUi>0</AddedUi>
<AddedImport>437</AddedImport>
<AddedApi>0</AddedApi>
<AddedWeb>0</AddedWeb>
<Removed>1</Removed>
<RemovedOptOut>1</RemovedOptOut>
<RemovedUser>0</RemovedUser>
<RemovedBounceLimit>0</RemovedBounceLimit>
<RemovedSpam>0</RemovedSpam>
<RemovedUserUnknown>0</RemovedUserUnknown>
<RemovedBlacklist>0</RemovedBlacklist>
<RemovedApi>0</RemovedApi>
</SubscriberStatistic>
</SubscriberStatistics>
</Data>
</ApiResponse>