Skip to main content

API Access

  • All Definity data is available for access through rest APIs documented in the server's swagger:
    • https:/[definity-server]/api/docs
  • Access to Definity's DB directly is not recommended as schemas mights change between versions

Data Retrieval APIs​

/api​

apis for top level entities (pipelines, transformations, datasets, alerts)

/app​

apis for detailed content of specific pipeline:

  • runs
  • metrics
  • tests
  • alerts

/app_run​

apis per specific Point In Time execution of a specific pipeline

/task​

access metrics & tests per specific task in pipeline

/tf​

access metrics & tests for specific transformation

/dataset​

access schema, metrics & tests per dataset

Reporting APIs​

/log​

report new task runs, transformations and metrics values to definity platform. This allows users to integrate external pipelines and metrics into Definity for observability

Last updated on