Embedded Files
API Documentation V2
SmsMmsSummaryStatistics collection allows retrieving summary performance statistics of your messages. Statistics may be filtered and grouped by various parameters, exactly the same as using Reports->SMS/MMS Summary page in ExpertSender Web Panel.
Request data format
Request data format
Request URL parameters:
Examples:
https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE
https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2022-12-01&endDate=2022-12-31
https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=List&scopeValue=123
https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=SmsMmsMessageType&scopeValue=Newsletter&grouping=Date
https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2022-12-01&endDate=2022-12-31&scope=SmsMmsMessageType&scopeValue=Newsletter&scope2=Segment&scopeValue2=13&grouping=Date
SummaryStatistic element children:
*Summary rows do not contain grouping columns (e.g. Date, Month).
Examples
Examples
Statistics grouped by list from a certain period of time:
Request:
GET https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=test_api_key1&startDate=2018-01-01&endDate=2018-01-30&grouping=List HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
OK response:
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, 21 Feb 2018 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>
<PartsSent>7334910</PartsSent>
<Bounced>478621</Bounced>
<Delivered>3177803</Delivered>
<Clicks>145664</Clicks>
<Clickers>98761</Clickers>
<Unsubscribes>34211</Unsubscribes>
<Goals>12344</Goals>
<GoalsValue>123440</GoalsValue>
</SummaryStatistic>
<SummaryStatistic>
<ListId>38</ListId>
<ListName>test list</ListName>
<Sent>1262372</Sent>
<PartsSent>1490223</PartsSent>
<Bounced>144511</Bounced>
<Delivered>1117861</Delivered>
<Clicks>83445</Clicks>
<Clickers>34552</Clickers>
<Unsubscribes>56775</Unsubscribes>
<Goals>3345</Goals>
<GoalsValue>33450</GoalsValue>
</SummaryStatistic>
...
</SummaryStatistics>
</Data>
</ApiResponse>
Statistics filtered by message type and grouped by month:
Request:
GET https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=test_api_key1&scope=SmsMmsMessageType&scopeValue=Newsletter&grouping=Month HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
OK response:
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, 21 Feb 2018 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>
<PartsSent>32721341</PartsSent>
<Bounced>6136556</Bounced>
<Delivered>15120145</Delivered>
<Clicks>17264</Clicks>
<Clickers>12326</Clickers>
<Unsubscribes>3351</Unsubscribes>
<Goals>0</Goals>
<GoalsValue>0</GoalsValue>
</SummaryStatistic>
<SummaryStatistic>
<Month>2018-01-01 : 2018-01-31</Month>
<Sent>5051025</Sent>
<PartsSent>6725568</PartsSent>
<Bounced>1814659</Bounced>
<Delivered>3236366</Delivered>
<Clicks>4194</Clicks>
<Clickers>2887</Clickers>
<Unsubscribes>799</Unsubscribes>
<Goals>0</Goals>
<GoalsValue>0</GoalsValue>
</SummaryStatistic>
...
</SummaryStatistics>
</Data>
</ApiResponse>
Report abuse