Download an exported file

View as MarkdownOpen in Claude
After making a request to the [/v2/workbooks/{workbookId}/export](https://help.sigmacomputing.com/reference/export-workbook) or [/v2/reports/{reportId}/export](https://help.sigmacomputing.com/reference/export-report) endpoint, you can use this endpoint to download the exported file using the queryId returned in the response. ### Usage notes - This endpoint is rate limited to 400 requests per minute. - The export must be ready to download before you can download the results. The endpoint returns an error if the query is still processing or if the `queryId` is invalid or expired. Query results are typically available for a limited time, so make sure to download query results while they are available. - Retrieve the **queryId** by making a request to the [/v2/workbooks/{workbookId}/export](https://help.sigmacomputing.com/reference/export-workbook) or [/v2/reports/{reportId}/export](https://help.sigmacomputing.com/reference/export-report) endpoint. - Specify the file format when you make the export request. You cannot specify the file format when you download the file. ### Usage scenarios - **Scheduled reporting**: Automate the downloading of reports generated on a scheduled basis. - **Data analysis**: Retrieve large sets of data for local analysis in external tools not integrated directly with Sigma. ### Best practices - Monitor the status of the export query before attempting a download to make sure it is ready. For a code example, see [Export to CSV with Date Range Parameters](https://help.sigmacomputing.com/recipes/workbook-export-to-csv-with-date-range-parameters). - Handle errors gracefully in your application, providing users with clear messages regarding the status of their requested downloads.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

queryIdstringRequired

Response

The response body.
object
OR
object
OR
object