Reports

List reports

This endpoint retrieves a list of all available reports.

Available reports include any reports in your My Documents folder and any reports you have access to.

Users with the Admin account type can optionally retrieve all reports in the organization.

Usage notes

This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.

Pagination

This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:

  • hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.
  • total: The total number of entries available across all pages.
  • nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.

Example response for pagination

{
  "hasMore": true,
  "total": 104,
  "nextPage": "50"
}

To request additional pages, include the nextPage option in your next request as the value of the page option. Repeat this process until nextPage returns null, indicating that there are no more pages to return.

Usage scenarios

  • Report navigation: Allows users to view their collection of reports and locate ones they need.
  • Integration points: Useful for building integrations that need to present users with a list of their available reports, such as in custom applications using embeds.
get/v2/reports

Request

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

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.

excludeTagsboolean
skipPermissionCheckboolean

Only available to Sigma admins. Return all reports regardless of whether the user has access.

isArchivedboolean

Return archived reports.

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.