{"id":10932,"date":"2024-06-25T10:56:03","date_gmt":"2024-06-25T09:56:03","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=10932"},"modified":"2024-06-25T12:21:40","modified_gmt":"2024-06-25T11:21:40","slug":"get-vendor-statistics","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/get-vendor-statistics\/","title":{"rendered":"Get vendor statistics"},"content":{"rendered":"\n

VendorStatistics collection allows retrieving performance statistics that are grouped by subscriber\u2019s vendor. Specific period of time can be chosen. Available data is similar to message statistics.<\/p>\n\n\n\n

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

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

Parameter<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
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><\/tbody><\/table><\/figure>\n\n\n\n

Example:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/VendorStatistics?apiKey=YOUR_API_KEY_HERE <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/VendorStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Re<\/strong>sponse<\/strong><\/h3>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
VendorStatistics<\/td>array[complex]<\/td>Array of VendorStatistic elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
VendorStatistic element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Vendor<\/td>string<\/td>Vendor name.<\/td><\/tr>
Sent<\/td>int<\/td>Number of sent emails.\u00a0<\/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><\/tbody><\/table><\/figure>\n\n\n\n
Example<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/VendorStatistics?startDate=2011-04-01&apiKey=test_api_key1&endDate=2011-05-01 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: 2.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nSet-Cookie: TIMEZONE=Central European Standard Time; path=\/ <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Wed, 19 Oct 2011 11:15:44 GMT <\/span><\/span>\nContent-Length: 617  <\/span><\/span>\n<\/span>\n <\/span><<\/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>VendorStatistics<\/span>><\/span><\/span>\n       <\/span><<\/span>VendorStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>Vendor<\/span>><\/span>MyVendor<\/span><\/<\/span>Vendor<\/span>><\/span><\/span>\n         <\/span><<\/span>Sent<\/span>><\/span>912<\/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>912<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n         <\/span><<\/span>Opens<\/span>><\/span>16<\/span><\/<\/span>Opens<\/span>><\/span><\/span>\n         <\/span><<\/span>UniqueOpens<\/span>><\/span>9<\/span><\/<\/span>UniqueOpens<\/span>><\/span><\/span>\n         <\/span><<\/span>Clicks<\/span>><\/span>0<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n         <\/span><<\/span>UniqueClicks<\/span>><\/span>0<\/span><\/<\/span>UniqueClicks<\/span>><\/span><\/span>\n         <\/span><<\/span>Clickers<\/span>><\/span>0<\/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>VendorStatistic<\/span>><\/span><\/span>\n     <\/span><\/<\/span>VendorStatistics<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n <\/span><\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":13,"featured_media":0,"parent":3551,"menu_order":0,"template":"","format":"standard","emp-category":[],"class_list":["post-10932","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10932","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\/13"}],"version-history":[{"count":1,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10932\/revisions"}],"predecessor-version":[{"id":10933,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10932\/revisions\/10933"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3551"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=10932"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=10932"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}