Export data from a report

View as Markdown
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](https://help.sigmacomputing.com/reference/download-query) endpoint to download the file when it is ready. See [Download an exported file](https://help.sigmacomputing.com/reference/download-query). To export a report to a specific destination or recipient, see the [/v2/reports/{reportId}/send](https://help.sigmacomputing.com/reference/send-report) endpoint. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired

Request

The request body.
Export an entire reportobjectRequired
OR
Export a page of a reportobjectRequired

Response

The response body.
jobCompleteboolean
queryIdstring
rowslist of maps from strings to anyOptional
messagestringOptional