SIsigmacomputing
Reports

List scheduled report exports

This endpoint retrieves a list of all scheduled exports for a specified report. These schedules represent planned events that can trigger exports based on various conditions and timings.

Usage Notes

  • The reportId in the path parameter identifies the report whose scheduled exports are to be listed. Retrieve the reportId by calling the /v2/reports endpoint.
  • Use pagination query parameters to manage the volume of data returned by this endpoint.

Usage Scenarios

  • Schedule overview: Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a report.
  • Audit and compliance: This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.

Best Practices

  • Implement client-side handling to manage paginated data effectively, especially in cases where a report has a large number of scheduled exports.
  • Regularly audit schedules to keep them up-to-date and aligned with current workflows.
get/v2/reports/{reportId}/schedules

Request

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

Path parameters

reportIdstring required

Unique identifier of the report.

Query parameters

pagestring

Use to specify further pages using the string returned in the nextPage portion of the response.

limitnumber double

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Response

The response body.

nextPagestring nullable required

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totalnumber double

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.

Changes

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