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

SmsMmsMessageStatistics collection allows retrieving performance statistics for a specified message. A specific period of time can be chosen. Statistics include counters of sent, delivered, bounced messages as well as number of generated clicks, unsubscribes etc.<\/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>
ID<\/td>int<\/td>SMS\/MMS message ID. Required as a part of address (not GET parameter). See example below.<\/td><\/tr>
startDate<\/td>date<\/td>Start date. Optional. If not specified, message 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><\/tbody><\/table><\/figure>\n\n\n\n

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

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessageStatistics\/123?apiKey=YOUR_API_KEY_HERE <\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessageStatistics\/123?apiKey=YOUR_API_KEY_HERE&startDate=2017-05-20&endDate=2017-05-22<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Sent<\/td>int<\/td>Number of sent messages.<\/td><\/tr>
PartsSent<\/td>int<\/td>Number of sent 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 unsubscriptions<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessageStatistics\/764?apiKey=test_api_key1 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>\nContent-Encoding: gzip <\/span><\/span>\nVary: Accept-Encoding <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=conq5cmaq3mmpy455bkihvyd; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 1.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Mon, 24 May 2010 13:03:04 GMT <\/span><\/span>\nContent-Length: 351 <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Sent<\/span>><\/span>9<\/span><\/<\/span>Sent<\/span>><\/span><\/span>\n     <\/span><<\/span>PartsSent<\/span>><\/span>13<\/span><\/<\/span>PartsSent<\/span>><\/span><\/span>\n     <\/span><<\/span>Bounced<\/span>><\/span>2<\/span><\/<\/span>Bounced<\/span>><\/span><\/span>\n     <\/span><<\/span>Delivered<\/span>><\/span>7<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n     <\/span><<\/span>Clicks<\/span>><\/span>12<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n     <\/span><<\/span>Clickers<\/span>><\/span>3<\/span><\/<\/span>Clickers<\/span>><\/span><\/span>\n     <\/span><<\/span>Unsubscribes<\/span>><\/span>0<\/span><\/<\/span>Unsubscribes<\/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":275,"template":"","format":"standard","emp-category":[],"class_list":["post-3723","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3723","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":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3723\/revisions"}],"predecessor-version":[{"id":8841,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3723\/revisions\/8841"}],"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=3723"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3723"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}