Usage Metrics

Get CometChat app usage metrics with REST API to review message, user, group, and app activity statistics.

GET /stats

Usage Metrics

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/stats \
  --header 'apikey: <api-key>'

200

{
  "data": {
    "metrics": {
      "audio_minutes": 0,
      "video_minutes": 0,
      "recorded_minutes": 0,
      "active_users": 0,
      "concurrent_users": 0
    },
    "time_range": {
      "fromDate": 1630164253000,
      "toDate": 1632842653000
    }
  }
}

Usage is tracked per monthly billing cycle. To see where your app stands against its plan, use the CometChat Dashboard. Use this endpoint when you need usage data programmatically, for example in automated reports or alerts.

​

Check Usage in the Dashboard

Open your app in the CometChat Dashboard and go to its Overview page. The Usage (Current billing cycle) section shows each metric against your plan limit:

• Chats: MAU (monthly active users) and PCC (peak concurrent connections).
• Calls: Voice Minutes and Video Minutes.

For a multi-tenant account, open the base app’s Overview page. In the Multi-Tenant Usage card, select the current or previous billing cycle and click Generate Report. The report covers usage across all apps and is emailed to the app owner. To request the same report programmatically, use the Fetch Usage Management API.

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Query Parameters

fromDate · integer · required

Unix timestamp from which usage has to be fetched.

toDate · integer · required

Unix timestamp till which usage has to be fetched.

Response

200 - application/json

Usage metrics of an app.

data · object