SIsigmacomputing
Reports

Add report schedule

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.
post/v2/reports/{reportId}/schedules

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Unique identifier of the report.

Request body

descriptionstring nullable

Description of the scheduled export

Response

The response body.

scheduledNotificationIdstring required

Unique identifier of the scheduled export.

reportIdstring required

Unique identifier of the report.

isSuspendedboolean required

Whether the schedule is currently suspended.

ownerIdstring required

Unique identifier of the user who owns the schedule.

lastUpdatedByUserstring required

Unique identifier of the user who last updated the schedule.

disabledAtstring date-time nullable required

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

disabledBystring nullable required

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

createdBystring required

The identifier of the user who created this object.

updatedBystring required

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

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.