Evaluations
List Evaluations
Description
Lists all evaluations accessible to the user.
Details
This API can be used to list evaluations. If a user has access to multiple accounts, all evaluations from all accounts the user is associated with will be returned.
GET
/
v4
/
evaluations
Authorizations
x-api-key
string
headerrequiredHeaders
x-selected-account-id
string
Query Parameters
view
enum<string>[]
Available options:
ApplicationSpec
, AsyncJobs
, EvaluationConfig
, TestCaseResults
sort_by
enum<string>[]
Available options:
status:asc
, status:desc
, application_spec_id:asc
, application_spec_id:desc
, application_spec:asc
, application_spec:desc
, application_variant_id:asc
, application_variant_id:desc
, application_variant:asc
, application_variant:desc
, evaluation_config_id:asc
, evaluation_config_id:desc
, completed_at:asc
, completed_at:desc
, total_test_case_result_count:asc
, total_test_case_result_count:desc
, completed_test_case_result_count:asc
, completed_test_case_result_count:desc
, annotation_config:asc
, annotation_config:desc
, question_id_to_annotation_config:asc
, question_id_to_annotation_config:desc
, evaluation_config_expanded:asc
, evaluation_config_expanded:desc
, test_case_results:asc
, test_case_results:desc
, async_jobs:asc
, async_jobs:desc
, id:asc
, id:desc
, created_at:asc
, created_at:desc
, account_id:asc
, account_id:desc
, created_by_user_id:asc
, created_by_user_id:desc
, archived_at:asc
, archived_at:desc
, created_by_user:asc
, created_by_user:desc
, name:asc
, name:desc
, description:asc
, description:desc
, tags:asc
, tags:desc
, evaluation_config:asc
, evaluation_config:desc
page
integer
default: 1Page number for pagination to be returned by the given endpoint. Starts at page 1
limit
integer
default: 100Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
account_id
string
application_spec_id
include_archived
boolean
default: falseResponse
200 - application/json
items
object[]
requiredThe data returned for the current page.
total_item_count
integer
requiredThe total number of items of the query
current_page
integer
requiredThe current page number.
items_per_page
integer
requiredThe number of items per page.