Skip to main content

Get the eval overview

POST 

/api/v1/evals/get-overview

Aggregate trace counts, score averages and totals for a time window — the numbers behind a dashboard.

Coverage and profile cards use the first 100 roots/scores, while volume metrics can describe a larger population. Observation-targeted scores are not counted as trace coverage. A profile filter does not establish a consistent denominator for every card; do not use these mixed populations as a release gate.

Overview populations and configuration identity​

Section ID: DOC-IS-evaluation-api-getOverview#overview-populations-and-configuration-identity

Interpret quality alongside a fixed dataset's eligible, evaluated, failed and excluded cases; sampled coverage is not the proportion of every turn reviewed.

Save the full configuration in the regression workflow before attributing a difference to one change.

Callers use platform API access and do not need an evaluation-provider credential or direct evaluation-provider URL. Authorisation depends on verified caller identity and scope, not on which client interface made the request.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Find out why a customer’s reply was slow

Request​

Responses​

OK

Schema-valid request illustration; replace example identifiers and confirm operation prerequisites.​

Section ID: DOC-IS-evaluation-api-getOverview#example-evals-getOverview-request

Request example

{}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-IS-evaluation-api-getOverview#example-evals-getOverview-response

Response example

{
"overview": {
"totalTraces": "1",
"tracesByName": [
{
"name": "example",
"count": "1"
}
],
"tracesOverTime": [
{
"value": 1,
"series": "example"
}
],
"observationsByLevel": [
{
"value": 1,
"series": "example"
}
],
"scores": [
{
"name": "example",
"source": "SCORE_SOURCE_JUDGE",
"count": "1",
"average": 1
}
],
"scoreMovingAverage": [
{
"value": 1,
"series": "example"
}
],
"scoredTraceRatio": 1,
"annotatedTraceCount": "1",
"byProfile": [
{
"profileId": "example_123",
"traceCount": "1",
"avgEndUserRating": 1,
"avgJudgeScore": 1,
"thumbsDownCount": "1"
}
],
"latencyPercentiles": [
{
"traceName": "example",
"p50": 1,
"p90": 1,
"p95": 1,
"p99": 1
}
],
"recentLowScores": [
{
"scoreId": "example_123",
"targetType": "EVAL_TARGET_TYPE_TRACE",
"targetId": "example_123",
"name": "example",
"dataType": "SCORE_DATA_TYPE_NUMERIC",
"numericValue": 1,
"stringValue": "example",
"booleanValue": true,
"source": "SCORE_SOURCE_JUDGE",
"comment": "example",
"textValue": "Example text",
"authorUserId": "example_123",
"configId": "example_123",
"queueId": "example_123",
"traceId": "example_123",
"observationId": "example_123",
"sessionId": "example_123",
"datasetRunId": "example_123",
"environment": "example",
"metadataJson": "{}",
"traceName": "example",
"userId": "example_123",
"sourceLabel": "example",
"conversationId": "example_123",
"messageId": "example_123",
"messageSequence": "1",
"profileId": "example_123",
"configHash": "example"
}
]
}
}

Document ID: DOC-IS-evaluation-api-getOverview. Section identities and revisions.

SectionStable reference
Get the eval overviewDOC-IS-evaluation-api-getOverview#overview
RequestDOC-IS-evaluation-api-getOverview#request
ResponsesDOC-IS-evaluation-api-getOverview#responses