Reports
List report controls
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 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 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.
get/v2/reports/{reportId}/controls
Request
- Base URLhttps://api.sigmacomputing.com
- AuthHTTP bearer
Path parameters
reportIdstring required
Unique identifier of the report.
Query parameters
pageTokenstring
Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.
pageSizeinteger
Number of results to return per page, with a maximum of 1000. Defaults to 50.
tagNamestring
Specifies the version tag of the report whose controls should be listed.
Response
The response body.
Changes
No recorded changes to this operation across all 1 revision of this API.