> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # List report pages GET https://api.sigmacomputing.com/v2/reports/{reportId}/pages 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. Reference: https://help.sigmacomputing.com/reference/list-report-pages ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/reports/{reportId}/pages: get: operationId: listReportPages summary: List report pages description: >- 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. tags: - Reports parameters: - name: reportId in: path required: true schema: type: string - name: pageToken in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer - name: tag in: query required: false schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: '#/components/schemas/reports_listReportPages_Response_200' servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: V2ReportsReportIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: pageId: type: string description: Unique identifier of the report page. name: type: string description: Display name of the report page. hidden: type: boolean description: Whether the page is hidden from end users. required: - pageId title: >- V2ReportsReportIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems reports_listReportPages_Response_200: type: object properties: entries: type: array items: $ref: >- #/components/schemas/V2ReportsReportIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems description: Array of results returned by the endpoint nextPageToken: type: string description: >- 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.** required: - entries title: reports_listReportPages_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Response** ```json { "entries": [ { "pageId": "string", "name": "string", "hidden": true } ], "nextPageToken": "string" } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/reports/reportId/pages" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/reports/reportId/pages'; const options = {method: 'GET', headers: {Authorization: '.'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/reports/reportId/pages" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", ".") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/reports/reportId/pages") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/reports/reportId/pages") .header("Authorization", ".") .asString(); ``` ```php request('GET', 'https://api.sigmacomputing.com/v2/reports/reportId/pages', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/reports/reportId/pages"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "."] let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/reports/reportId/pages")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```