Conversations Metrics
Overview
Retrieve tenant-level conversation counts broken down by type - total conversations, group chats, and individual (direct) conversations.
Use this endpoint for conversation KPI cards or when refreshing only the conversations section of your dashboard.
When to use this endpoint?
Use Conversations Metrics when:
- You need group vs individual conversation totals for charts or cards.
- You want a lightweight count without loading the full conversation list.
- You are refreshing conversation KPIs independently from users or messages.
Requires a client Access Token with tenant admin privileges and tenant headers.
Response Data
GET
{baseUrl}/api/{apiVersion}/dashboard/metrics/conversations- Authentication
- Required (Bearer token)
- Tenant-scoped
- Yes (tenant DB - requires x-client-id)
Request Headers
Success Response (HTTP 200 OK)
On success, the API returns conversation totals for the tenant.
json
{ "success": true, "message": "Conversation metrics fetched successfully", "data": { "total": 342, "group": 54, "individual": 288 }, "error": null}Common Errors
Best Practices
- Use this for conversation-only widgets; use Dashboard Overview for a combined snapshot.
- Link KPI cards to List Conversations so admins can inspect the underlying data.
- Always send tenant headers with a client Bearer token over HTTPS.
Conversation metrics ready
Map total, group, and individual to your conversations KPI row. Continue with List Conversations for details.