Skip to main content

GetDashboardOverview returns comprehensive dashboard overview stats.

GET 
/api/v1/reports/dashboard/overview

Parameters​

  • date_range: Time period for metrics (Required)
  • include_comparison: Calculate trends vs previous period
  • include_trends: Include time series data
  • granularity: Time granularity for trends
  • top_limit: Limit for "top N" lists (default: 5)

Response​

  • Engagement stats: total, by status/channel, top topics/outcomes, FRT, resolution time
  • Ticket stats: total, by status/channel/priority, top types/topics, SLA compliance
  • Agent stats: active agents, utilization, interactions per agent
  • Health metrics: combined health score, SLA, sentiment, availability

Errors​

  • INVALID_ARGUMENT: Invalid date range
  • PERMISSION_DENIED: Caller lacks reports:view permission

Request​

Responses​

A successful response.