Skip to navigation

List lineage of a report element

View as Markdown

This endpoint retrieves the lineage and dependencies of a specific report element. It provides a detailed view of how data is interconnected within a report, which can be critical for understanding data sources and dependencies.

Usage notes

  • reportId: The UUID of the report containing the element. Retrieve the reportId by calling the /v2/reports endpoint.
  • elementId: The UUID of the element within the report whose lineage is being queried. 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.

Usage scenarios

  • Data governance: Allows data managers to track how information is used and propagated through different report elements.
  • Debugging and optimization: Helps in identifying and resolving issues in data processing or in the structure of report setups.
  • Data source management: Identify the data sources in use in a specific report.

Best practices

  • Use this endpoint to regularly audit report structures, ensuring that all data connections and transformations are correct and optimized.
  • Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired
Unique identifier of the report.
elementIdstringRequired
Unique identifier of the element

Response

The response body.
dependenciesmap from strings to objects
edgeslist of objects