Skip to main content
GET
Get Evaluation Metrics

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Query Parameters

metrics
enum<string>[]
required

Comma-separated list of evaluation metric IDs.

Minimum array length: 1
Available options:
unique_conversations_evaluated,
mean_score,
pass_rate,
unique_graders,
total_evaluations,
score_distribution
created_gte
string<date-time>

Show eval results created on or after this datetime (inclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-05T00:00:00Z). Defaults to 7 days ago.

created_lt
string<date-time>

Show eval results created before this datetime (exclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-05T23:59:59Z). Defaults to now.

account_id
string | null

Account ID to filter by

time_granularity
enum<string> | null

Time bucket for aggregation. When omitted, only current values are calculated (no time series).

Available options:
hour,
day,
week,
month,
year
group_by_dimension
enum<string> | null

Dimension to include WITHIN time series.

Available options:
eval,
grader,
grader_type,
campaign,
agent,
disposition,
conversation_medium,
call_type
eval_ids
string[] | null

Comma-separated list of evaluation IDs to filter by

grader_names
string[] | null

Comma-separated list of grader names to filter by

grader_types
enum<string>[] | null

Comma-separated list of grader types to filter by

Available options:
label_model,
score_model,
action_execution,
calculated_score
passed
boolean | null

Filter by evaluation pass/fail status

campaign_ids
string[] | null

Comma-separated list of campaign IDs to filter by

agent_ids
string[] | null

Comma-separated list of agent IDs to filter by

disposition_level_3
string[] | null

Comma-separated list of level 3 disposition names to filter by

conversation_mediums
enum<string>[] | null

Comma-separated list of conversation mediums to filter by.

Available options:
web_voice,
telephony,
sms,
email,
chatbot,
api_text,
chat_app,
softphone
call_types
enum<string>[] | null

Comma-separated list of call types to filter by.

Available options:
outbound,
inbound
twilio_statuses
enum<string>[] | null

Comma-separated list of Twilio call statuses to filter by. When omitted, includes all statuses.

Available options:
queued,
initiated,
ringing,
in-progress,
completed,
busy,
failed,
no-answer,
canceled,
voicemail
is_dry_run
boolean | null

Filter by dry-run status. True=only dry-runs, False=exclude dry-runs, None=include all (default).

Include trend comparison with previous period (calculates change_value, change_percent, trend direction)

Response

Successful Response

Main response from evaluation metrics API

metrics
Metrics · object
required
filters_applied
EvalFiltersSummary · object
required

Summary of filters applied to the query

metadata
EvalResponseMetadata · object
required

Metadata about the response