Skip to main content

Create an export

POST 
/v1/click/exports

Freezes the acceptances that match the filters and returns the export job. The rows are not copied: the job records which acceptances it covers, so a download reads exactly those, whenever you fetch it.

  • Scope. click:export, a standalone scope: click:admin does not include it.
  • Window. filters.from and filters.to are required, ISO 8601 with an offset, and at most 366 days apart.
  • Format. csv or jsonl, one row per acceptance, with the same columns or keys either way. A row from a record made before evidence files existed says evidenceFiles: not_exported_v1.
  • Signer filter. filters.signerRef is an exact match and is never stored or returned: the job shows only signerRefFilter: true.
  • Restricted records are left out and counted in restrictedExcluded, unless you pass restrictedAccess with a reason and an id-only claim reference.
  • Evidence files. includeEvidence: true is a 400 for now.
  • Limits. A job that would be too large is a 422 and counts against the daily limit of creates. A limit reached is a 429 with Retry-After.
  • Idempotency. X-Idempotency-Key is scoped to your OAuth client and the request body: the same key with the same body answers the stored job, and the same key with another body, or from another client, creates a new job.
  • Caching. Every response, errors included, is Cache-Control: private, no-store.

Request​

Responses​

The job. Location is its URL. A replay of the same X-Idempotency-Key and body answers the stored body without Location.

Response Headers
    X-Request-Id

    Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.

    traceparent

    W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.

    Location

    The URL of the job

    Cache-Control