Skip to main content
GET
Get an analytics metric

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
enum<string>
required

Registry metric id. Generated from every metric id in config/analytics/semantic_model.yml. Regenerate with docs/tools/generate_analytics_metric_enum.py; unknown route ids return 404.

Available options:
resolution_volume,
resolution_volume_by_class,
resolution_volume_by_channel,
resolver_split,
time_to_resolution,
signal_tier_mix,
confirmed_resolution_rate,
deflection_rate,
automation_rate,
escalation_rate,
modifier_rate,
void_rate,
message_volume_by_channel,
segment_usage,
primitive_type_volume,
delivery_rate,
engagement_rate,
quick_reply_taps,
read_receipt_rate,
voice_minutes,
flow_completion_rate,
usage_by_period,
meter_reconciliation,
conversion_volume,
value_signal_volume,
save_flow_success_rate,
upsell_close_rate,
attributed_conversion_volume,
conversion_funnel,
interaction_path_volume,
rich_link_conversion_rate,
sla_adherence,
agent_resolutions,
conversation_volume,
first_response_time,
reply_time,
csat_positive_rate,
csat_response_rate,
bot_handoff_count,
handle_time,
agent_learning_activity,
time_to_human,
sentiment_score,
positive_message_rate,
negative_message_rate,
at_risk_conversations,
topic_volume,
topic_share,
topic_share_change,
topic_coverage,
topic_table

Query Parameters

since
string<date>

Inclusive start date; default is 29 days before until.

until
string<date>

Inclusive last date; defaults to today in timezone. Maximum range 366 days and 800 buckets.

granularity
enum<string>

Must be supported by each metric; defaults to day if supported, otherwise its first grain.

Available options:
hour,
day,
week,
month
timezone
string

IANA time zone; default UTC.

business_hours
boolean

Legacy basis flag, mutually exclusive with hours.

hours
enum<string>

Hours basis; business/off require analytics_business_hours. Mutually exclusive with business_hours.

Available options:
all,
business,
off
compare
boolean

Include aligned prior-window comparisons when supported.

topic_mentions
enum<string>

Count main topic only (default) or all topic mentions.

Available options:
main,
all
dimensions[]
string[]

Requested declared/served dimensions. Use repeated dimensions[] values.

Response

Success.

Pending envelope or sourced metric-specific payload. Payload definitions remain owned by Analytics (I-28); fields vary by metric, dimensions and grain.

metricId
enum<string>
required

Generated from every metric id in config/analytics/semantic_model.yml. Regenerate with docs/tools/generate_analytics_metric_enum.py; unknown route ids return 404.

Available options:
resolution_volume,
resolution_volume_by_class,
resolution_volume_by_channel,
resolver_split,
time_to_resolution,
signal_tier_mix,
confirmed_resolution_rate,
deflection_rate,
automation_rate,
escalation_rate,
modifier_rate,
void_rate,
message_volume_by_channel,
segment_usage,
primitive_type_volume,
delivery_rate,
engagement_rate,
quick_reply_taps,
read_receipt_rate,
voice_minutes,
flow_completion_rate,
usage_by_period,
meter_reconciliation,
conversion_volume,
value_signal_volume,
save_flow_success_rate,
upsell_close_rate,
attributed_conversion_volume,
conversion_funnel,
interaction_path_volume,
rich_link_conversion_rate,
sla_adherence,
agent_resolutions,
conversation_volume,
first_response_time,
reply_time,
csat_positive_rate,
csat_response_rate,
bot_handoff_count,
handle_time,
agent_learning_activity,
time_to_human,
sentiment_score,
positive_message_rate,
negative_message_rate,
at_risk_conversations,
topic_volume,
topic_share,
topic_share_change,
topic_coverage,
topic_table
unit
enum<string>
required

Registry unit.

Available options:
count,
rate,
duration,
percentile
pending
enum<boolean>
required

No sourced payload.

Available options:
true
lockOnBillingClose
boolean
required

Registry metadata only; this field does not enforce freezing at billing close.