{"id":3727,"date":"2023-08-31T07:10:50","date_gmt":"2023-08-31T06:10:50","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3727"},"modified":"2024-06-25T13:04:18","modified_gmt":"2024-06-25T12:04:18","slug":"get-summary-statistics","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/sms-mms-statistics\/get-summary-statistics\/","title":{"rendered":"Get summary statistics"},"content":{"rendered":"\n

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.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
startDate<\/td>date<\/td>Start date. Optional. If not specified, business unit creation date will be taken. YYYY-MM-DD format.<\/td><\/tr>
endDate<\/td>date<\/td>End date. Optional. If not specified, current date will be taken. YYYY-MM-DD format.<\/td><\/tr>
scope<\/td>string<\/td>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<\/td><\/tr>
scopeValue<\/td>mixed<\/td>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<\/td><\/tr>
grouping<\/td>string<\/td>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\u00a0

NOTE: It is impossible to filter and group by the same thing.\u00a0scope<\/code>\u00a0parameter value must be different from\u00a0grouping<\/code>\u00a0parameter value.<\/td><\/tr>
returnMessageTags<\/td>boolean<\/td>If set to true and grouping set to SmsMmsMessage, then Tags used in each message will be returned. Optional. Default set to false.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE<\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2022-12-01&endDate=2022-12-31<\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=List&scopeValue=123<\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=SmsMmsMessageType&scopeValue=Newsletter&grouping=Date<\/span><\/span>\n<\/span>\nhttps:\/\/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<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
SummaryStatistic element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
IsSummaryRow<\/td>boolean<\/td>If set to true, marks the summary row of statistic table (values are sums of all other rows).*<\/td><\/tr>
Date<\/td>date<\/td>Date. Returned only if grouping by dates was requested.<\/td><\/tr>
Month<\/td>string<\/td>Month represented as date period. Returned only if grouping by months was requested.
Example: 2018-01-01 : 2018-01-31<\/td><\/tr>
SmsMmsMessageId<\/td>int <\/td>Message ID. Returned only if grouping by messages was requested.<\/td><\/tr>
Campaign<\/td>string<\/td>Campaign description. Returned only if grouping by messages was requested.<\/td><\/tr>
SmsMmsMessageType<\/td>string<\/td>Message type name. Returned only if grouping by message type was requested.<\/td><\/tr>
ListId<\/td>int<\/td>Subscriber list ID. Returned only if grouping by lists was requested.<\/td><\/tr>
ListName<\/td>string<\/td>Subscriber list name. Returned only if grouping by lists was requested.<\/td><\/tr>
SegmentId<\/td>int<\/td>Subscriber segment ID. Returned only if grouping by segments was requested.<\/td><\/tr>
SegmentName<\/td>string<\/td>Subscriber segment name. Returned only if grouping by segments as requested. If row contains data about unsegmented subscribers, it will return dash (“-“) as value.<\/td><\/tr>
Vendor<\/td>string<\/td>Vendor name. Returned only if grouping by vendors was requested. If row contains data about subscribers with no vendor, dash (“-“) will be returned.<\/td><\/tr>
Tag<\/td>string <\/td> Tag name. Returned only if grouping by tags was requested.<\/td><\/tr>
MobileOS<\/td>string<\/td>Mobile OS name. Returned only if grouping by mobile OS was requested.<\/td><\/tr>
Sender<\/td>string<\/td>Sender. Returned only if grouping by senders was requested.<\/td><\/tr>
Sent<\/td>int<\/td>Number of sent messages.<\/td><\/tr>
PartsSent<\/td>int<\/td>Number of sent message parts.<\/td><\/tr>
Bounced<\/td>int<\/td>Number of bounced messages.<\/td><\/tr>
Delivered<\/td>int<\/td>Number of delivered (sent – bounced) messages.<\/td><\/tr>
Clicks<\/td>int<\/td>Number of link clicks.<\/td><\/tr>
Clickers<\/td>int<\/td>Number of unique subscribers that clicked any link.<\/td><\/tr>
Unsubscribes<\/td>int<\/td>Number of \u201cunsubscribe\u201d link clicks.<\/td><\/tr>
Goals<\/td>int<\/td>Number of achieved business goals. <\/td><\/tr>
GoalsValue<\/td>int<\/td>Value of achieved business goals.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
*Summary rows do not contain grouping columns (e.g. Date, Month).<\/p>\n\n\n\n
<\/a><\/a>Examples<\/strong><\/h3>\n\n\n\n
Statistics grouped by list from a certain period of time:<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
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<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 5.0<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=209ffb47-7020-4508-99dc-8f7083928452; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Wed, 21 Feb 2018 14:51:50 GMT<\/span><\/span>\nContent-Length: 97229<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>SummaryStatistics<\/span>><\/span><\/span>\n      <\/span><<\/span>SummaryStatistic<\/span>><\/span><\/span>\n        <\/span><<\/span>IsSummaryRow<\/span>><\/span>true<\/span><\/<\/span>IsSummaryRow<\/span>><\/span><\/span>\n        <\/span><<\/span>Sent<\/span>><\/span>3656424<\/span><\/<\/span>Sent<\/span>><\/span><\/span>\n        <\/span><<\/span>PartsSent<\/span>><\/span>7334910<\/span><\/<\/span>PartsSent<\/span>><\/span><\/span>\n        <\/span><<\/span>Bounced<\/span>><\/span>478621<\/span><\/<\/span>Bounced<\/span>><\/span><\/span>\n        <\/span><<\/span>Delivered<\/span>><\/span>3177803<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n        <\/span><<\/span>Clicks<\/span>><\/span>145664<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n        <\/span><<\/span>Clickers<\/span>><\/span>98761<\/span><\/<\/span>Clickers<\/span>><\/span><\/span>\n        <\/span><<\/span>Unsubscribes<\/span>><\/span>34211<\/span><\/<\/span>Unsubscribes<\/span>><\/span><\/span>\n        <\/span><<\/span>Goals<\/span>><\/span>12344<\/span><\/<\/span>Goals<\/span>><\/span><\/span>\n        <\/span><<\/span>GoalsValue<\/span>><\/span>123440<\/span><\/<\/span>GoalsValue<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SummaryStatistic<\/span>><\/span><\/span>\n      <\/span><<\/span>SummaryStatistic<\/span>><\/span><\/span>\n        <\/span><<\/span>ListId<\/span>><\/span>38<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n        <\/span><<\/span>ListName<\/span>><\/span>test list<\/span><\/<\/span>ListName<\/span>><\/span><\/span>\n        <\/span><<\/span>Sent<\/span>><\/span>1262372<\/span><\/<\/span>Sent<\/span>><\/span><\/span>\n        <\/span><<\/span>PartsSent<\/span>><\/span>1490223<\/span><\/<\/span>PartsSent<\/span>><\/span><\/span>\n        <\/span><<\/span>Bounced<\/span>><\/span>144511<\/span><\/<\/span>Bounced<\/span>><\/span><\/span>\n        <\/span><<\/span>Delivered<\/span>><\/span>1117861<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n        <\/span><<\/span>Clicks<\/span>><\/span>83445<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n        <\/span><<\/span>Clickers<\/span>><\/span>34552<\/span><\/<\/span>Clickers<\/span>><\/span><\/span>\n        <\/span><<\/span>Unsubscribes<\/span>><\/span>56775<\/span><\/<\/span>Unsubscribes<\/span>><\/span><\/span>\n        <\/span><<\/span>Goals<\/span>><\/span>3345<\/span><\/<\/span>Goals<\/span>><\/span><\/span>\n        <\/span><<\/span>GoalsValue<\/span>><\/span>33450<\/span><\/<\/span>GoalsValue<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SummaryStatistic<\/span>><\/span><\/span>\n      ...<\/span><\/span>\n    <\/span><\/<\/span>SummaryStatistics<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Statistics filtered by message type and grouped by month:<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/SummaryStatistics?apiKey=test_api_key1&scope=SmsMmsMessageType&scopeValue=Newsletter&grouping=Month HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 5.0<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=90015733-b2c3-4a23-93ac-b9bce60ab8af; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Wed, 21 Feb 2018 15:04:03 GMT<\/span><\/span>\nContent-Length: 5655<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>SummaryStatistics<\/span>><\/span><\/span>\n      <\/span><<\/span>SummaryStatistic<\/span>><\/span><\/span>\n        <\/span><<\/span>IsSummaryRow<\/span>><\/span>true<\/span><\/<\/span>IsSummaryRow<\/span>><\/span><\/span>\n        <\/span><<\/span>Sent<\/span>><\/span>21256701<\/span><\/<\/span>Sent<\/span>><\/span><\/span>\n        <\/span><<\/span>PartsSent<\/span>><\/span>32721341<\/span><\/<\/span>PartsSent<\/span>><\/span><\/span>\n        <\/span><<\/span>Bounced<\/span>><\/span>6136556<\/span><\/<\/span>Bounced<\/span>><\/span><\/span>\n        <\/span><<\/span>Delivered<\/span>><\/span>15120145<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n        <\/span><<\/span>Clicks<\/span>><\/span>17264<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n        <\/span><<\/span>Clickers<\/span>><\/span>12326<\/span><\/<\/span>Clickers<\/span>><\/span><\/span>\n        <\/span><<\/span>Unsubscribes<\/span>><\/span>3351<\/span><\/<\/span>Unsubscribes<\/span>><\/span><\/span>\n        <\/span><<\/span>Goals<\/span>><\/span>0<\/span><\/<\/span>Goals<\/span>><\/span><\/span>\n        <\/span><<\/span>GoalsValue<\/span>><\/span>0<\/span><\/<\/span>GoalsValue<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SummaryStatistic<\/span>><\/span><\/span>\n      <\/span><<\/span>SummaryStatistic<\/span>><\/span><\/span>\n        <\/span><<\/span>Month<\/span>><\/span>2018-01-01 : 2018-01-31<\/span><\/<\/span>Month<\/span>><\/span><\/span>\n        <\/span><<\/span>Sent<\/span>><\/span>5051025<\/span><\/<\/span>Sent<\/span>><\/span><\/span>\n        <\/span><<\/span>PartsSent<\/span>><\/span>6725568<\/span><\/<\/span>PartsSent<\/span>><\/span><\/span>\n        <\/span><<\/span>Bounced<\/span>><\/span>1814659<\/span><\/<\/span>Bounced<\/span>><\/span><\/span>\n        <\/span><<\/span>Delivered<\/span>><\/span>3236366<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n        <\/span><<\/span>Clicks<\/span>><\/span>4194<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n        <\/span><<\/span>Clickers<\/span>><\/span>2887<\/span><\/<\/span>Clickers<\/span>><\/span><\/span>\n        <\/span><<\/span>Unsubscribes<\/span>><\/span>799<\/span><\/<\/span>Unsubscribes<\/span>><\/span><\/span>\n        <\/span><<\/span>Goals<\/span>><\/span>0<\/span><\/<\/span>Goals<\/span>><\/span><\/span>\n        <\/span><<\/span>GoalsValue<\/span>><\/span>0<\/span><\/<\/span>GoalsValue<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SummaryStatistic<\/span>><\/span><\/span>\n      <\/span><\/span>\n      ...<\/span><\/span>\n      <\/span><\/span>\n    <\/span><\/<\/span>SummaryStatistics<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3719,"menu_order":273,"template":"","format":"standard","emp-category":[],"class_list":["post-3727","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3727","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3727\/revisions"}],"predecessor-version":[{"id":11021,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3727\/revisions\/11021"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3719"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3727"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3727"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}