Skip to main content

Get a report download URL

GET 
/v2/report/:job_id/download

Get a short-lived URL to a job's report archive.

Returns a small JSON body pointing at the archive rather than the archive itself, so large reports never travel through the API gateway (which buffers response bodies against a size cap and faults with protocol.http.TooBigBody).

Parameters:

  • job_id - The job UUID
  • file_format - The file format (CSV, JSON, or ALL)

Returns:

  • filename - Suggested filename for the report archive
  • download_url - Short-lived URL for downloading the report archive. Navigate to it (e.g. window.location.href = url) rather than fetch-ing it. The URL already carries the attachment filename, so the browser downloads the file without leaving the page, and it expires shortly after it is issued.

Raises:

  • ForbiddenError: If report is partially complete and locked
  • NotFoundError: If the job or its report file does not exist

Request​

Responses​

Successful Response