Querying Email Clicks

Supported Operations

Operation	URL Format	Required Parameters	Description
`query`	`/api/emailClick/version/4/do/query?...`	`user_key, api_key, search_criteria, result_set_criteria`	Returns the email clicks matching the specified criteria parameters. Also see email clicks in Object Field References.

Supported Search Criteria

Search criteria may be used together in any combination and/or order unless otherwise specified. 200 email clicks will be returned with each query request.

Parameter	Datatype	Options	Description
`created_after`	`string`	`today, yesterday, last_7_days, this_month, last_month, <custom_time>`	Selects email clicks that were created after the specified time. If a `<custom_time>` is used, ensure that the specified date is formatted using GNU Date Input Syntax.
`created_before`	`string`	`today, yesterday, last_7_days, this_month, last_month, <custom_time>`	Selects email clicks that were created before the specified time. If a `<custom_time>` is used, ensure that the specified date is formatted using GNU Date Input Syntax.
`id_greater_than`	`integer`	`<any_positive_integer>`	Selects email clicks with IDs greater than the specified integer.
`list_email_id`	`integer`	`<any_positive_integer>`	Selects only email clicks generated by assets whose list email matches the specified ID.
`drip_program_action_id`	`integer`	`<any_positive_integer>`	Selects only email clicks generated by the drip program action with the specified ID.
`email_template_id`	`integer`	`<any_positive_integer>`	Selects only email clicks generated by the email template with the specified ID.
`tracker_redirect_id`	`integer`	`<any_positive_integer>`	Selects only email clicks generated by the tracker redirect with the specified ID.

Example Requests

Requests assume Authorization header including user_key and api_key has been provided.

Return email clicks since yesterday

POST /api/emailClick/version/4/do/query?created_after=yesterday

Return all email clicks of a list email

POST /api/emailClick/version/4/do/query?list_email_id=<id>

Return email clicks of a list email since January 1st after the last id

POST /api/emailClick/version/4/do/query?created_after=2016-01-01&ist_email_id=<id>&greater_than_id=<id>

Manipulating the Result Set

Since query result sets are limited to 200 results each, the results returned may not include all the email clicks matched by the query. To retrieve the remaining results, the following criteria can be used to navigate through the result set.

Parameter	Datatype	Options	Description
`limit`	`integer`	`<any_positive_integer>`	Specifies the number of results to be returned. Default value: `200`. *Note:* This number cannot be larger than 200.
`id_greater_than`	`integer`	`<any_positive_integer>`	If present, all Pardot ID email click records should be greater than this number. _Default value: `0`.

XML Response Format

<rsp stat="ok" version="1.0">
    <result>
        <total_results>...</total_results>
        <emailClick>...</emailClick>
            ...
    </result>
</rsp>

Tag	Description
`<result>`	Contains the resulting email clicks for the specified query.
`<total_results>`	Contains the number of email clicks selected by this query. If this value is higher than 200, then several query requests may be necessary to retrieve all of the matched email clicks.
`<emailClick>`	The data for an individual email click.