/v2/Api/SummaryStatistics/ GET

Позволяет получить сводную статистику работы ваших сообщений. Статистика может быть сгруппирована и отфильтрована по различным параметрам, точно так же, как и при использовании инструмента Отчеты > Сводные в web-панели ExpertSender.

Формат запроса

Request URL parameters:

Параметр Тип Описание
apiKey string Ваш API-key, необходимый для авторизации. Обязательный.
startDate date Необязательный. Если не указан, то будет использована дата создания Субаккаунта. Формат — YYYY-MM-DD.
endDate date Необязательный. Если не указан, то будет использована текущая дата. Формат — YYYY-MM-DD.
scope string Область фильтрации. Необязательное. Если не указан, то фильтрация не будет осуществлена (будут возвращены данные по всей учетной записи).
Возможные цели:
  • List - Результаты только для конкретного листа подписчиков
  • Domain - Результаты только по определенному домену
  • DomainFamily - Результаты только по определенной группе доменов*
  • MessageType - Результаты только по определенному типу сообщений
  • Ip - Результаты только для определенного канала IP
  • Segment - Результат только для определенного сегмента подписчиков
  • Vendor - Результат только по определенному партнеру
  • Goal - only results for specific business goal
  • SendTimeOptimization - Оптимизация по времени отправки. Результаты только для сообщений с Оптимизацией по времени отправки***
  • TimeTravelOptimization. Оптимизация по часовым поясам. Результаты только для сообщений с Оптимизацией по часовым поясам****
  • ReadingEnvironment - Среда открытия. Результаты только для сообщений с открытиями/кликами в определенной среде*****
scopeValue mixed Значение области фильтрации. Необходим если область фильтрации установлена. Здесь используются смешанные типы, которые используются в зависимости от выбранной цели:
  • List - ID листа, int, например 123
  • Domain - доменное имя, string, например domain.com
  • DomainFamily - группа доменов, string, например Gmail*
  • MessageType - тип сообщения, string, например Newsletter**
  • Ip - IP адрес канала отправки, string, например 11.22.33.44
  • Segment - Segment ID, int, e.g. 123
  • Vendor - имя источника траффика, string, например foobar
  • Goal - ID цели, int, например 123
  • SendTimeOptimization - Оптимизация по времени отправки. Результаты только для сообщений с Оптимизацией по времени отправки***
  • TimeTravelOptimization. Оптимизация по часовым поясам. Результаты только для сообщений с Оптимизацией по часовым поясам****
  • ReadingEnvironment - Среда открытия. Результаты только для сообщений с открытиями/кликами в определенной среде*****
grouping string Группировка результата. Необязательный. Если не задан, то результат будет сгруппирован по всей учетной записи (Одна строка данных будет возвращена со всеми суммированными данными).
Допустимые группировки:
  • Date
  • Month
  • Message
  • MessageType
  • List
  • Segment
  • Ip
  • Domain
  • DomainFamily
  • Vendor
  • Goal
  • Tag
  • SendTimeOptimization - Оптимизация по времени отправки. Результаты только для сообщений с Оптимизацией по времени отправки***
  • TimeTravelOptimization - Оптимизация по часовым поясам. Результаты только для сообщений с Оптимизацией по часовым поясам****
  • ReadingEnvironment - Среда открытия. Результаты только для сообщений с открытиями/кликами в определенной среде*****
ВАЖНО: Не возможно группировать и фильтровать по одному и тому же параметру. Значение параметра scope должно быть отлично от значения параметра grouping.

*Группы доменов специфичны для каждой учетной записи, и могут быть изменены. Типичные группы доменов которые обычно используются (но не обязательно в вашей учетной записи) - это Yahoo, Outlook.com, Gmail, AOL, Other.

**Допустимые типы сообщений: Newsletter, Autoresponder, Trigger, Transactional, Confirmation, Recurring, Test.

***Допустимые значения SendTimeOptimization: OptimizationNotUsed, TimeOptimized, TimeNotOptimized.

****Допустимые значения TimeTravelOptimization: OptimizationNotUsed, TimeOptimized, TimeNotOptimized.

*****Допустимые значения ReadingEnvironment: Other, Desktop, Mobile, Webmail, NoActivity.

Примеры:

https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=Ваш_API-ключ
https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=Ваш_API-ключ&startDate=2013-12-10&endDate=2013-12-31
https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=Ваш_API-ключ&scope=List&scopeValue=123
https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=Ваш_API-ключ&scope=MessageType&scopeValue=Autoresponder&grouping=Date

Ответ

Элемент/атрибут Тип Описание
SummaryStatistics array[complex] Массив элементов SummaryStatistic.

Элементы тега SummaryStatistics

