> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Export a report POST https://api.sigmacomputing.com/v2/reports/{reportId}/send Content-Type: application/json Export a report to one or more specified destinations or recipients. Supported destinations include Slack channels, Google Drive, cloud storage, and webhooks. Supported recipients include an organization member, team, or email address. If you want to download a report PDF instead, see the [/v2/reports/{reportId}/export](https://help.sigmacomputing.com/reference/export-report) endpoint. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. - Only PDF exports are supported for reports. - This endpoint is rate limited to 100 requests per minute. Reference: https://help.sigmacomputing.com/reference/send-report ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/reports/{reportId}/send: post: operationId: sendReport summary: Export a report description: >- Export a report to one or more specified destinations or recipients. Supported destinations include Slack channels, Google Drive, cloud storage, and webhooks. Supported recipients include an organization member, team, or email address. If you want to download a report PDF instead, see the [/v2/reports/{reportId}/export](https://help.sigmacomputing.com/reference/export-report) endpoint. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. - Only PDF exports are supported for reports. - This endpoint is rate limited to 100 requests per minute. tags: - Reports parameters: - name: reportId in: path required: true schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: '#/components/schemas/reports_sendReport_Response_200' requestBody: description: The request body. content: application/json: schema: type: object properties: targets: type: array items: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems config: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaConfig attachments: type: array items: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItems parameters: type: object additionalProperties: type: string timeout: type: number format: double required: - targets - config - attachments servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf0Type: type: string enum: - member title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf0Type V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems0: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf0Type userId: type: string required: - type - userId title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems0 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf1Type: type: string enum: - team title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf1Type V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems1: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf1Type teamId: type: string required: - type - teamId title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems1 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf2Type: type: string enum: - email title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf2Type V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems2: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf2Type email: type: string required: - type - email title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems2 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf3Type: type: string enum: - slackChannel title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf3Type V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems3: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf3Type slackConversationId: type: string required: - type - slackConversationId title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems3 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf4Type: type: string enum: - gdrive title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf4Type V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems4: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf4Type googleDriveFolderUrl: type: string required: - type - googleDriveFolderUrl title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems4 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5Type: type: string enum: - cloud-export title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5Type V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf0Bq: type: object properties: bqDestination: type: string required: - bqDestination title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf0Bq V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport0: type: object properties: bq: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf0Bq required: - bq title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport0 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf1Sf: type: object properties: sfDestination: type: string authorization: type: string required: - sfDestination - authorization title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf1Sf V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport1: type: object properties: sf: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf1Sf required: - sf title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport1 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf2Rs: type: object properties: rsDestination: type: string authorization: type: string required: - rsDestination - authorization title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf2Rs V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport2: type: object properties: rs: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExportOneOf2Rs required: - rs title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport2 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport: oneOf: - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport0 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport1 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport2 title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems5: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5Type cloudExport: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5CloudExport required: - type - cloudExport title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems5 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6Type: type: string enum: - webhook title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6Type V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems6: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6Type webhookUrl: type: string required: - type - webhookUrl title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems6 V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems: oneOf: - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems0 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems1 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems2 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems3 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems4 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems5 - $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems6 title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaConfig: type: object properties: title: type: string messageBody: type: string includeLink: type: boolean runAsRecipient: type: boolean required: - title - messageBody title: V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaConfig V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsType: type: string enum: - PDF title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsType V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsLayout: type: string enum: - portrait - landscape title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsLayout V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions: type: object properties: type: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsType layout: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsLayout scaleFactor: type: number format: double required: - type title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItems: type: object properties: formatOptions: $ref: >- #/components/schemas/V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions required: - formatOptions title: >- V2ReportsReportIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItems reports_sendReport_Response_200: type: object properties: {} title: reports_sendReport_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json { "targets": [ { "email": "test@example.com", "type": "email" } ], "config": { "title": "My report", "messageBody": "Please find the report attached.", "includeLink": true }, "attachments": [ { "formatOptions": { "type": "PDF" } } ] } ``` **Response** ```json {} ``` **SDK Code** ```python Export a report as PDF via email import requests url = "https://api.sigmacomputing.com/v2/reports/reportId/send" payload = { "targets": [ { "email": "test@example.com", "type": "email" } ], "config": { "title": "My report", "messageBody": "Please find the report attached.", "includeLink": True }, "attachments": [{ "formatOptions": { "type": "PDF" } }] } headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Export a report as PDF via email const url = 'https://api.sigmacomputing.com/v2/reports/reportId/send'; const options = { method: 'POST', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{"targets":[{"email":"test@example.com","type":"email"}],"config":{"title":"My report","messageBody":"Please find the report attached.","includeLink":true},"attachments":[{"formatOptions":{"type":"PDF"}}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Export a report as PDF via email package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/reports/reportId/send" payload := strings.NewReader("{\n \"targets\": [\n {\n \"email\": \"test@example.com\",\n \"type\": \"email\"\n }\n ],\n \"config\": {\n \"title\": \"My report\",\n \"messageBody\": \"Please find the report attached.\",\n \"includeLink\": true\n },\n \"attachments\": [\n {\n \"formatOptions\": {\n \"type\": \"PDF\"\n }\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Export a report as PDF via email require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/reports/reportId/send") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{\n \"targets\": [\n {\n \"email\": \"test@example.com\",\n \"type\": \"email\"\n }\n ],\n \"config\": {\n \"title\": \"My report\",\n \"messageBody\": \"Please find the report attached.\",\n \"includeLink\": true\n },\n \"attachments\": [\n {\n \"formatOptions\": {\n \"type\": \"PDF\"\n }\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java Export a report as PDF via email import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.sigmacomputing.com/v2/reports/reportId/send") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{\n \"targets\": [\n {\n \"email\": \"test@example.com\",\n \"type\": \"email\"\n }\n ],\n \"config\": {\n \"title\": \"My report\",\n \"messageBody\": \"Please find the report attached.\",\n \"includeLink\": true\n },\n \"attachments\": [\n {\n \"formatOptions\": {\n \"type\": \"PDF\"\n }\n }\n ]\n}") .asString(); ``` ```php Export a report as PDF via email request('POST', 'https://api.sigmacomputing.com/v2/reports/reportId/send', [ 'body' => '{ "targets": [ { "email": "test@example.com", "type": "email" } ], "config": { "title": "My report", "messageBody": "Please find the report attached.", "includeLink": true }, "attachments": [ { "formatOptions": { "type": "PDF" } } ] }', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Export a report as PDF via email using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/reports/reportId/send"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"targets\": [\n {\n \"email\": \"test@example.com\",\n \"type\": \"email\"\n }\n ],\n \"config\": {\n \"title\": \"My report\",\n \"messageBody\": \"Please find the report attached.\",\n \"includeLink\": true\n },\n \"attachments\": [\n {\n \"formatOptions\": {\n \"type\": \"PDF\"\n }\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Export a report as PDF via email import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [ "targets": [ [ "email": "test@example.com", "type": "email" ] ], "config": [ "title": "My report", "messageBody": "Please find the report attached.", "includeLink": true ], "attachments": [["formatOptions": ["type": "PDF"]]] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/reports/reportId/send")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```