Export a report

POST

/v2/reports/:reportId/send

If you want to download a report PDF instead, see the /v2/reports/{reportId}/export endpoint.

Usage notes

Retrieve the reportId by calling the /v2/reports endpoint.
Only PDF exports are supported for reports.
This endpoint is rate limited to 100 requests per minute.

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired

Request

The request body.

targetslist of objectsRequired

configobjectRequired

attachmentslist of objectsRequired

parametersmap from strings to stringsOptional

timeoutdoubleOptional

Response

The response body.

$	curl -X POST https://api.sigmacomputing.com/v2/reports/reportId/send \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"targets": [
>	{
>	"email": "test@example.com",
>	"type": "email"
>	}
>	],
>	"config": {
>	"title": "My report",
>	"messageBody": "Please find the report attached.",
>	"includeLink": true
>	},
>	"attachments": [
>	{
>	"formatOptions": {
>	"type": "PDF"
>	}
>	}
>	]
>	}'