{"id":3713,"date":"2023-08-31T06:51:36","date_gmt":"2023-08-31T05:51:36","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3713"},"modified":"2026-03-20T09:16:23","modified_gmt":"2026-03-20T08:16:23","slug":"get-message-statistics","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/email-statistics\/get-message-statistics\/","title":{"rendered":"Get message statistics"},"content":{"rendered":"\n

MessageStatistics 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, opens, 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>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>
grouping<\/td>string<\/td>Results grouping. Optional. If not specified, results will be grouped by whole business unit and message.
Available groupings are:
– Date
– Month
– List
– Segment
– Ip
– Domain
– DomainFamily
– Vendor
– SendTimeOptimization
– TimeTravelOptimization
– ReadingEnvironment
– OperatingSystem
<\/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\/MessageStatistics\/123?apiKey=YOUR_API_KEY_HERE <\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/MessageStatistics\/123?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-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 emails.<\/td><\/tr>
Bounced<\/td>int<\/td>Number of bounced emails.<\/td><\/tr>
Delivered<\/td>int<\/td>Number of delivered (sent – bounced) emails.<\/td><\/tr>
Opens<\/td>int<\/td>Number of opened emails.<\/td><\/tr>
UniqueOpens<\/td>int<\/td>Number of opened emails by unique subscribers.<\/td><\/tr>
Clicks<\/td>int<\/td>Number of link clicks.<\/td><\/tr>
UniqueClicks<\/td>int<\/td>Number of link clicks by unique subscribers.<\/td><\/tr>
Clickers<\/td>int<\/td>Number of unique subscribers that clicked any link.<\/td><\/tr>
Complaints<\/td>int<\/td>Number of spam complaints.<\/td><\/tr>
Unsubscribes<\/td>int<\/td>Number of \u201cunsubscribe\u201d link clicks.<\/td><\/tr>
Bcc<\/td>int<\/td>Number of BCC emails sent. Available only for units with BCC feature enabled.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response Data element  with a grouping parameter:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
MessageStatistics<\/td>array[complex]<\/td>Array of MessageStatistic elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
MessageStatistic element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
IsSummaryRow<\/td>boolean<\/td>If set to true, marks the summary row of statistic table (values are sums of all other rows).<\/td><\/tr>
DomainFamily<\/td>string<\/td>Domain family name. Returned only if grouping by domain families was requested.<\/td><\/tr>
Sent<\/td>int<\/td>Number of sent emails.<\/td><\/tr>
Bounced<\/td>int<\/td>Number of bounced emails.<\/td><\/tr>
Delivered<\/td>int<\/td>Number of delivered (sent – bounced) emails.<\/td><\/tr>
Opens<\/td>int<\/td>Number of opened emails.<\/td><\/tr>
UniqueOpens<\/td>int<\/td>Number of opened emails by unique subscribers.<\/td><\/tr>
Clicks<\/td>int<\/td>Number of link clicks.<\/td><\/tr>
UniqueClicks<\/td>int<\/td>
Number of link clicks by unique subscribers.<\/td><\/tr>
Clickers<\/td>int<\/td>Number of unique subscribers that clicked any link.<\/td><\/tr>
Complaints<\/td>int<\/td>Number of spam complaints.<\/td><\/tr>
Unsubscribes<\/td>int<\/td>Number of \u201cunsubscribe\u201d link clicks.<\/td><\/tr>
Bcc<\/td>int<\/td>
Number of BCC emails sent. Available only for units with BCC feature enabled.<\/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\/MessageStatistics\/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>Bounced<\/span>><\/span>0<\/span><\/<\/span>Bounced<\/span>><\/span><\/span>\n     <\/span><<\/span>Delivered<\/span>><\/span>9<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n     <\/span><<\/span>Opens<\/span>><\/span>19<\/span><\/<\/span>Opens<\/span>><\/span><\/span>\n     <\/span><<\/span>UniqueOpens<\/span>><\/span>1<\/span><\/<\/span>UniqueOpens<\/span>><\/span><\/span>\n     <\/span><<\/span>Clicks<\/span>><\/span>12<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n     <\/span><<\/span>UniqueClicks<\/span>><\/span>3<\/span><\/<\/span>UniqueClicks<\/span>><\/span><\/span>\n     <\/span><<\/span>Clickers<\/span>><\/span>3<\/span><\/<\/span>Clickers<\/span>><\/span><\/span>\n     <\/span><<\/span>Complaints<\/span>><\/span>0<\/span><\/<\/span>Complaints<\/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\n\n\n
Request with a grouping parameter:<\/p>\n\n\n\n