List evaluation results
Retrieve a paginated list of evaluation results with optional filters
https://localhost:10001/api/v2/evaluationscurl --request GET \
--url 'https://localhost:10001/api/v2/evaluations' \
--header 'Authorization: Bearer <token>'const response = await fetch("https://localhost:10001/api/v2/evaluations", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
const data = await response.json();interface EvaluationResultsListResponse {
limit?: number;
offset?: number;
results?: Record<string, unknown>[];
total?: number;
}
const response = await fetch("https://localhost:10001/api/v2/evaluations", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: EvaluationResultsListResponse = await response.json();import requests
response = requests.get(
"https://localhost:10001/api/v2/evaluations",
headers={
"Authorization": "Bearer <token>",
},
)
response.raise_for_status()
print(response.json())package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v2/evaluations", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://localhost:10001/api/v2/evaluations"))
.header("Authorization", "Bearer <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:10001/api/v2/evaluations");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$ch = curl_init('https://localhost:10001/api/v2/evaluations');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;require "net/http"
uri = URI("https://localhost:10001/api/v2/evaluations")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"// Cargo.toml dependencies: reqwest, tokio (features "full")
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.get("https://localhost:10001/api/v2/evaluations")
.header("Authorization", "Bearer <token>")
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
applicationId | integer | Filter by application ID |
indicatorId | string | Filter by indicator UUID |
projectId | integer | Filter by project ID |
appliedPolicyId | string | Filter by applied policy ID, slug:my-policy, or urn:cid:bafy... |
appliedPolicyControlId | integer | Filter by applied policy control ID |
result | string | Filter by result status (pass, fail, error, awaiting_evaluation) |
since | string | Filter evaluations after this timestamp, RFC 3339 |
until | string | Filter evaluations before this timestamp, RFC 3339 |
limit | integer | Number of results to return (default: 50, max: 200) |
offset | integer | Number of results to skip (default: 0) |
Responses
200Paginated evaluation results
limitintegeroffsetintegerresultshandlers.EvaluationResultResponse[]Show properties
Array of
handlers.EvaluationResultResponseapplicationIdintegercreatedAtstring<date-time>criterionResultscore.CriterionResult[]Show properties
Array of
core.CriterionResultcriteriaIndexintegerfieldstringreasonstringstatuscore.CriterionResultStatusOne of
passfailskipped
declarationIdsinteger[]durationMsintegerEvaluation wall time in milliseconds
evaluatedAtstring<date-time>extractedFieldsobjectfailureDetailscore.EvaluationFailureDetail[]Show properties
Array of
core.EvaluationFailureDetailactualValueanyarrayMatchModecore.ArrayMatchModeOne of
allanycriteriaIndexintegercriteriaTypecore.CriteriaTypeOne of
stringnumberbooleandatelist[string]list[number]elementPathstringexpectedValueanyextractionPathstringfieldstringindexPathinteger[]missingbooleanoperatorcore.OperatorTypeOne of
eqneqgtltgtelteinnotIncontainsnotContainsreasonstring
failureReasonsstring[]idstringurn:uuid form
indicatorIdstringurn:uuid form
resultcore.EvaluationResultStatusOne of
passfailerrorawaiting_evaluationtriggerSourcestring
totalinteger
{
"limit": 0,
"offset": 0,
"results": [
{
"applicationId": 0,
"createdAt": "2025-01-01T00:00:00Z",
"criterionResults": [
{
"criteriaIndex": 0,
"field": "string",
"reason": "string",
"status": "pass"
}
],
"declarationIds": [
0
],
"durationMs": 0,
"evaluatedAt": "2025-01-01T00:00:00Z",
"extractedFields": {},
"failureDetails": [
{
"actualValue": null,
"arrayMatchMode": "all",
"criteriaIndex": 0,
"criteriaType": "string",
"elementPath": "string",
"expectedValue": null,
"extractionPath": "string",
"field": "string",
"indexPath": [
0
],
"missing": true,
"operator": "eq",
"reason": "string"
}
],
"failureReasons": [
"string"
],
"id": "string",
"indicatorId": "string",
"result": "pass",
"triggerSource": "string"
}
],
"total": 0
}400Bad request - Invalid filter parameter
errorstring
{
"error": "Invalid request body"
}401Unauthorized - Authentication required
errorstring
{
"error": "Invalid request body"
}403Forbidden - Insufficient permissions
errorstring
{
"error": "Invalid request body"
}500Internal server error
errorstring
{
"error": "Invalid request body"
}