Exports

Start a click export

Starts a background job that exports click rows for the organization, or for one link. The export is a snapshot: it holds the clicks committed when the job was cut. Requires an API key with the analytics:read or links:read scope. SDK keys are refused. Poll the job with GET /exports/{id}, then download the file.

post/exports

Request

  • Base URL: https://api.warplink.app/v1
  • URL: https://api.warplink.app/v1/exports
  • Auth: HTTP bearer

Request body

sincestring date-time required

Start of the window, inclusive.

untilstring date-time required

End of the window, exclusive. Must be after since.

link_idstring uuid

Export the clicks of one link. Omit to export the whole organization.

job_idstring uuid

A job id you generate. Repeating the request with the same id and body returns the same job.

Response

The job was created

Changes

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