Get an analytics metric
Authenticated account members only; administrators or a custom role with report_manage may read metrics and benchmarks. Ordinary agents/managers get 403; foreign or nonexistent accounts get 401. Reads are scoped through Current.account. Unknown metric ids return 404. Registry metrics without sourced builders return pending=true without data. Metric semantics and payloads belong to Analytics (I-28).
Authorizations
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
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.
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
Inclusive start date; default is 29 days before until.
Inclusive last date; defaults to today in timezone. Maximum range 366 days and 800 buckets.
Must be supported by each metric; defaults to day if supported, otherwise its first grain.
hour, day, week, month IANA time zone; default UTC.
Legacy basis flag, mutually exclusive with hours.
Hours basis; business/off require analytics_business_hours. Mutually exclusive with business_hours.
all, business, off Include aligned prior-window comparisons when supported.
Count main topic only (default) or all topic mentions.
main, all Requested declared/served dimensions. Use repeated dimensions[] values.
Response
Success.
- Option 1
- Option 2
Pending envelope or sourced metric-specific payload. Payload definitions remain owned by Analytics (I-28); fields vary by metric, dimensions and grain.
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.
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 Registry unit.
count, rate, duration, percentile No sourced payload.
true Registry metadata only; this field does not enforce freezing at billing close.