---
title: "List report controls"
method: GET
path: "/v2/reports/{reportId}/controls"
tags: ["Reports"]
---

# List report controls

`GET /v2/reports/{reportId}/controls`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/reports/{reportId}/controls`
- Auth: HTTP bearer

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.

## Path parameters

- `reportId` string, required

## Query parameters

- `pageToken` string
- `pageSize` integer
- `tagName` string

## Response `200`

The response body.

- ReportsListReportControlsResponse200
  - `entries` V2ReportsReportIdControlsGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `name` string, required
    - `valueType` union, required: Value of the control
      - 'boolean'
      - 'number'
      - 'text'
      - 'date'
      - 'number-list'
      - 'text-list'
      - 'date-list'
      - 'boolean-list'
      - 'date-range'
      - 'number-range'
      - 'date-null'
      - 'number-null'
      - 'text-null'
      - 'boolean-null'
  - `nextPageToken` string: 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.**

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)