Observability API

REST endpoints for reading Observability listings and measurements, and for toggling Volume Tracking and Freshness Tracking on containers.

• Base URL: https://<your-deployment>/api
• Authentication: Bearer token in the Authorization header. See Personal Access Tokens for how to obtain one.

Endpoints at a glance

List Measures

Endpoint: GET /observability Permission: Any authenticated workspace user; datastore-level team permissions gate returned rows.

Returns a paginated list of container-observability rows for the Measures tab. Each row includes the container identity, its active anomaly count, its active-check summary, and its recent daily measurements.

Common query parameters:

curl -X GET 'https://<your-deployment>/api/observability?datastore=42&timeframe=month&sort_active_anomalies=desc' \
  -H 'Authorization: Bearer <token>'

List Metric measurements

Endpoint: GET /quality-checks/measurements Permission: Any authenticated workspace user; datastore-level team permissions gate returned rows.

Returns Metric checks with their most recent measurements (up to the last 10 per check).

Common query parameters:

curl -X GET 'https://<your-deployment>/api/quality-checks/measurements?container=123&sort_created=desc' \
  -H 'Authorization: Bearer <token>'

Toggle Volume / Freshness Tracking

Endpoint: PATCH /containers/volumetric-tracking Permission: Any signed-in workspace user (Member role and above) who can see the datastore. This endpoint does not require the Author or Editor team permission, so it is intentionally more permissive than the check-edit endpoints above; the underlying container is still gated by the standard datastore visibility filter.

Bulk-updates the Volume Tracking and Freshness Tracking flags on one or more containers. This is the endpoint the Observability Settings modal calls.

Request body fields:

Turning tracking off cascades: the matching automation flag is also cleared server-side.

curl -X PATCH 'https://<your-deployment>/api/containers/volumetric-tracking' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "containers": [123, 124],
    "volumetric_tracking_enabled": true,
    "freshness_tracking_enabled": true,
    "automate_volumetric_checks": true,
    "automate_freshness_checks": false
  }'

Update thresholds or Maximum Age

Endpoint: PUT /quality-checks/{id} Permission: Author team permission on the datastore (Editor on the datastore always allowed).

The inline Edit Threshold and Edit Maximum Age actions on the Observability chart both call this endpoint. Send only the fields you want to change.

• For Volumetric and Metric threshold edits, set properties.min_value and properties.max_value.
• For Freshness Maximum Age edits, set properties.value (milliseconds).

curl -X PUT 'https://<your-deployment>/api/quality-checks/6789' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "properties": {
      "min_value": 25000,
      "max_value": 70000
    }
  }'

curl -X PUT 'https://<your-deployment>/api/quality-checks/6790' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "properties": {
      "value": 10800000
    }
  }'

Error responses