Documentation

Evaluations

evaluations

Methods

Create Evaluation ->
Evaluation
post/v5/evaluations

Create Evaluation

List Evaluations -> CursorPage<
Evaluation
>
get/v5/evaluations

List Evaluations

Get Evaluation ->
Evaluation
get/v5/evaluations/{evaluation_id}

Get Evaluation

Archive Evaluation ->
Evaluation
delete/v5/evaluations/{evaluation_id}

Archive Evaluation

Update Or Restore Evaluation ->
Evaluation
patch/v5/evaluations/{evaluation_id}

Update or Restore Evaluation

Get Evaluation Data Schema ->
EvaluationSchemaResponse
get/v5/evaluations/{evaluation_id}/schema

Get schema information for evaluation item data, including field names, types, and occurrence counts.

Filter Evaluations -> CursorPage<
Evaluation
>
post/v5/evaluations/filter

Filter evaluations using metadata and other criteria. Supports up to 10 filters with AND logic.

Domain types

Evaluation = { id, created_at, created_by, 12 more... }
EvaluationSchemaResponse = { evaluation_id, fields, total_items, 3 more... }

Schema information for an evaluation's item data structure

EvaluationTask = { configuration, alias, task_type } | { configuration, alias, task_type } | { configuration, alias, task_type } | 7 more...
ItemLocator = string
ItemLocatorTemplate = string