Reports
List elements in a report
This endpoint retrieves all elements in a report, which lets you understand and interact with the individual components that make up the report, such as charts, tables, or controls.
Usage notes
- Retrieve the reportId by calling the /v2/reports endpoint.
- To retrieve elements from version-tagged reports, pass the tagName in the query parameters with the tag name. Retrieve the tag name by calling the /v2/reports endpoint and using the tags.name included in the response for a given report.
Usage scenarios
- Detailed analysis: Developers and users can retrieve specific elements for detailed data analysis or further manipulation.
- Interface customization: Allows for dynamic interface construction where users can choose which elements to display or interact with.
Best practices
- Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.
- Validate both the reportId and pageId to ensure they correspond to valid, accessible resources before making API calls.
get/v2/reports/{reportId}/elements
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 elements should be listed.
Response
The response body.
Changes
No recorded changes to this operation across all 1 revision of this API.