Skip to main content
Four read-only endpoints for building your own dashboard. Every number is the same one the console shows — the Usage page, the dashboard, and each agent’s Analytics page — so your dashboard and the console always agree. A Read-only key is enough for all of them. See Choose what each key can do.
Money is in micro-units of currency: 1000000 is one rupee (INR) or one dollar (USD). Divide by 1,000,000 to show it.

Usage and balance

Agent analytics

  • days is a rolling window, 1–90 (default 30). rows caps the two question lists, 1–100 (default 20).
  • resolved and escalated count conversations by their current status.
  • knowledgeGaps are questions the agent searched its knowledge for and found nothing — the list to write new knowledge from.
  • derived.neededAPerson is escalated plus handled by a person; derived.answerRate is the share of knowledge searches that found an answer (null when there were none).
  • Days and hours are in UTC.

Call totals

days is 1–90 (default 7). With days=1 the series is by hour. Buckets are in your workspace’s time zone. debitMicro is what the calls cost you.

WhatsApp totals

cost is what the WhatsApp messages in the window cost you, priced exactly as the WhatsApp dashboard prices them, by Meta category for the messages you sent. complete: false means some messages are not priced yet — Meta has not reported them, or there is no rate card for that country — so totalMicro is what is known so far. Either a rolling days (1–90, default 7) or a from/to range (inclusive, up to 366 days), in your workspace’s time zone. errors counts failures by WhatsApp error code — see Not delivered.

Errors