The ClickExport endpoint schedules a job to asynchronously export clicks. It returns a URI to poll for job status updates and a URI where the exported clicks can be downloaded once the job has completed. Alternatively, enable a postback for the job completion event to be notified when your clicks data is ready to download.

Parameters

AdId (optional)

Id of the ad that was clicked. This parameter can be repeated for multiple ads.

Date (optional)

A click’s date. If left empty, the call will use today's date. Format should match 'yyyy-MM-dd'.

MediaId (optional)

The unique identifier (sometimes referred to as Partner Id) of the partner that drove the click. This parameter can be repeated for multiple partners.

UniqueClick (optional)

If the click follows IAB standards for a unique click. These standards can be found starting on page 9 of the IAB’s Click Measurement Guidelines.

ResultFormat (optional)

Pass in the query’s desired return format, either CSV, XML, or JSON. Returns CSV by default.

curl 'https://api.impact.com/Advertisers/<AccountSID>/Programs/<ProgramId>/ClickExport' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'MediaId=1207480' \
  -d 'MediaId=1207477' \
  -d 'Date=2022-07-25' \
  -d 'ResultFormat=JSON'

{
  "Status": "QUEUED",
  "QueuedUri": "/Advertisers/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f",
  "ResultUri": "/Advertisers/<AccountSID>/Jobs/d8807a9f-a5ee-4e3f-ad2b-3dfd19d1915f/Download"
}