Skip to main content
GET
/
v0
/
reporting
/
eval-stats
/
by-definition
Get eval stats aggregated by eval definition
curl --request GET \
  --url https://api.avidoai.com/v0/reporting/eval-stats/by-definition \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "stats": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Is factual",
      "type": "FACT_CHECKER",
      "passed": 42,
      "total": 50
    }
  ],
  "total": 50
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

​
start
string<date-time>
required

Start of the time range (ISO8601, inclusive).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-01T00:00:00Z"

​
end
string<date-time>
required

End of the time range (ISO8601, inclusive).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-31T23:59:59Z"

Response

Successfully retrieved eval stats by definition

Eval stats aggregated by eval definition.

​
stats
EvalStatByDefinition · object[]
required

Eval stats aggregated by eval definition.

​
total
integer
required

Sum of total across all returned stat rows.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

100