Get Clicks
Returns a page of clicks.
About tracking links: Please remember that only with DOI+ permission, clicks can be linked to a user, otherwise all clicks will be linked to anonymous contacts. Furthermore not all clicks will have a URL assigned, e.g. MAILTO links are not tracked and for online versions, profile updates, unsubscriptions, calendar links, downloads and DOI confirmations, no URL will be provided. Also dynamic URLs, e.g. from transactions or external sources are not listed in detail, you will only see the variable.
To be able to differentiate between the type of links that have no URL provided, please refer to the attribute “link_type”, which can be one of STANDARD, ONLINE_VERSION, DOI_CONFIRMATION, ICAL, PROPERTY_UPDATE, DOWNLOAD.
To be able to differentiate between the type of links that have no URL provided, please refer to the attribute “link_type”, which can be one of STANDARD, ONLINE_VERSION, DOI_CONFIRMATION, ICAL, PROPERTY_UPDATE, DOWNLOAD.
GET https://api.maileon.com/1.0/reports/clicks
GET https://api.maileon.com/1.0/reports/clicks/count
Attributes
| Parameter | Default | Description |
| from_date | If provided, only the clicks after or equal (including) the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00 | |
| to_date | If provided, only the clicks before (excluding) the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00 | |
| mailing_id | Multivalued parameter to filter the clicks by mailings. Each value must correspond to a mailing id. | |
| ids | Multivalued parameter to filter the results by contacts. Each value must correspond to a contact id. | |
| emails | Multivalued parameter to filter the results by email addresses. | |
| eids | Multivalued parameter to filter the results by external ids. Each value must correspond to a contacts external id | |
| format | Filters the clicks by format. Possible values are: html / text. | |
| link_id | Multivalued parameter to filter the clicks by links. Each value must correspond to a link id. | |
| link_url | Filters the clicks by link url. | |
| link_tag | Multivalued parameter to filter the clicks by tags associated to the links. | |
| social_network | Multivalued parameter to filter the clicks by the social networks where they occurred. | |
| device_type | Multivalued parameter to filter the clicks by device type. Possible values for device_type are: UNKNOWN / COMPUTER / TABLET / MOBILE | |
| embed_email_client_infos | false | If the set to true, available email client details will be appended to each click. |
| embed_link_tags | false | If the set to true, the tags for the clicked link will be contained in the response. |
| exclude_anonymous_clicks | true | Supported values: true / false. If set to true, the blocks that cannot be mapped to contacts because of permission types or because unsubscriptions are omitted in the results |
| embed_transaction_id | false | If the set to true, the attribut “transaction_id” of a transaction will be returned that caused this click, if available. If this setting is set to true, it will add a ‘transaction_id’ element to the result.embed_contact_hashfalseIf the set to true, anonymized contacts will be annotated with a random number that is the same for a contact within each sendout. With this flag, it is possible to calculate unique clicks from all clicks, even if contacts are unsubscribed and therefore anonymized. If in two clicks of the same sendout the contact hash is the same, then the same contact clicked twice. In different mails the same contact hash might occur on a click but will most probably not belong to the same (anonymized) contact. If this setting is set to true, it will add a ‘contact_hash’ element to the result. |
| standard_field | Multivalued parameter to query the value of a standard contact field. | |
| custom_field | Multivalued parameter to query the value of a custom contact field. | |
| page_index | 1 | The index of the result page. The index must be greater or equal to 1. |
| page_size | 100 | The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000. |
Example
GET https://api.maileon.com/1.0/reports/clicks?page_index=3&page_size=1000&exclude_anonymous_clicks=false&embed_email_client_infos=true Authorization: Basic XXXXXXXXXXXXXXX Accept: application/vnd.maileon.api+xml; charset=utf-8
Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: ...
X-Pages: ...
X-Items: ...
<!--?xml version="1.0" encoding="UTF-8"-->
<clicks>
<click>
<contact anonymous="true"></contact>
<timestamp>2013-01-14 19:00:31</timestamp>
<mailing_id>3385</mailing_id>
<link_id>121252</link_id>
<link_type>STANDARD</link_type>
<link_url>http://www.xqueue.com</link_url>
<format>html</format>
<device_type>MOBILE</device_type>
<link_tags>
<link_tag>tag2</link_tag>
<link_tag>xqueue</link_tag>
</link_tags>
<client>
<os_name>ANDROID2</os_name>
<os_group>ANDROID</os_group>
<browser>MOBILE_SAFARI</browser>
<browser_group>SAFARI</browser_group>
<browser_type>MOBILE_BROWSER</browser_type>
<user_agent nil="true"></user_agent>
<rendering_engine>WEBKIT</rendering_engine>
</client>
</click>
...
</clicks>