Элемент/атрибутТипОписание
IsSummaryRow boolean Если true, задает результирующую строку в таблице статистики (значения этой строки будут суммы значений всех строк).*
Date date Дата. Будет возвращена только если была заданна группировка по дате
Month string Месяц - это период дат. Будет только возвращен если была заданна группировка по дате.
Пример: 2010-01-01 : 2010-01-31
MessageId int ID письма. Будет возвращен только если была заданна группировка по сообщениям.
MessageSubject string Тема письма. Будет возвращен только если была заданна группировка по сообщениям.
ListId int ID листа подписчиков. Будет возвращен если была заданна группировка по листам подписчиков.
ListName string Название листа подписчиков. Будет возвращен только если была заданна группировка по листам подписчиков.
SegmentId int ID сегмента подписчиков. Будет возвращен только если была задана группировка по подписчикам.
SegmentName string Название сегмента подписчиков. Будет возвращен только если была задана группировка по подписчикам. Если строка содержит данные о несегментированных подписчиках, будет возвращен ("-") в качестве значения.
Ip string IP адрес канала отправки. Будет возвращен только если была задана группировка по IP адресам.
Domain string Домен. Будет возвращен только если была задана группировка по доменам
DomainFamily string Группа доменов. Будет возвращен только если была задана группировка по группам доменов
Vendor string Партнер. Будет возвращен только если была задана группировка по партнерам. Если строка содержит данные о подписчиках без партнера, то будет возвращен ("-")
GoalId int ID цели. Будет возвращен только если была задана группировка по целям
GoalName string Название цели. Будет возвращен только если была задана группировка по целям
SendTimeOptimizationstringОптимизация по времени отправки. Возвращается только если в запросе была задана группировка по времени отправки. Принимает значение: "OptimizationNotUsed", "TimeOptimized", "TimeNotOptimized" или тире "-" если не применяется.
TimeTravelOptimizationstringОптимизация по часовому поясу. Возвращается только если в запросе была задана группировка по часовому поясу. Принимает значение: "OptimizationNotUsed", "TimeOptimized", "TimeNotOptimized" или тире "-" если не используется.
ReadingEnvironmentstringСреда открытия. Возвращается если только в запросе была задана группировка по среде открытия. Принимает значение: "Other", "Desktop", "Mobile", "Webmail", "NoActivity" или тире "-" если не используется.
Sent int Количество отправленных писем
Bounced int Количество писем с ошибками доставки
Delivered int Количество доставленных (sent - bounced) писем
Opens int Количество открытых писем
UniqueOpens int Количество писем открытых уникальными пользователями
Clicks int Количество кликов по ссылкам
UniqueClicks int Количество уникальных кликов
Clickers int Количество кликнувших уникальных подписчиков
Complaints int Количество жалоб на спам.
Unsubscribes int Количество кликов по ссылке “unsubscribe/отписаться”.
Goals int Количество достигнутых целей.
GoalsValue int Значения достигнутых целей.

*Результирующие строки не содержат столбцов группировки (например Data, Month).

Примеры

Статистика сгруппированная по домену за определенный период:

GET https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=Ваш_API-ключ&startDate=2010-01-01&endDate=2012-01-01&grouping=Domain 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
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.0
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=209ffb47-7020-4508-99dc-8f7083928452; path=/
X-Powered-By: ASP.NET
Date: Wed, 11 Dec 2013 14:51:50 GMT
Content-Length: 97229

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <SummaryStatistics>
      <SummaryStatistic>
        <IsSummaryRow>true</IsSummaryRow>
        <Sent>3656424</Sent>
        <Bounced>478621</Bounced>
        <Delivered>3177803</Delivered>
        <Opens>356783</Opens>
        <UniqueOpens>243556</UniqueOpens>
        <Clicks>145664</Clicks>
        <UniqueClicks>113442</UniqueClicks>
        <Clickers>98761</Clickers>
        <Complaints>3452</Complaints>
        <Unsubscribes>34211</Unsubscribes>
        <Goals>12344</Goals>
        <GoalsValue>123440</GoalsValue>
      </SummaryStatistic>
      <SummaryStatistic>
        <Domain>yahoo.com</Domain>
        <Sent>1262372</Sent>
        <Bounced>144511</Bounced>
        <Delivered>1117861</Delivered>
        <Opens>345112</Opens>
        <UniqueOpens>245218</UniqueOpens>
        <Clicks>83445</Clicks>
        <UniqueClicks>63443</UniqueClicks>
        <Clickers>34552</Clickers>
        <Complaints>2231</Complaints>
        <Unsubscribes>56775</Unsubscribes>
        <Goals>3345</Goals>
        <GoalsValue>33450</GoalsValue>
      </SummaryStatistic>
      ...
    </SummaryStatistics>
  </Data>
</ApiResponse>

Статистика отфильтрованная по типу сообщения и сгруппированная по IP

Запрос:

GET https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=Ваш_API-ключ&scope=MessageType&scopeValue=Newsletter&grouping=Ip 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
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.0
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=90015733-b2c3-4a23-93ac-b9bce60ab8af; path=/
X-Powered-By: ASP.NET
Date: Wed, 11 Dec 2013 15:04:03 GMT
Content-Length: 5655

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <SummaryStatistics>
      <SummaryStatistic>
        <IsSummaryRow>true</IsSummaryRow>
        <Sent>21256701</Sent>
        <Bounced>6136556</Bounced>
        <Delivered>15120145</Delivered>
        <Opens>198540</Opens>
        <UniqueOpens>163857</UniqueOpens>
        <Clicks>17264</Clicks>
        <UniqueClicks>15689</UniqueClicks>
        <Clickers>12326</Clickers>
        <Complaints>2106</Complaints>
        <Unsubscribes>3351</Unsubscribes>
        <Goals>0</Goals>
        <GoalsValue>0</GoalsValue>
      </SummaryStatistic>
      <SummaryStatistic>
        <Ip>11.22.33.44</Ip>
        <Sent>5051025</Sent>
        <Bounced>1814659</Bounced>
        <Delivered>3236366</Delivered>
        <Opens>45737</Opens>
        <UniqueOpens>37578</UniqueOpens>
        <Clicks>4194</Clicks>
        <UniqueClicks>3640</UniqueClicks>
        <Clickers>2887</Clickers>
        <Complaints>465</Complaints>
        <Unsubscribes>799</Unsubscribes>
        <Goals>0</Goals>
        <GoalsValue>0</GoalsValue>
      </SummaryStatistic>
      ...
    </SummaryStatistics>
  </Data>
</ApiResponse>