List columns for a report element

View as Markdown
This endpoint retrieves a list of columns associated with a specific element within a report. It provides metadata about each column, such as name and formula, which can be essential for understanding the data structure and for further data manipulation or analysis. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. - Retrieve the **elementId** by first calling the [/v2/reports/{reportId}/pages](listreportpages) endpoint, then calling the [/v2/reports/{reportId}/pages/{pageId}/elements](listreportpageelements) endpoint. - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error. ### Usage scenarios - **Data exploration:** Helps users 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 - Validate the **elementId** to make sure it corresponds to the correct report element before querying. - Leverage this endpoint when setting up interfaces that require specific knowledge about the data structure.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired
elementIdstringRequired

Query parameters

pageTokenstringOptional
pageSizeintegerOptional

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.