Skip to main content
POST
Run a report

Authorizations

X-API-KEY
string
header
required

Body

application/json
measures
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
conversations,
ai_resolved_conversations,
ai_resolved_rate,
meaningful_conversations,
handled_conversations,
handled_rate,
needs_team_conversations,
asked_for_person_conversations,
asked_for_person_ai_resolved_conversations,
asked_for_person_ai_resolved_rate,
transfer_attempts,
conversation_categories,
texts_sent,
avg_duration_minutes,
handled_well_rate,
avg_quality_score,
quality_review_rate,
caller_resolution_coverage_rate,
caller_resolved_rate,
system_health_rate,
accuracy_rate,
escalation_failure_rate,
quality_failure_types,
quality_knowledge_gaps,
caller_resolved_with_task_rate,
cancellation_conversations,
cancellation_reasons,
retention_offers_pitched,
retention_offers_accepted,
retention_acceptance_rate,
retention_discounts_applied,
memberships_saved,
offers_pitched,
offers_accepted,
offer_acceptance_rate,
tasks_created,
tasks_completed,
tasks_still_open,
task_completion_rate,
task_categories,
conversations_with_tasks,
conversations_with_tasks_rate,
team_member_activity,
account_updates,
questions_answered,
questions_answered_rate,
tasks_worked,
task_closes,
avg_hours_to_close,
median_hours_to_close,
avg_hours_to_first_action,
median_hours_to_first_action,
same_day_close_rate,
open_tasks
range
enum<string>
required
Available options:
today,
yesterday,
7d,
14d,
30d,
90d,
365d,
mtd,
ytd,
month,
custom
month
string

Required when range is month.

Pattern: ^\d{4}-\d{2}$
from
string<date>

First day. Required when range is custom.

to
string<date>

Last day, included. Required when range is custom.

group_by
enum<string>
Available options:
day,
week,
month,
hour_of_day,
category,
channel,
phone_line,
team_member,
task_age,
action_group,
failure_type,
failure_subcategory,
cancellation_reason
split_by
enum<string>
Available options:
team_member
filters
object
top_n
integer
Required range: 1 <= x <= 10
include_percent_of_total
boolean

Response

The report, or why the combination is not supported.

status
enum<string>
Available options:
ok,
unsupported_combination
range
object
values
object
rows
object[]
resolved_group_by
string
chart
object
methodology
string[]
caveats
string[]
error
enum<string>

Present when status is unsupported_combination, with the same value.

Available options:
unsupported_combination
reason
string

Why the combination is not supported. Present when status is unsupported_combination.

message
string
allowed_alternatives
object

Values to retry with. Present when status is unsupported_combination.

url
string
Example:

"https://answeringagent.com/dashboard/reports"