Skip to content

Get summary statistics

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 URL parameters:

Element/attributeTypeNotes
apiKeystringYour API key, required for authentication. Required.
startDatedateStart date. Optional. If not specified, business unit creation date will be taken. YYYY-MM-DD format.
endDatedateEnd date. Optional. If not specified, current date will be taken. YYYY-MM-DD format.
scopestringFiltering scope. Optional. If not specified, no filtering will be applied (data for the whole business unit will be returned).
Available scopes are:
List – only results for specific subscriber listSmsMmsMessageType – only results for specific message type*Segment – only results for specific subscriber segmentVendor – only results for specific vendorTag – only results for messages marked with a tagMobileOS – only results for specific Mobile OSSender – only results for specific sender
scopeValuemixedFiltering scope value. Required if scope was specified. This is a mixed value, type depends on selected scope:
List – List ID, int, e.g. 123Segment – Segment ID, int, e.g. 123SmsMmsMessageType – message type name, string, e.g. Newsletter*Vendor – vendor name, string, e.g. foobarTag – Tag name, string, e.g. holidaysMobileOS – mobile OS name, string, e.g. AndroidSender – sender name, string, e.g. smsApi
groupingstringResults grouping. Optional. If not specified, results will be grouped by whole business unit (one row of data will be returned with all values summed up).
Available groupings are:
DateMonthSmsMmsMessageSmsMmsMessageTypeListSegmentVendorTagMobileOSSender 
NOTE: It is impossible to filter and group by the same thing. scope parameter value must be different from grouping parameter value.
returnMessageTagsbooleanIf set to true and grouping set to SmsMmsMessage, then Tags used in each message will be returned. Optional. Default set to false.

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:

Element/attributeTypeNotes
IsSummaryRowbooleanIf set to true, marks the summary row of statistic table (values are sums of all other rows).*
DatedateDate. Returned only if grouping by dates was requested.
MonthstringMonth represented as date period. Returned only if grouping by months was requested.
Example: 2018-01-01 : 2018-01-31
SmsMmsMessageIdint Message ID. Returned only if grouping by messages was requested.
CampaignstringCampaign description. Returned only if grouping by messages was requested.
SmsMmsMessageTypestringMessage type name. Returned only if grouping by message type was requested.
ListIdintSubscriber list ID. Returned only if grouping by lists was requested.
ListNamestringSubscriber list name. Returned only if grouping by lists was requested.
SegmentIdintSubscriber segment ID. Returned only if grouping by segments was requested.
SegmentNamestringSubscriber segment name. Returned only if grouping by segments as requested. If row contains data about unsegmented subscribers, it will return dash (“-“) as value.
VendorstringVendor name. Returned only if grouping by vendors was requested. If row contains data about subscribers with no vendor, dash (“-“) will be returned.
Tagstring  Tag name. Returned only if grouping by tags was requested.
MobileOSstringMobile OS name. Returned only if grouping by mobile OS was requested.
SenderstringSender. Returned only if grouping by senders was requested.
SentintNumber of sent messages.
PartsSentintNumber of sent message parts.
BouncedintNumber of bounced messages.
DeliveredintNumber of delivered (sent – bounced) messages.
ClicksintNumber of link clicks.
ClickersintNumber of unique subscribers that clicked any link.
UnsubscribesintNumber of “unsubscribe” link clicks.
GoalsintNumber of achieved business goals. 
GoalsValueintValue of achieved business goals.

*Summary rows do not contain grouping columns (e.g. Date, Month).

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>
On this page
To top