List elements in a report

View as Markdown
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](https://help.sigmacomputing.com/reference/list-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](https://help.sigmacomputing.com/reference/list-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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired

Query parameters

pageTokenstringOptional
pageSizeintegerOptional
tagNamestringOptional

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPageTokenstring

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.