v4

latestSwagger 2.02026-08-0343714211.7 MB

expectation_incidents

Expectation Incidents

List Expectation Incidents

get/expectation_incidents

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, created_at or expectation_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are expectation_id and workspace_id. Valid field combinations are [ workspace_id, expectation_id ].

Response

A list of ExpectationIncidents objects.

idinteger

Expectation Incident ID

workspace_idinteger

Workspace ID. 0 means the default workspace.

expectation_idinteger

Expectation ID.

status'open' | 'acknowledged' | 'snoozed' | 'resolved'

Incident status.

opened_atstring date-time

When the incident was opened.

last_failed_atstring date-time

When the most recent failing evaluation contributing to the incident occurred.

acknowledged_atstring date-time

When the incident was acknowledged.

snoozed_untilstring date-time

When the current snooze expires.

resolved_atstring date-time

When the incident was resolved.

opened_by_evaluation_idinteger

Evaluation that first opened the incident.

last_evaluation_idinteger

Most recent evaluation linked to the incident.

resolved_by_evaluation_idinteger

Evaluation that resolved the incident.

summaryobject

Compact incident summary payload.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

[
  {
    "id": 1,
    "expectation_id": 1,
    "status": "open",
    "opened_at": "2000-01-01T01:00:00Z",
    "last_failed_at": "2000-01-01T01:00:00Z",
    "acknowledged_at": "2000-01-01T01:00:00Z",
    "snoozed_until": "2000-01-01T01:00:00Z",
    "resolved_at": "2000-01-01T01:00:00Z",
    "opened_by_evaluation_id": 1,
    "last_evaluation_id": 2,
    "resolved_by_evaluation_id": 3,
    "summary": {},
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]