Evaluations

evaluations

Methods

Create Evaluation ->
post/v5/evaluations

Create Evaluation

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

List Evaluations

query Parameters
ending_before: string
Optional
include_archived: boolean
Optional
limit: number
Optional
(maximum: 1000, minimum: 1, default: 100)
name: string
Optional
sort_by: string
Optional
sort_order:
Optional
(default: "asc")
"asc"
"desc"
starting_after: string
Optional
tags: Array<string>
Optional
views: Array<
Optional
(default: [])
"tasks"
>
Response fields
has_more: boolean

Whether there are more items left to be fetched.

items: Array<>
total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number
Optional
(default: 100)

The maximum number of items to return.

object: "list"
Optional
(default: "list")
Request example
200Example
Get Evaluation ->
get/v5/evaluations/{evaluation_id}

Get Evaluation

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

Archive Evaluation

Update Or Restore 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