For the complete documentation index, see llms.txt. This page is also available as Markdown.

Click Export

Asynchronously export click event data as CSV, JSON, or XML.

Export Clicks

get

Schedules a background job to asynchronously export clicks. Returns immediately with a QueuedUri pointing to the Partner Jobs API — poll that endpoint to track progress, then download the result from ResultUri once the job is complete.

Migration note: If you're migrating from the Clicks endpoint to ClickExport, note that the result object uses ProgramId and ProgramName in place of the previous CampaignId and CampaignName.

See the impact.com rate-limit documentation for this endpoint's request limits.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters
ProgramIdstring[]Optional

Filter to clicks for a specific Program (formerly known as Campaign). Repeat the parameter to include multiple Programs.

AdIdstring[]Optional

Filter to clicks on a specific ad. Repeat the parameter to include multiple ads.

Datestring · dateOptional

Click date to export in yyyy-MM-dd format. Defaults to today if omitted.

SubIdstring[]Optional

Filter to clicks that include the specified Sub ID value. Repeat the parameter to include multiple Sub IDs.

UniqueClickstring · enumOptional

Set to TRUE to return only clicks that meet the IAB standards for a unique click. See the IAB Click Measurement Guidelines for details.

Possible values:
ResultFormatstring · enumOptional

Format for the exported result file.

Default: CSVPossible values:
Responses
200

Job successfully queued.

application/json
StatusstringOptional

Initial status of the queued export job.

Example: QUEUED
QueuedUristringOptional

API resource path for polling the job's status via the Partner Jobs API.

Example: /Mediapartners/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f
ResultUristringOptional

API resource path to download the result file once the job has completed.

Example: /Mediapartners/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download
ReplayUristringOptional

API resource path to replay the export job once it has completed, failed, or been cancelled.

Example: /Mediapartners/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Replay
get/Mediapartners/{AccountSID}/ClickExport
curl
200

Job successfully queued.

Last updated