/v2/Api/SummaryStatistics/ GET

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

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

Request URL parameters:

*Группы доменов специфичны для каждой учетной записи, и могут быть изменены. Типичные группы доменов которые обычно используются (но не обязательно в вашей учетной записи) - это 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

*Результирующие строки не содержат столбцов группировки (например 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>