Reports

List elements in a report page

This endpoint retrieves all elements from a specific page within a report, which lets you understand and interact with the individual components that make up the page, such as charts, tables, or controls.

Usage notes

  • Retrieve the reportId by calling the /v2/reports endpoint.
  • Retrieve the pageId by calling the /v2/reports/{reportId}/pages endpoint.
  • To retrieve elements 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

  • 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.
get/v2/reports/{reportId}/pages/{pageId}/elements

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Unique identifier of the report.

pageIdstring required

Unique identifier of the report page.

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.

tagNamestring

Specifies the version tag of the report whose elements should be listed.

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.