Get the SQL query for a report element
This endpoint retrieves the SQL query associated with a specific element in a report. It allows users to view and understand how the data for that element is being processed and transformed.
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.
Usage scenarios
- Development and debugging: Provides developers and analysts with the ability to retrieve and review the SQL code behind report elements, facilitating troubleshooting and enhancements.
- Educational insight: Useful for training purposes or for users learning to understand the impact of various transformations and filters applied within their reports.
Best practices
- Ensure proper access controls are in place to manage who can view potentially sensitive query information.
- Use this endpoint as part of a regular review process to ensure that all queries are optimized and up to date with current data schemas.
Authentication
AuthorizationBearer
OAuth authentication of the form <token>.
Path parameters
reportId
Unique identifier of the report.
elementId
Unique identifier of the element
Response
The response body.
elementId
name
sql
error

