Sigma Computing

Sigma Computing Reports API

The Reports API from Sigma Computing — 26 operation(s) for reports.

GitHub OpenAPI

Operations 29

GET /v2/reports List reports #
POST /v2/reports Create a report #
GET /v2/reports/{reportId} Get a report #
GET /v2/reports/{reportId}/columns List columns for all elements in a report #
GET /v2/reports/{reportId}/controls List report controls #
POST /v2/reports/{reportId}/copy Duplicate a report #
GET /v2/reports/{reportId}/elements List elements in a report #
GET /v2/reports/{reportId}/elements/{elementId}/columns List columns for a report element #
GET /v2/reports/{reportId}/elements/{elementId}/query Get the SQL query for a report element #
POST /v2/reports/{reportId}/export Export data from a report #
POST /v2/reports/{reportId}/grants Grant permissions on a report to users or teams #
DELETE /v2/reports/{reportId}/grants/{grantId} Delete a report grant #
GET /v2/reports/{reportId}/lineage List lineage for a report #
GET /v2/reports/{reportId}/lineage/elements/{elementId} List lineage of a report element #
GET /v2/reports/{reportId}/pages List report pages #
GET /v2/reports/{reportId}/pages/{pageId}/elements List elements in a report page #
GET /v2/reports/{reportId}/queries List SQL queries in a report #
GET /v2/reports/{reportId}/schedules List scheduled report exports #
POST /v2/reports/{reportId}/schedules Add report schedule #
PATCH /v2/reports/{reportId}/schedules/{scheduleId} Update a report schedule #
DELETE /v2/reports/{reportId}/schedules/{scheduleId} Delete a scheduled export for a report #
POST /v2/reports/{reportId}/send Export a report #
GET /v2/reports/{reportId}/sources List report sources #
POST /v2/reports/{reportId}/swapSources Swap report data sources #
POST /v2/reports/{reportId}/tag/{versionTag}/copy Duplicate a tagged report #
GET /v2/reports/{reportId}/tags List tags for a report #
DELETE /v2/reports/{reportId}/tags/{tagId} Remove a tag from a report #
GET /v2/reports/{reportId}/version-history Get version history for a report #
POST /v2/reports/tag Tag a report #

Documentation

📖
Documentation
https://help.sigmacomputing.com/docs/get-started-with-sigmas-api
📖
APIReference
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
GettingStarted
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/authentication/sigma-computing-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/rate-limits/sigma-computing-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-reports-api-openapi.yml

Other Resources

