latestOpenAPI 3.1.02026-08-1039111206.0 KB
c53422ebb833
ClickExport
Export Clicks Asynchronously
Schedules a job to export daily clicks. It returns a URI to poll for job status updates and a URI to download the exported file once the job is complete.
get/Advertisers/{AccountSID}/Programs/{ProgramId}/ClickExport
Path parameters
AccountSIDstring required
ProgramIdinteger required
The ID of the program (campaign) to export clicks from.
Query parameters
AdIdinteger[]
ID of the ad that was clicked. Can be repeated for multiple ads.
Datestring date
The date for the clicks to be exported, in 'yyyy-MM-dd' format. Defaults to today. Only dates after April 9, 2024 are supported.
MediaIdinteger[]
The unique ID of the partner. Can be repeated for multiple partners.
UniqueClickboolean
Filter for clicks that follow IAB standards for a unique click.
ResultFormat'CSV' | 'XML' | 'JSON'
The desired file format for the export.
Response
The job has been queued successfully.