Returns a page of unique clicks or the number of unique clicks, only.
1 |
GET https://api.maileon.com/1.0/reports/clicks/unique |
1 |
GET https://api.maileon.com/1.0/reports/clicks/unique/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 | |
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 clicks that cannot be mapped to contacts because of permission types or because unsubscriptions are omitted in the results. |
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
1 2 3 |
GET https://api.maileon.com/1.0/reports/clicks/unique?page_index=1&page_size=500&exclude_anonymous_clicks=false&embed_email_client_infos=true Authorization: Basic XXXXXXXXXXXXXXX Accept: application/vnd.maileon.api+xml; charset=utf-8 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
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_url>http://www.xqueue.com</link_url> <format>html</format> <device_type>MOBILE</device_type> <link_tags> <link_tag>example</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></xml> |