Runs API¶

The endpoints documented on this page are used to manage existing Runs: list them, fetch a single Run, abort an in-flight Run, resume or rerun a finished one, and delete a Run record. For payload examples to create a new Run, see the API page for the specific operation type (for example, Scan API or Promote API).

All endpoints use the base URL of your Qualytics deployment (for example, https://your-instance.qualytics.io/api).

Listing Runs¶

Send GET /api/operations to retrieve a paginated list of Runs across all operation types. The endpoint supports rich filtering and sorting via query parameters.

curl -X GET "https://your-instance.qualytics.io/api/operations?operation_type=scan&result=success&result=failure&sort_created=desc" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "items": [
    {
      "id": 53388,
      "type": "scan",
      "created": "YYYY-MM-DDTHH:MM:SS.ssssssZ",
      "start_time": "YYYY-MM-DDTHH:MM:SS.ssssssZ",
      "end_time": "YYYY-MM-DDTHH:MM:SS.ssssssZ",
      "result": "success",
      "message": null,
      "triggered_by": "user@example.com",
      "datastore": { "id": 101, "name": "Datastore-Sample" },
      "status": {
        "total_containers": 14,
        "containers_analyzed": 14,
        "partitions_scanned": 42,
        "records_processed": 700000,
        "anomalies_identified": 0
      }
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50,
  "pages": 1
}

Filtering Lists¶

GET /api/operations accepts 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/operations" \
  --data-urlencode 'filters={"result":{"not_in":["success"]}}' \
  -H "Authorization: Bearer YOUR_TOKEN"

This returns the Runs that didn't succeed.

• 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.

Retrieving a Run¶

Send GET /api/operations/{id} to return the full detail payload for a single Run, including the configuration it used, the summary metrics, and the triggering metadata.

For the full shape of the response object (including operation-specific fields such as auto_resolved_anomaly_count on Scan Runs), see the response example in Scan API: Retrieving Scan operation information.

curl -X GET "https://your-instance.qualytics.io/api/operations/53388" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Listing containers in a Run¶

Send GET /api/operations/{id}/containers to return the per-container breakdown of a Run (one entry per container that the Run targeted), with the container-level status and counters. Most useful for Profile and Scan Runs that track progress at the container layer.

curl -X GET "https://your-instance.qualytics.io/api/operations/53388/containers" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "items": [
    {
      "id": 456,
      "container": { "id": 234, "name": "customers", "container_type": "table" },
      "start_time": "YYYY-MM-DDTHH:MM:SS.ssssssZ",
      "end_time": "YYYY-MM-DDTHH:MM:SS.ssssssZ",
      "records_processed": 50000,
      "anomaly_count": 0,
      "result": "success",
      "message": null
    }
  ],
  "total": 14
}

Aborting a Run¶

Send PUT /api/operations/abort/{id} to stop an in-progress Run. The Run transitions to Aborted as soon as the operation can stop safely, and partial results captured up to the stop point are preserved.

Permission: Editor team permission on the target datastore.

curl -X PUT "https://your-instance.qualytics.io/api/operations/abort/53388" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Resuming a Run¶

Send PUT /api/operations/run/{id} to continue an Aborted or Failure Run from the unprocessed containers (or partitions). Containers already completed in the original Run are not re-read.

Supported by Profile, Scan, and Promote. Not supported by Sync, External Scan, Export, or Materialize.

Permission: Editor team permission on the target datastore.

curl -X PUT "https://your-instance.qualytics.io/api/operations/run/53204" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Rerunning a Run¶

Send PUT /api/operations/rerun/{id} to start a brand-new Run that reuses the configuration of an existing Run. Every container is processed from scratch, regardless of whether it succeeded before.

Supported by Sync, Profile, Scan, Export, Materialize, and Promote. Not supported by External Scan.

Permission: Editor team permission on the target datastore.

curl -X PUT "https://your-instance.qualytics.io/api/operations/rerun/53388" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Deleting a Run¶

Send DELETE /api/operations/{id} to remove the Run record (and its summary metrics) from the Activity list. Deleting a Scan or External Scan also permanently deletes the anomalies it found, recalculates quality scores, and makes the previous successful scan the latest one when the deleted Run was the latest. Deleting a Profile removes its profile results and, when it was the latest profile, makes the previous successful profile the latest one. Data written by Sync, Export, Materialize, and Promote stays in place.

Permission: Editor team permission on the target datastore. You must also have started the Run, unless you have the Admin role.

curl -X DELETE "https://your-instance.qualytics.io/api/operations/53388" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Error Responses¶