Sigma REST APIReports{reportId}

List columns for all elements in a report

View as Markdown
This endpoint retrieves all columns in a report for all data elements in the report. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. ### Usage scenarios - **Data exploration:** Enable users to 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 - Use 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.

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.

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.