Skip to navigation
Sigma REST APIReportselements

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 endpoint.
  • Retrieve the elementId by first calling the /v2/reports/{reportId}/pages endpoint, then calling the /v2/reports/{reportId}/pages/{pageId}/elements 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.
  • To retrieve element columns from a version-tagged report, pass the tagName query parameter with the tag name. Retrieve the tag name by calling the /v2/reports endpoint and using the tags.tagName field in the response.

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
Unique identifier of the report.
elementIdstringRequired
Unique identifier of the report element.

Query parameters

pageTokenstringOptional

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeintegerOptional
Number of results to return per page, with a maximum of 1000. Defaults to 50.
tagNamestringOptional
Specifies the version tag of the report whose element columns should be listed.

Response

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

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.