Add report schedule

POST

/v2/reports/:reportId/schedules

POST

/v2/reports/:reportId/schedules

$ curl -X POST https://api.sigmacomputing.com/v2/reports/reportId/schedules \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "target": [
>     {}
>   ],
>   "schedule": {
>     "cronSpec": "string",
>     "timezone": "string"
>   },
>   "configV2": {
>     "title": "string",
>     "messageBody": "string",
>     "exportAttachments": [
>       {
>         "formatOptions": {
>           "type": "PDF"
>         }
>       }
>     ]
>   }
> }'

200Successful

1 {
2   "scheduledNotificationId": "string",
3   "reportId": "string",
4   "schedule": {
5     "cronSpec": "string",
6     "timezone": "string"
7   },
8   "configV2": {
9     "title": "string",
10     "messageBody": "string",
11     "notificationAttachments": [
12       {
13         "formatOptions": {
14           "layout": "portrait",
15           "scaleFactor": 1.1,
16           "type": "PDF"
17         },
18         "workbookExportSource": {
19           "type": "report"
20         }
21       }
22     ],
23     "includeLink": true,
24     "runAsRecipient": true,
25     "attachmentSettings": {
26       "mergePdfAttachments": true,
27       "zipAttachments": true
28     },
29     "conditionOptions": {
30       "type": "always"
31     },
32     "alertConfig": {
33       "window": "alltime",
34       "volume": 1.1
35     },
36     "notificationName": "string",
37     "reportSettings": {
38       "filters": [
39         {
40           "id": "string",
41           "filterStr": "string"
42         }
43       ],
44       "variableValues": {}
45     },
46     "dynamicExportSettings": {
47       "variables": {}
48     },
49     "dynamicRecipientSettings": {
50       "sourceNodeId": "string",
51       "recipientColumnId": "string"
52     },
53     "rowLimit": 1.1,
54     "reportVariant": {
55       "tagId": "string"
56     },
57     "embedOpts": {
58       "embedId": "string",
59       "evalConnectionId": "string"
60     }
61   },
62   "isSuspended": true,
63   "ownerId": "string",
64   "lastUpdatedByUser": "string",
65   "disabledAt": "2024-01-15T09:30:00Z",
66   "disabledBy": "string",
67   "createdBy": "string",
68   "updatedBy": "string",
69   "createdAt": "2024-01-15T09:30:00Z",
70   "updatedAt": "2024-01-15T09:30:00Z"
71 }

This endpoint allows you to create a scheduled export of a report. Scheduled exports are triggered by specific conditions or timings.

Usage notes

Retrieve the reportId by calling the /v2/reports endpoint.
Retrieve relevant IDs based on the export contents and destination:
- To export to one or more Sigma users, retrieve the memberId by calling the /v2/members endpoint.
- To export to one or more Sigma teams, retrieve the teamId by calling the /v2/teams endpoint.
Reports can only be exported as entire PDFs. Exporting a specific page or element is not supported.
If you want to impersonate a user when scheduling a report export, use the /v2/auth/token endpoint.

Usage scenarios

Periodic reporting: Use this endpoint to trigger routine report exports at specific intervals (such as weekly or monthly) or when specific business conditions are met (such as specific sales targets or usage thresholds).

Best practices

Regularly review and audit schedules to ensure unnecessary or expensive schedules are not being added.

This endpoint allows you to create a scheduled export of a report. Scheduled exports are triggered by specific conditions or timings. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. - Retrieve relevant IDs based on the export contents and destination: - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint. - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint. - Reports can only be exported as entire PDFs. Exporting a specific page or element is not supported. - If you want to impersonate a user when scheduling a report export, use the [/v2/auth/token](https://help.sigmacomputing.com/reference/post-token) endpoint. ### Usage scenarios - **Periodic reporting**: Use this endpoint to trigger routine report exports at specific intervals (such as weekly or monthly) or when specific business conditions are met (such as specific sales targets or usage thresholds). ### Best practices - Regularly review and audit schedules to ensure unnecessary or expensive schedules are not being added.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired

Request

The request body.

targetlist of objectsRequired

One or more targets to send the report to.

scheduleobjectRequired

When to send the report export.

configV2objectRequired

Configuration settings for the export schedule.

descriptionstring or nullOptional

Description of the scheduled export

Response

The response body.

scheduledNotificationIdstring

Unique identifier of the scheduled export.

reportIdstring

Unique identifier of the report.

scheduleobject

configV2object

isSuspendedboolean

Whether the schedule is currently suspended.

ownerIdstring

Unique identifier of the user who owns the schedule.

lastUpdatedByUserstring

Unique identifier of the user who last updated the schedule.

disabledAtdatetime or null

Timestamp when the schedule was disabled, or null if the schedule is active.

disabledBystring or null

Unique identifier of the member who disabled the schedule, or null if the schedule is active.

createdBystring

The identifier of the user who created this object.

updatedBystring

The identifier of the user or process that last updated this object.

createdAtdatetime

When the object was created.

updatedAtdatetime

When the object was last updated.