API Reference

Export Clicks

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.

🚧

Note

If you are migrating from the Clicks endpoint to the ClicksExport endpoint, please ensure that you incorporate the field name changes found in the result object.

The return object will return the fields ProgramId and ProgramName, which were previously known as CampaignId and CampaignName.

Parameters

ProgramId (optional)

Specify a Program Id (formerly known as campaign) to only return clicks for a specific Program. This parameter can be repeated for multiple Programs.

AdId (optional)

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

Date (optional)

Click date to export. Uses today's date if none is provided. Format should match 'yyyy-MM-dd'.

SubId (optional)

Only return clicks that include the specified sub ID value. This parameter can be repeated for multiple Sub IDs.

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. Set this parameter to TRUE if you want it to be active.

ResultFormat (optional)

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

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/ClickExport' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -d ‘ProgramId=123456’ \
  -d ‘Date=2022-07-25’ \
  -H 'Accept: application/json' \
  -d 'ResultFormat=JSON'

Example response

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