Returns a page of clicks.

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 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.
embed_field_backups false Supported values: true / false. Field Backups are the values of contact fields that have been backed up for mailings because of a backup instruction. For each click, the corresponding field backups will be returned if available.
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