SIsigmacomputing
Reports

List columns for all elements in a report

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 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.
get/v2/reports/{reportId}/columns

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP 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.

Response

The response body.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.