Volumetric Check API¶

This page documents how to create and manage a Volumetric check via the REST API. The check uses the standard Quality Checks endpoints: set rule to volumetric and configure the comparison under properties. The rule reads the container itself, so fields is not used. All endpoints share the base URL of your deployment (for example, https://your-instance.qualytics.io/api) and require a Bearer token.

The properties object¶

Volumetric carries its rule-specific configuration under properties:

At least one of min and max is required, and min cannot be greater than max. Either violation returns 422. Percentage Change limits are decimals in the API, while the app takes them in percent.

Create¶

Endpoint: POST /api/quality-checks

Permission: Member role + Author team permission on the container's datastore (Drafter when status is "Draft").

curl -X POST "https://your-instance.qualytics.io/api/quality-checks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "description": "ORDERS must gain at least one row per daily load.",
      "rule": "volumetric",
      "fields": [],
      "container_id": 145,
      "filter": null,
      "properties": {"comparison": "Absolute Change", "window_size": 1, "min": 1, "max": null},
      "tags": ["daily-load"],
      "additional_metadata": {"runbook": "https://wiki.example.com/orders-load"},
      "template_id": null,
      "status": "Active",
      "owner_id": 7,
      "default_anomaly_assignee_id": 12
  }'

Field notes¶

Two payload fields exist for other rule types but do not apply here:

• coverage is not supported. The rule reads the container's row count, not its rows, so there is no per-row violation rate. Any value other than 1 is rejected with 422.
• anomaly_message_field is ignored. Volumetric emits a Shape Anomaly only, and Shape Anomalies always use the fixed message.

Read¶

Endpoint: GET /api/quality-checks/{id}

Permission: Member role + Reporter team permission on the check's datastore.

curl -X GET "https://your-instance.qualytics.io/api/quality-checks/101" \
  -H "Authorization: Bearer YOUR_TOKEN"

The response's inferred field is true for an AI Managed check. Its last_asserted field is empty until a Scan has asserted the check.

Update¶

Endpoint: PUT /api/quality-checks/{id}

Permission: Member role + Author team permission on the check's datastore (Drafter when the check stays Draft).

Every PUT requires description and the full properties object, including comparison, window_size, and at least one of min or max. Repeat the check's current properties even when changing only its description, tags, or other metadata: a request without them returns 422. Partial property updates are not merged.

curl -X PUT "https://your-instance.qualytics.io/api/quality-checks/101" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "ORDERS must gain between 1 and 50000 rows per daily load.",
    "properties": {"comparison": "Absolute Change", "window_size": 1, "min": 1, "max": 50000}
  }'

A PUT can update most fields on an existing Volumetric check. Three values stay immutable: the rule type, the container the check is attached to, and template_id. The comparison becomes immutable too, once a Scan has included the check: sending a different comparison then returns 409. Updating any property of an AI Managed check sets inferred to false, which stops automatic updates.

Delete¶

Endpoint: DELETE /api/quality-checks/{id}

Permission: Member role + Author team permission on the check's datastore.

Three query parameters control what happens, mirroring the two-stage flow in the UI:

curl -X DELETE "https://your-instance.qualytics.io/api/quality-checks/101?archive=true&status=Discarded&delete_anomalies=false" \
  -H "Authorization: Bearer YOUR_TOKEN"

curl -X DELETE "https://your-instance.qualytics.io/api/quality-checks/101?archive=false" \
  -H "Authorization: Bearer YOUR_TOKEN"

Error responses¶