Sigma REST APIReportspages

List report pages

View as Markdown
This endpoint retrieves a list of all pages contained within a specified report. It is useful for applications needing to display an overview or navigate through different pages of a report. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. - To retrieve pages from a version-tagged report, pass the `tag` query parameter with the tag name. Retrieve the tag name by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint and using the `tags.tagName` field in the response. ### Usage scenarios - **Navigation:** Helps users and applications navigate through different pages of a report efficiently. - **Content discovery:** Allows users to quickly view and access the variety of pages contained within a report. ### Best practices - Utilize pagination to manage and streamline the retrieval of large numbers of pages. - Ensure that users or systems querying this endpoint have appropriate permissions to access the report's content.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired
Unique identifier of the report.

Query parameters

pageTokenstringOptional

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeintegerOptional
Number of results to return per page, with a maximum of 1000. Defaults to 50.
tagstringOptional
Specifies the version tag of the report whose pages should be listed.

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPageTokenstringOptional

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.