Get summary statistics - ExpertSender Help Center

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/attribute	Type	Notes
apiKey	string	Your API key, required for authentication. Required.
startDate	date	Start date. Optional. If not specified, business unit creation date will be taken. YYYY-MM-DD format.
endDate	date	End date. Optional. If not specified, current date will be taken. YYYY-MM-DD format.
scope	string	Filtering 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 list SmsMmsMessageType — only results for specific message type* Segment — only results for specific subscriber segment Vendor — only results for specific vendor Tag — only results for messages marked with a tag MobileOS — only results for specific Mobile OS Sender — only results for specific sender
scopeValue	mixed	Filtering scope value. Required if scope was specified. This is a mixed value, type depends on selected scope: List — List ID, int, e.g. 123 Segment — Segment ID, int, e.g. 123 SmsMmsMessageType — message type name, string, e.g. Newsletter* Vendor — vendor name, string, e.g. foobar Tag — Tag name, string, e.g. holidays MobileOS — mobile OS name, string, e.g. Android Sender — sender name, string, e.g. smsApi
grouping	string	Results 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: Date Month SmsMmsMessage SmsMmsMessageType List Segment Vendor Tag MobileOS Sender NOTE: It is impossible to filter and group by the same thing. `scope` parameter value must be different from `grouping` parameter value.
returnMessageTags	boolean	If 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/attribute	Type	Notes
IsSummaryRow	boolean	If set to true, marks the summary row of statistic table (values are sums of all other rows).*
Date	date	Date. Returned only if grouping by dates was requested.
Month	string	Month represented as date period. Returned only if grouping by months was requested. Example: 2018-01-01 : 2018-01-31
SmsMmsMessageId	int	Message ID. Returned only if grouping by messages was requested.
Campaign	string	Campaign description. Returned only if grouping by messages was requested.
SmsMmsMessageType	string	Message type name. Returned only if grouping by message type was requested.
ListId	int	Subscriber list ID. Returned only if grouping by lists was requested.
ListName	string	Subscriber list name. Returned only if grouping by lists was requested.
SegmentId	int	Subscriber segment ID. Returned only if grouping by segments was requested.
SegmentName	string	Subscriber segment name. Returned only if grouping by segments as requested. If row contains data about unsegmented subscribers, it will return dash («-«) as value.
Vendor	string	Vendor name. Returned only if grouping by vendors was requested. If row contains data about subscribers with no vendor, dash («-«) will be returned.
Tag	string	Tag name. Returned only if grouping by tags was requested.
MobileOS	string	Mobile OS name. Returned only if grouping by mobile OS was requested.
Sender	string	Sender. Returned only if grouping by senders was requested.
Sent	int	Number of sent messages.
PartsSent	int	Number of sent message parts.
Bounced	int	Number of bounced messages.
Delivered	int	Number of delivered (sent — bounced) messages.
Clicks	int	Number of link clicks.
Clickers	int	Number of unique subscribers that clicked any link.
Unsubscribes	int	Number of “unsubscribe” link clicks.
Goals	int	Number of achieved business goals.
GoalsValue	int	Value 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>