Skip to content
English
  • There are no suggestions because the search field is empty.

List evaluation results

GET /api/v2/evaluations Select code sample Fetch cURL
const url = 'https://localhost:10001/api/v2/evaluations';const options = {method: 'GET', headers: {Authorization: '
  
   '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}
  
curl --request GET \  --url https://localhost:10001/api/v2/evaluations \  --header 'Authorization: 
  
   '
  

Retrieve a paginated list of evaluation results with optional filters

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ” applicationId integer

Filter by application ID

indicatorId string

Filter by indicator UUID

projectId integer

Filter by project ID

projectPolicyId integer

Filter by project policy ID

projectPolicyControlId integer

Filter by project policy control ID

result string

Filter by result status (pass, fail, error, awaiting_evaluation)

since string

Filter evaluations after this timestamp (ISO 8601)

until string

Filter evaluations before this timestamp (ISO 8601)

limit integer

Number of results to return (default: 50, max: 200)

offset integer

Number of results to skip (default: 0)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated evaluation results

Media type application/json object limit integer offset integer results Array object applicationId integer createdAt string criterionResults Array object criteriaIndex integer field string reason string status stringAllowed values: pass fail skipped declarationIds Array durationMs integer evaluatedAt string extractedFields object failureDetails Array object actualValue arrayMatchMode stringAllowed values: all any criteriaIndex integer criteriaType stringAllowed values: string number boolean date list[string] list[number] elementPath string expectedValue extractionPath string field string indexPath Array missing boolean operator stringAllowed values: eq neq gt lt gte lte in notIn contains notContains reason string failureReasons Array id string indicatorId string payloadHash string payloadTruncated boolean result stringAllowed values: pass fail error awaiting_evaluation triggerSource string total integer
Example
{  "results": [    {      "criterionResults": [        {          "status": "pass"        }      ],      "failureDetails": [        {          "arrayMatchMode": "all",          "criteriaType": "string",          "operator": "eq"        }      ],      "result": "pass"    }  ]}

400

Section titled “400 ”

Bad request - Invalid filter parameter

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

403

Section titled “403 ”

Forbidden - Insufficient permissions

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

500

Section titled “500 ”

Internal server error

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}
Previous
Create review with attachment
Next
Get evaluation result