Skip to main content

Download an export file

GET 
/v1/click/exports/:id/files/:name

Streams one file of the job. It is the body of the response, never a link, and is read when you ask for it.

  • rows.csv or rows.jsonl, as the job lists them. Any other name, an evidence part (not available yet), or the other format’s file is a 404.
  • Headers. Content-Disposition: attachment, X-Content-Type-Options: nosniff, and X-Export-Rows, the number of rows the file holds.
  • A complete file. A JSONL file ends with {"type":"end","rows":N}, where N equals X-Export-Rows. If a failure interrupts the stream after it began, the connection is closed without a clean end, so a short file is always a visible error: check that your client saw the whole body, and download again.
  • Limits. A download count per file, a concurrent stream limit and a daily byte budget apply. When one is reached the answer is a 429 with Retry-After.
  • Caching. Every response, errors included, is Cache-Control: private, no-store.

Request​

Responses​

The file, streamed

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>.

    Content-Disposition
    X-Export-Rows

    The number of rows in the file

    X-Content-Type-Options