Sigma Computing Documentation

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 layout parameter to specify either portrait or landscape layout.
This endpoint is rate limited to 400 requests per minute.
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.

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](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. - Reports are exported as entire documents. You cannot export a specific page or element. - Only PDF exports are supported. Use the `layout` parameter to specify either `portrait` or `landscape` layout. - This endpoint is rate limited to 400 requests per minute. - 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.

formatobjectRequired

parametersmap from strings to stringsOptional

Syntax { control-id: control-value }

The control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.

Values can take multiple forms, depending on the data type of the control:

Boolean

Single value: “true” | “false” | “:null”
List of Boolean: “true,false,:null” (No space after the comma.)

Number

Single value: “10.54”, “:null”
List of values: “10.54,23.45,:null” (No space after the comma.)
Range of numbers: “min:10.54,max:23.45” (No space after the comma or colon.)

Text

Single value: “some-text” | “:null” | “:empty”
List of values: “some-text,more-text,:null,:empty” (No space after the comma.)

Date

All dates use UTC time zones.

Fixed date using ISO-6801 format: “2022-01-01T01:01:59” | “:null”
- Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):
  - %Y-%m-%d
  - %Y-%m-%dT%H:%M
  - %Y-%m-%dT%H:%M:%S
List of fixed dates: “2022-01-01T01:01:59,2022-02-02T02:02:59,:null”
Relative date: “prior-day-3” | “next-day-3”
- Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]
Date range: “min:2022-01-01T01:01:59,max:next-day-3” (No spaces after the comma or colon.)
- Leave max blank for “on or after” and min blank for “on or before”, for example:
  - “Date-Range”: “min:2020-04-01,max:”
  - “Date-Range”: “min:,max:next-day-3”

Notes

“:null” is a special value that denotes the null primitive value.
“:empty” is a special value that denotes the empty string "".

Use URL encoding to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.

For example: “New York, NY,Boston, MA” can be encoded as:

“New%20York%2C%20NY,Boston%2C%20MA”

Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value. **Syntax** { control-id: control-value } The control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control. Values can take multiple forms, depending on the data type of the control: **Boolean** - Single value: "true" | "false" | ":null" - List of Boolean: "true,false,:null" (No space after the comma.) **Number** - Single value: "10.54", ":null" - List of values: "10.54,23.45,:null" (No space after the comma.) - Range of numbers: "min:10.54,max:23.45" (No space after the comma or colon.) **Text** - Single value: "some-text" | ":null" | ":empty" - List of values: "some-text,more-text,:null,:empty" (No space after the comma.) **Date** All dates use UTC time zones. - Fixed date using ISO-6801 format: "2022-01-01T01:01:59" | ":null" - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds): - %Y-%m-%d - %Y-%m-%dT%H:%M - %Y-%m-%dT%H:%M:%S - List of fixed dates: "2022-01-01T01:01:59,2022-02-02T02:02:59,:null" - Relative date: "prior-day-3" | "next-day-3" - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number] - Date range: "min:2022-01-01T01:01:59,max:next-day-3" (No spaces after the comma or colon.) - Leave max blank for "on or after" and min blank for "on or before", for example: - "Date-Range": "min:2020-04-01,max:" - "Date-Range": "min:,max:next-day-3" **Notes** - ":null" is a special value that denotes the null primitive value. - ":empty" is a special value that denotes the empty string "". Use [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators. For example: "New York, NY,Boston, MA" can be encoded as: "New%20York%2C%20NY,Boston%2C%20MA"

timeoutdoubleOptional

tagstringOptional

Specifies the version tag of the report to be exported.

Response

The response body.

jobCompleteboolean

queryIdstring

rowslist of maps from strings to any

messagestring