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 the 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&report_date=<YYYY-MM-DD>&sort_observability_active_anomalies=desc' \
  -H 'Authorization: Bearer <token>'

Filtering Lists¶

GET /api/observability and GET /api/quality-checks/measurements accept a filters parameter: a JSON object with one entry per filter, saying how that filter's values should match.

curl -G "https://your-instance.qualytics.io/api/observability" \
  --data-urlencode 'filters={"tag":{"not_in":["PII"]}}' \
  -H "Authorization: Bearer YOUR_TOKEN"

This returns the tables and files that aren't tagged PII.

• Different filters combine with AND, and so do keys on the same filter.
• empty can't be combined with other keys on the same filter.
• A filter sent both as its own parameter and inside filters returns a 422. Put all of that filter's conditions in filters.
• in, not_in and all_of each take between 1 and 20 values.
• A filter or key the endpoint doesn't accept returns a 422 that names it. The API docs list what each endpoint accepts.

List Metric measurements¶

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

Returns Metric checks with their most recent measurements (up to the last 11 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: Editor team permission on the datastore of every container in the request. The whole request is rejected when any container is missing or the caller lacks Editor on it, and nothing changes.

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

The request body is a JSON array with one object per container. Each object takes these 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 '[
    {
      "id": 123,
      "volumetric_tracking_enabled": true,
      "freshness_tracking_enabled": true,
      "automate_volumetric_checks": true,
      "automate_freshness_checks": false
    },
    {
      "id": 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. The PUT endpoint requires description and the full properties object, which replaces the stored one. Include every property the check uses, not only the one you change. Metric checks also need fields.

• For Volumetric and Metric threshold edits, set properties.min and properties.max. Copy the other properties, such as comparison and window_size, from the existing check (read it with GET /api/quality-checks/{id}). The comparison cannot change once the check has been asserted, and a different window_size would also change the measurement period.
• 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 '{
    "description": "Daily row count stays between 25,000 and 70,000",
    "properties": {
      "comparison": "Absolute Value",
      "window_size": 1,
      "min": 25000,
      "max": 70000
    }
  }'

curl -X PUT 'https://<your-deployment>/api/quality-checks/6790' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Table is refreshed at least every 3 hours",
    "properties": {
      "value": 10800000
    }
  }'

Error responses¶