Skip to content

Observability API

DataOps Observability consists of two REST APIs: the Event Ingestion API, responsible for receiving events sent from your data estate, and the Observability API, responsible for system and management tasks.

When you create an  API key, you can configure the key:

  • To send events. This provides authorization to the Event Ingestion API and associates the incoming events sent by your components with the correct project.
  • To perform management tasks. This allows you to manage certain Observability entities for the current project.

Best practice is to always create the most limited key for your use case.

Observability API actions

An API key with management abilities can only access the endpoints under the project level, and only for the project that the key is associated with. For example, it allows you to update components or journeys.

Access to the following endpoints is not granted:

  • Companies.
  • Organizations.
  • Users.
  • Roles.
  • API keys.
  • Create, read, update, and delete actions for any project.

Note, access to GetProjectByID is granted.

API documentation

You can find technical details about the Observability API endpoints in the Swagger documentation.