{"id":3711,"date":"2023-08-31T06:49:05","date_gmt":"2023-08-31T05:49:05","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3711"},"modified":"2024-03-19T13:24:00","modified_gmt":"2024-03-19T12:24:00","slug":"get-link-statistics","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/email-statistics\/get-link-statistics\/","title":{"rendered":"Get link statistics"},"content":{"rendered":"\n

LinkStatistics collection allows retrieving performance statistics for a specified message that are grouped by links such message contains. For every found link numbers of clicks, unique clicks etc. are available.<\/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. Both parameters (startDate, endDate) are required to specify statistics range. Otherwise they are ignored. YYYY-MM-DD format.<\/td><\/tr>
endDate<\/td>date<\/td>See startDate.<\/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\/LinkStatistics\/123?apiKey=YOUR_API_KEY_HERE <\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/LinkStatistics\/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>
LinkStatistics<\/td>array[complex]<\/td>Array of LinkStatistic elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
SplitTestStatistic element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
VersionId<\/td>int<\/td>ID of split test version.<\/td><\/tr>
VersionName<\/td>string<\/td>Split test version name (message subject).<\/td><\/tr>
VersionType<\/td>string<\/td>Split test version type. Can be either “TestGroup” or “Winner”.<\/td><\/tr>
VersionSentDate<\/td>datetime<\/td>Split test version sending date.<\/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>
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
Examples<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/SplitTestStatistics?apiKey=test_api_key1&id=123443 HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nConnection: Keep-Alive<\/span><\/span>\nUser-Agent: Apache-HttpClient\/4.1.1 (java 1.5)<\/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.2<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=52936639-f1a2-4537-acba-c405471a1203; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Thu, 26 Nov 2015 14:22:15 GMT<\/span><\/span>\nContent-Length: 1954<\/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>SplitTestStatistics<\/span>><\/span><\/span>\n      <\/span><<\/span>SplitTestStatistic<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionId<\/span>><\/span>17567<\/span><\/<\/span>VersionId<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionName<\/span>><\/span>version 1<\/span><\/<\/span>VersionName<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionType<\/span>><\/span>TestGroup<\/span><\/<\/span>VersionType<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionSentDate<\/span>><\/span>2015-10-29T11:00:00<\/span><\/<\/span>VersionSentDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Sent<\/span>><\/span>54<\/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>54<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n        <\/span><<\/span>Opens<\/span>><\/span>15<\/span><\/<\/span>Opens<\/span>><\/span><\/span>\n        <\/span><<\/span>UniqueOpens<\/span>><\/span>15<\/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>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>SplitTestStatistic<\/span>><\/span><\/span>\n      <\/span><<\/span>SplitTestStatistic<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionId<\/span>><\/span>17568<\/span><\/<\/span>VersionId<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionName<\/span>><\/span>version 2<\/span><\/<\/span>VersionName<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionType<\/span>><\/span>TestGroup<\/span><\/<\/span>VersionType<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionSentDate<\/span>><\/span>2015-10-29T11:00:00<\/span><\/<\/span>VersionSentDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Sent<\/span>><\/span>53<\/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>53<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n        <\/span><<\/span>Opens<\/span>><\/span>11<\/span><\/<\/span>Opens<\/span>><\/span><\/span>\n        <\/span><<\/span>UniqueOpens<\/span>><\/span>11<\/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>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>SplitTestStatistic<\/span>><\/span><\/span>\n      <\/span><<\/span>SplitTestStatistic<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionId<\/span>><\/span>17569<\/span><\/<\/span>VersionId<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionName<\/span>><\/span>version 1<\/span><\/<\/span>VersionName<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionType<\/span>><\/span>Winner<\/span><\/<\/span>VersionType<\/span>><\/span><\/span>\n        <\/span><<\/span>VersionSentDate<\/span>><\/span>2015-10-29T17:00:00<\/span><\/<\/span>VersionSentDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Sent<\/span>><\/span>320<\/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>320<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n        <\/span><<\/span>Opens<\/span>><\/span>127<\/span><\/<\/span>Opens<\/span>><\/span><\/span>\n        <\/span><<\/span>UniqueOpens<\/span>><\/span>127<\/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>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>SplitTestStatistic<\/span>><\/span><\/span>\n    <\/span><\/<\/span>SplitTestStatistics<\/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":3707,"menu_order":280,"template":"","format":"standard","emp-category":[],"class_list":["post-3711","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3711","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\/3711\/revisions"}],"predecessor-version":[{"id":8836,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3711\/revisions\/8836"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3707"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3711"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3711"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}