post
https://api.sigmacomputing.com/v2/reports//schedules
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.