/api/ee/dependencies

GET /api/ee/dependencies/graph/breaking

Changed on

Returns a list of entities that are breaking other entities (sources of errors). These are tables or cards that other entities depend on, where those dependents have validation errors traced back to this source entity.

Accepts optional parameters for filtering:

  • types: List of source entity types - only :card or :table (default: both)
  • card-types: List of card types to include when filtering cards (e.g., [:question :model :metric])
  • query: Search string to filter by name or location
  • include-personal-collections: Controls whether items in personal collections are included (default: false)
  • sort-column: Sort column - :name, :location, :dependents-errors, or :dependents-with-errors (default: :name)
  • sort-direction: Sort direction - :asc or :desc (default: :asc)
  • offset: Default 0
  • limit: Default 50

Returns a map with:

  • data: List of breaking source entities
  • total: Total count of matched items
  • offset: Applied offset
  • limit: Applied limit
get/api/ee/dependencies/graph/breaking

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Query parameters

'transform' | 'table' | 'snippet' | 'dashboard' | 'sandbox' | 'measure' | 'card' | 'document' | 'segment' | 'action' | 'data-app'
OR
MetabaseEnterpriseDependenciesDependencyTypesDependencyTypes[]
'question' | 'metric' | 'model'
OR
string[]
querystring
include-personal-collectionsboolean
sort-column'dependents-with-errors' | 'dependents-errors' | 'name' | 'location'
sort-direction'desc' | 'asc'

Request body

object required

Response

Successful response

limitinteger required

value must be an integer greater than zero.

offsetinteger required
totalinteger required

Changes

    • warning

      deleted the query request parameter archived

    • info

      added optional request body

    • info

      added the enum value action to the property anyOf[metabase-enterprise.dependencies.dependency-types.dependency-types]/ of the query request parameter types

    • info

      added the enum value action to the property anyOf[subschema #2]/items/ of the query request parameter types

    • info

      added the enum value data-app to the property anyOf[metabase-enterprise.dependencies.dependency-types.dependency-types]/ of the query request parameter types

    • info

      added the enum value data-app to the property anyOf[subschema #2]/items/ of the query request parameter types

    • info

      added to the / response property anyOf list for the response status

    • info

      removed from the / response property oneOf list for the response status

    • info

      endpoint added