Evaluations
evaluations
Methods
post/v5/evaluations
Create Evaluation
get/v5/evaluations
List Evaluations
query Parameters
ending_before: string
Optional
include_archived: boolean
Optional
limit: number
(maximum: 1000, minimum: 1, default: 100)Optional
name: string
Optional
sort_by: string
Optional
sort_order:
(default: "asc")Optional
"asc"
"desc"
starting_after: string
Optional
tags: Array<string>
Optional
views: Array<
(default: [])Optional
"tasks"
>
Response fields
has_more: boolean
Whether there are more items left to be fetched.
total: number
The total of items that match the query. This is greater than or equal to the number of items returned.
limit: number
(default: 100)Optional
The maximum number of items to return.
object: "list"
(default: "list")Optional
Request example
200Example
get/v5/evaluations/{evaluation_id}
Get Evaluation
delete/v5/evaluations/{evaluation_id}
Archive Evaluation
patch/v5/evaluations/{evaluation_id}
Update or Restore Evaluation
Domain types
Evaluation = { id, created_at, created_by, 11 more... }
EvaluationTask = { configuration, alias, task_type } | { configuration, alias, task_type } | { configuration, alias, task_type } | 6 more...
ItemLocator = string
ItemLocatorTemplate = string