Перейти к содержимому

Get vendor statistics

VendorStatistics collection allows retrieving performance statistics that are grouped by subscriber’s vendor. Specific period of time can be chosen. Available data is similar to message statistics.

Request data format

Request URL parameters:

ParameterTypeNotes
apiKeystringYour API key, required for authentication. Required.
startDatedateStart date. Optional. If not specified, business unit creation date will be taken. YYYY-MM-DD format.
endDatedateEnd date. Optional. If not specified, current date will be taken. YYYY-MM-DD format.

Example:

https://api.esv2.com/v2/Api/VendorStatistics?apiKey=YOUR_API_KEY_HERE 
https://api.esv2.com/v2/Api/VendorStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22

Response

Response Data element:

Element/attributeTypeNotes
VendorStatisticsarray[complex]Array of VendorStatistic elements.

VendorStatistic element children:

Element/attributeTypeNotes
VendorstringVendor name.
SentintNumber of sent emails. 
BouncedintNumber of bounced emails.
DeliveredintNumber of delivered (sent — bounced) emails.
OpensintNumber of opened emails.
UniqueOpensintNumber of opened emails by unique subscribers.
ClicksintNumber of link clicks.
UniqueClicksintNumber of link clicks by unique subscribers.
ClickersintNumber of unique subscribers that clicked any link.
ComplaintsintNumber of spam complaints.
UnsubscribesintNumber of “unsubscribe” link clicks.

Example

Request:

GET 
https://api.esv2.com/v2/Api/VendorStatistics?startDate=2011-04-01&apiKey=test_api_key1&endDate=2011-05-01 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: 2.0 
X-AspNet-Version: 2.0.50727 
Set-Cookie: TIMEZONE=Central European Standard Time; path=/ 
X-Powered-By: ASP.NET 
Date: Wed, 19 Oct 2011 11:15:44 GMT 
Content-Length: 617  

 <ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Data>
     <VendorStatistics>
       <VendorStatistic>
         <Vendor>MyVendor</Vendor>
         <Sent>912</Sent>
         <Bounced>0</Bounced>
         <Delivered>912</Delivered>
         <Opens>16</Opens>
         <UniqueOpens>9</UniqueOpens>
         <Clicks>0</Clicks>
         <UniqueClicks>0</UniqueClicks>
         <Clickers>0</Clickers>
         <Complaints>0</Complaints>
         <Unsubscribes>0</Unsubscribes>
       </VendorStatistic>
     </VendorStatistics>
   </Data>
 </ApiResponse>