Reports

Export data from a report

This endpoint lets you create a file containing data exported from a report. Export the entire report or a single report page. Reports are exported as PDF documents.

Successful requests return a queryId. Use the queryId with the /v2/query/{queryId}/download endpoint to download the file when it is ready. See Download an exported file.

To export a report to a specific destination or recipient, see the /v2/reports/{reportId}/send endpoint.

Usage notes

  • Retrieve the reportId by calling the /v2/reports endpoint.
  • This endpoint is rate limited to 400 requests per minute.
  • If a page contains an expanded table, all pages of that table's data are included in the export, even if only the first page of the table is selected.
  • Only PDF exports are supported. Use the layout parameter to specify either portrait or landscape layout.
  • For security and privacy reasons, the queryId used to download the exported file expires 1 hour after your request is received. You can extend this to 6 hours using the resultsValidityTimeMs parameter.

Usage scenarios

  • Conditional report export: Based on an external set of conditions, export a report from Sigma.
  • Integration: Integrate enriched and analyzed data with other applications, providing the necessary data in a format that these applications can process.

Best practices

  • Clearly specify parameters to retrieve only the necessary data, optimizing performance and reducing network load.
post/v2/reports/{reportId}/export

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Unique identifier of the report.

Request body

OR

Response

The response body.

jobCompleteboolean required
queryIdstring required
rowsobject[]
messagestring

Changes

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