Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
expectation_evaluations
Expectation Evaluations

List Expectation Evaluations

List Expectation Evaluations

get/expectation_evaluations

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 ExpectationEvaluations objects.

idinteger

ExpectationEvaluation ID

workspace_idinteger

Workspace ID. 0 means the default workspace.

expectation_idinteger

Expectation ID.

status'open' | 'success' | 'late' | 'missing' | 'invalid'

Evaluation status.

opened_via'schedule' | 'manual' | 'upload'

How the evaluation window was opened.

opened_atstring date-time

When the evaluation row was opened.

window_start_atstring date-time

Logical start of the candidate window.

window_end_atstring date-time

Actual candidate cutoff boundary for the window.

deadline_atstring date-time

Logical due boundary for schedule-driven windows.

late_acceptance_cutoff_atstring date-time

Logical cutoff for late acceptance, when present.

hard_close_atstring date-time

Hard stop after which the window may not remain open.

closed_atstring date-time

When the evaluation row was finalized.

matched_filesobject[]

Captured evidence for files that matched the window.

missing_filesobject[]

Captured evidence for required files that were missing.

criteria_errorsstring[]

Captured criteria failures for the window, including file-scoped FTS errors and returned validation details.

summaryobject

Compact evaluator 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_via": "manual",
    "opened_at": "2000-01-01T01:00:00Z",
    "window_start_at": "2000-01-01T01:00:00Z",
    "window_end_at": "2000-01-01T01:00:00Z",
    "deadline_at": "2000-01-01T01:00:00Z",
    "late_acceptance_cutoff_at": "2000-01-01T01:00:00Z",
    "hard_close_at": "2000-01-01T01:00:00Z",
    "closed_at": "2000-01-01T01:00:00Z",
    "matched_files": [],
    "missing_files": [],
    "criteria_errors": [
      "count expected exactly 2, got 1"
    ],
    "summary": {},
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]