Action Inquiries1

Action Updates1

Actions1

Ads1

API Submissions1

Call Data1

Catalog Items1

ClickExport1

getExport Clicks Asynchronously

Clicks1

Company Information1

Contacts1

Contracts1

Conversions1

Deals1

Deferred Deep Linking2

Exception List Items1

Exception Lists1

FTP Submissions1

Invoices1

Jobs1

Legal Entities1

Notes1

Partner Groups1

Partners1

Phone Numbers1

Product Catalogs1

Programs1

Promo Code Exception List Items1

Promo Code Exception Lists1

Promo Codes1

Report Export1

Reports1

Routing Rules1

Tasks1

Tracking1

Tracking Links1

Tracking Value Requests1

Unsubscribed Contacts1

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.

Statusstring

QueuedUristring uri-reference

ResultUristring uri-reference

ReplayUristring uri-reference

Changes

No recorded changes to this endpoint across all 1 revision of this API.