{"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":"2026-05-19T13:25:42","modified_gmt":"2026-05-19T12:25:42","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
LinkStatistic element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Url<\/td>string<\/td>Link URL.<\/td><\/tr>
Title<\/td>string<\/td>Link title. Serialized only when not empty.<\/td><\/tr>
Clicks<\/td>int<\/td>Total number of clicks.<\/td><\/tr>
UniqueClicks<\/td>int<\/td>Total number of unique clicks.<\/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\/LinkStatistics\/123?apiKey=test_api_key1 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>LinkStatistics<\/span>><\/span><\/span>\n            <\/span><<\/span>LinkStatistic<\/span>><\/span><\/span>\n                <\/span><<\/span>Url<\/span>><\/span>https:\/\/www.example.com\/products\/summer-sale<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n                <\/span><<\/span>Title<\/span>><\/span>Summer Sale<\/span><\/<\/span>Title<\/span>><\/span><\/span>\n                <\/span><<\/span>Clicks<\/span>><\/span>400<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n                <\/span><<\/span>UniqueClicks<\/span>><\/span>201<\/span><\/<\/span>UniqueClicks<\/span>><\/span><\/span>\n            <\/span><\/<\/span>LinkStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>LinkStatistic<\/span>><\/span><\/span>\n                <\/span><<\/span>Url<\/span>><\/span>*[link_preferencecenter]*<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n                <\/span><<\/span>Clicks<\/span>><\/span>399<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n                <\/span><<\/span>UniqueClicks<\/span>><\/span>201<\/span><\/<\/span>UniqueClicks<\/span>><\/span><\/span>\n            <\/span><\/<\/span>LinkStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>LinkStatistic<\/span>><\/span><\/span>\n                <\/span><<\/span>Url<\/span>><\/span>https:\/\/www.example.com\/blog\/welcome<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n                <\/span><<\/span>Title<\/span>><\/span>Read more<\/span><\/<\/span>Title<\/span>><\/span><\/span>\n                <\/span><<\/span>Clicks<\/span>><\/span>128<\/span><\/<\/span>Clicks<\/span>><\/span><\/span>\n                <\/span><<\/span>UniqueClicks<\/span>><\/span>97<\/span><\/<\/span>UniqueClicks<\/span>><\/span><\/span>\n            <\/span><\/<\/span>LinkStatistic<\/span>><\/span><\/span>\n        <\/span><\/<\/span>LinkStatistics<\/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":6,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3711\/revisions"}],"predecessor-version":[{"id":17215,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3711\/revisions\/17215"}],"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}]}}