🔗
Examples
https://help.sigmacomputing.com/recipes
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/scopes/sigma-computing-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conventions/sigma-computing-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/errors/sigma-computing-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/data-model/sigma-computing-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/asyncapi/sigma-computing-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conformance/sigma-computing-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/lifecycle/sigma-computing-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sigma-computing-reports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sigma-computing-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Reports API
  version: '1.0'
  description: 'Operations tagged reports across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
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
tags:
- name: reports
paths:
  /v2/reports:
    get:
      summary: List reports
      description: "This endpoint retrieves a list of all available reports.\n\nAvailable reports include any reports in your My Documents folder and any reports you have access to.\n\nUsers with the Admin account type can optionally retrieve all reports in the organization.\n\n### Usage notes\nThis endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.\n\n### Pagination\n\nThis endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:\n\n- hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.\n- total: The total number of entries available across all pages.\n- nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.\n\n#### Example response for pagination\n```json\n{\n  \"hasMore\": true,\n  \"total\": 104,\n  \"nextPage\": \"50\"\n}\n```\n\nTo 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.\n\n### Usage scenarios\n- **Report navigation**: Allows users to view their collection of reports and locate ones they need.\n- **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."
      parameters:
      - name: page
        schema:
          type: string
          description: Use to specify further pages using the string returned in the nextPage portion of the response.
          title: Page
        in: query
      - name: limit
        schema:
          type: number
          description: 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.
          title: Limit
        in: query
      - name: excludeTags
        schema:
          type: boolean
        in: query
      - name: skipPermissionCheck
        schema:
          type: boolean
          description: Only available to Sigma admins. Return all reports regardless of whether the user has access.
        in: query
      - name: isArchived
        schema:
          type: boolean
          description: Return archived reports.
        in: query
      operationId: listReports
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - entries
                  - nextPage
                  properties:
                    entries:
                      type: array
                      items:
                        allOf:
                        - type: object
                          required:
                          - reportId
                          - reportUrlId
                          - name
                          - url
                          - path
                          - latestVersion
                          - ownerId
                          properties:
                            reportId:
                              type: string
                              description: Unique identifier of the report.
                              title: Report ID
                            reportUrlId:
                              type: string
                            name:
                              type: string
                            url:
                              type: string
                            path:
                              type: string
                            latestVersion:
                              type: number
                            ownerId:
                              type: string
                        - type: object
                          required:
                          - createdBy
                          - updatedBy
                          - createdAt
                          - updatedAt
                          properties:
                            createdBy:
                              type: string
                              description: The identifier of the user who created this object.
                            updatedBy:
                              type: string
                              description: The identifier of the user or process that last updated this object.
                            createdAt:
                              type: string
                              format: date-time
                              description: When the object was created.
                            updatedAt:
                              type: string
                              format: date-time
                              description: When the object was last updated.
                        - type: object
                          properties:
                            isArchived:
                              type: boolean
                            tags:
                              type: array
                              items:
                                allOf:
                                - type: object
                                  required:
                                  - versionTagId
                                  - tagName
                                  - sourceVersion
                                  - taggedAt
                                  properties:
                                    versionTagId:
                                      type: string
                                      description: Unique identifier of the tag.
                                      title: Tag ID
                                    tagName:
                                      type: string
                                    sourceVersion:
                                      type: number
                                    taggedAt:
                                      type: string
                                      format: date-time
                                - type: object
                                  required:
                                  - taggedReportId
                                  properties:
                                    taggedReportId:
                                      type: string
                                      description: Unique identifier of the tagged report.
                                      title: Report ID
                            description:
                              type: string
                      description: Array of results returned by the endpoint
                    nextPage:
                      type:
                      - string
                      - 'null'
                      description: 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`.
                - type: object
                  properties:
                    total:
                      type: number
                      description: Total number of results. Useful to determine if there is a need to paginate.
                    hasMore:
                      type: boolean
                      description: '**[Deprecated]** Indicates whether more results are available.'
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - reports
      security:
      - oauth2: []
    post:
      summary: Create a report
      description: 'This endpoint lets you create an empty report in Sigma, enabling you to build presentation-ready documents for sharing insights with stakeholders.


        ### Usage notes

        - The **name** parameter is required to provide a name for the new report.

        - Use the **folderId** to specify the folder in which to save the report. Retrieve the **folderId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.


        ### Usage scenarios

        - **Reliable export formatting**: Users can quickly generate a new blank report to create predictable, paginated exports.


        ### Best practices

        - **Naming conventions**: Establish and follow consistent naming conventions for reports to make it easier to manage and identify them within larger projects.

        - **Folder organization**: Use the **folderId** to organize reports into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams.

        - **Access control**: Regularly review and manage access permissions for new reports, ensuring that only the appropriate personnel can view or edit sensitive data.'
      parameters: []
      operationId: createReport
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              allOf:
              - type: object
                required:
                - folderId
                - name
                properties:
                  folderId:
                    type: string
                    description: ID of the folder where the new report is created.
                    title: Folder ID
                  name:
                    type: string
                    description: Name of the new report.
                    title: Report Name
              - type: object
                properties:
                  description:
                    type: string
                    description: Description of the report.
                    title: Description
            examples:
              Create a blank report:
                value:
                  folderId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff
                  name: My new blank Report
                  description: This is a description
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - reportId
                  - reportUrlId
                  - name
                  - url
                  - path
                  - latestVersion
                  - ownerId
                  properties:
                    reportId:
                      type: string
                      description: Unique identifier of the report.
                      title: Report ID
                    reportUrlId:
                      type: string
                    name:
                      type: string
                    url:
                      type: string
                    path:
                      type: string
                    latestVersion:
                      type: number
                    ownerId:
                      type: string
                - type: object
                  required:
                  - createdBy
                  - updatedBy
                  - createdAt
                  - updatedAt
                  properties:
                    createdBy:
                      type: string
                      description: The identifier of the user who created this object.
                    updatedBy:
                      type: string
                      description: The identifier of the user or process that last updated this object.
                    createdAt:
                      type: string
                      format: date-time
                      description: When the object was created.
                    updatedAt:
                      type: string
                      format: date-time
                      description: When the object was last updated.
                - type: object
                  properties:
                    isArchived:
                      type: boolean
                    tags:
                      type: array
                      items:
                        allOf:
                        - type: object
                          required:
                          - versionTagId
                          - tagName
                          - sourceVersion
                          - taggedAt
                          properties:
                            versionTagId:
                              type: string
                              description: Unique identifier of the tag.
                              title: Tag ID
                            tagName:
                              type: string
                            sourceVersion:
                              type: number
                            taggedAt:
                              type: string
                              format: date-time
                        - type: object
                          required:
                          - taggedReportId
                          properties:
                            taggedReportId:
                              type: string
                              description: Unique identifier of the tagged report.
                              title: Report ID
                    description:
                      type: string
              examples:
                Response Example:
                  value:
                    reportId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    reportUrlId: 57a96EMo3GVJG73179MV2l
                    name: My new blank Report
                    url: https://example.com/reports/88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    path: folder1
                    latestVersion: 1
                    isArchived: false
                    createdAt: '2022-01-01T00:00:00.000Z'
                    createdBy: user1
                    updatedAt: '2022-01-01T00:00:00.000Z'
                    updatedBy: user1
                    ownerId: user1
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - reports
      security:
      - oauth2: []
    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
  /v2/reports/{reportId}:
    get:
      summary: Get a report
      description: 'This endpoint retrieves a report by its unique identifier (`reportId`). It provides detailed information about the report, including its name, URL, path, and other metadata.


        ### Usage notes

        - The **reportId** parameter must be a valid UUID that uniquely identifies the report. Invalid or nonexistent IDs return an error. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.


        ### Usage scenarios

        - **Report search**: Allows users to view all of their reports and locate a specific one, as well as filter by criteria such as if it is archived.

        - **Data retrieval**: Developers can use this endpoint to programmatically retrieve details about a specific report to display its content or metadata in a custom user interface.

        - **Integration**: Use this endpoint for integrations where other systems need to fetch report details based on an ID provided through another interface or workflow.


        ### Best practices

        - Validate the **reportId** on the client side before making a request to avoid unnecessary server load caused by invalid requests.'
      parameters:
      - name: reportId
        schema:
          type: string
          description: Unique identifier of the report.
          title: Report ID
        in: path
        required: true
      operationId: getReport
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - reportId
                  - reportUrlId
                  - name
                  - url
                  - path
                  - latestVersion
                  - ownerId
                  properties:
                    reportId:
                      type: string
                      description: Unique identifier of the report.
                      title: Report ID
                    reportUrlId:
                      type: string
                    name:
                      type: string
                    url:
                      type: string
                    path:
                      type: string
                    latestVersion:
                      type: number
                    ownerId:
                      type: string
                - type: object
                  required:
                  - createdBy
                  - updatedBy
                  - createdAt
                  - updatedAt
                  properties:
                    createdBy:
                      type: string
                      description: The identifier of the user who created this object.
                    updatedBy:
                      type: string
                      description: The identifier of the user or process that last updated this object.
                    createdAt:
                      type: string
                      format: date-time
                      description: When the object was created.
                    updatedAt:
                      type: string
                      format: date-time
                      description: When the object was last updated.
                - type: object
                  properties:
                    isArchived:
                      type: boolean
                    tags:
                      type: array
                      items:
                        allOf:
                        - type: object
                          required:
                          - versionTagId
                          - tagName
                          - sourceVersion
                          - taggedAt
                          properties:
                            versionTagId:
                              type: string
                              description: Unique identifier of the tag.
                              title: Tag ID
                            tagName:
                              type: string
                            sourceVersion:
                              type: number
                            taggedAt:
                              type: string
                              format: date-time
                        - type: object
                          required:
                          - taggedReportId
                          properties:
                            taggedReportId:
                              type: string
                              description: Unique identifier of the tagged report.
                              title: Report ID
                    description:
                      type: string
              examples:
                Response Example:
                  value:
                    reportId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    reportUrlId: 57a96EMo3GVJG73179MV2l
                    name: My report
                    url: https://example.com/reports/88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    path: folder1
                    latestVersion: 1
                    createdAt: '2022-01-01T00:00:00.000Z'
                    createdBy: user1
                    updatedAt: '2023-01-01T00:00:00.000Z'
                    updatedBy: user2
                    ownerId: user1
                    isArchived: false
                    tags:
                    - versionTagId: 11112222-3333-4444-5555-666677778888
                      tagName: Production
                      sourceVersion: 3
                      taggedReportId: aaaabbbb-cccc-dddd-eeee-ffff00001111
                      taggedAt: '2024-06-15T12:00:00.000Z'
                    description: Describe my report
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - reports
      security:
      - oauth2: []
    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
  /v2/reports/{reportId}/columns:
    get:
      summary: List columns for all elements in a report
      description: 'This endpoint retrieves all columns in a report for all data elements in the report.


        ### Usage notes

        - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.


        ### Usage scenarios

        - **Data exploration:** Enable users to explore the data structure of a report element, facilitating deeper analysis and understanding.

        - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.


        ### Best practices

        - Use this endpoint when setting up interfaces that require specific knowledge about the data structure.'
      parameters:
      - name: reportId
        schema:
          type: string
          description: Unique identifier of the report.
          title: Report ID
        in: path
        required: true
      - name: pageToken
        schema:
          type: string
          description: Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.
          title: Page token
        in: query
      - name: pageSize
        schema:
          type: integer
          description: Number of results to return per page, with a maximum of 1000. Defaults to 50.
          title: Page size
        in: query
      operationId: listReportColumns
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - entries
                  properties:
                    entries:
                      type: array
                      items:
                        type: object
                        required:
                        - columnId
                        - name
                        - formula
                        - type
                        - elementId
                        properties:
                          columnId:
                            type: string
                            description: Column ID
                          name:
                            type: string
                            description: Column name
                          formula:
                            type: string
                            description: Column formula or source column reference.
                          type:
                            type: object
                            description: The column's data type, represented as a recursive type object.
                          elementId:
                            type: string
                            description: Element ID
                      description: Array of results returned by the endpoint
                      title: Result entries
                - type: object
                  properties:
                    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.**'
                      title: Next page token
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - reports
      security:
      - oauth2: []
    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
  /v2/reports/{reportId}/controls:
    get:
      summary: List report controls
      description: 'This endpoint retrieves all control elements within a specific report. Control elements provide predefined interactions to users viewing a report, such as inputs that modify data or selections to filter data.


        ### Usage notes

        - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.

        - To retrieve controls from a version-tagged report, pass the tag name in the  `tagName` query parameter. 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

        - **Dynamic data interaction:** Allows users to interact dynamically with the data presented in the report through various control mechanisms.

        - **Custom reporting:** Enables the creation of customizable reports where end users can adjust parameters to filter and sort data according to their requirements.


        ### Best practices

        - Ensure proper access controls are set to manage who can view or interact with the controls to prevent unauthorized data manipulation.

        - Use detailed and descriptive names for controls to facilitate easier identification and use by end users.'
      parameters:
      - name: reportId
        schema:
          type: string
          description: Unique identifier of the report.
          title: Report ID
        in: path
        required: true
      - name: pageToken
        schema:
          type: string
          description: Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.
          title: Page token
        in: query
      - name: pageSize
        schema:
          type: integer
          description: Number of results to return per page, with a maximum of 1000. Defaults to 50.
          title: Page size
        in: query
      - name: tagName
        schema:
          type: string
          description: Specifies the version tag of the report whose controls should be listed.
          title: Version tag
        in: query
      operationId: listReportC

# --- truncated at 32 KB (1020 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-reports-api-openapi.yml