post
https://api.sigmacomputing.com/v2/reports//export
This endpoint lets you create a file containing data exported from a report. Reports are exported as entire 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.
- Reports are exported as entire documents. You cannot export a specific page or element.
- Only PDF exports are supported. Use the
layoutparameter to specify eitherportraitorlandscapelayout. - This endpoint is rate limited to 400 requests per minute.
- For security and privacy reasons, the
queryIdused to download the exported file expires 1 hour after your request is received. You can extend this to 6 hours using theresultsValidityTimeMsparameter.
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.
