Statistics

Ably provides statistics at one minute intervals. They are aggregated by minute, hour, day and month. The most recent statistics can be delayed by up to six seconds.

Statistics are available as:

• Account statistics covering all applications in your account
• App statistics for each individual application

Account statistics aggregate metrics from all applications in your account with additional account-only metrics relating to peak rates monitored and enforced at an account level.

You can retrieve account statistics using the Control API by making a call to the accounts endpoint using your accountId and accessToken. For example, to retrieve the last two minutes of account statistics:

curl --request GET \
  --url 'https://control.ably.net/v1/accounts/${ACCOUNT_ID}/stats?unit=minute&limit=2' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'Content-Type: application/json'

Copy
Copied!

This endpoint returns a statistics response type including account-only metrics.

curl 'https://control.ably.net/v1/me' \
--header 'Authorization: Bearer ${ACCESS_TOKEN}'

Copy
Copied!

Your account statistics are available as graphs, tabular data, and for download from your account dashboard.

App statistics provide metrics scoped to each application. You can retrieve account statistics:

• Via the Control API
• Programmatically using the Pub/Sub SDK
• In realtime by subscribing to a meta channel
• From your application dashboard

You can retrieve app statistics using the Control API by making a call to the apps endpoint using your APP_ID and ACCESS_TOKEN:

curl 'https://control.ably.net/v1/apps/${APP_ID}/stats' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ${ACCESS_TOKEN}' \
--data-raw '{
    "unit": "hour",
    "limit": 1
}'

Copy
Copied!

This endpoint returns a statistics response type.

App-level statistics are also available programmatically using an Ably SDK at one minute intervals, or aggregated up to the hour, day or month. Whilst it is possible to obtain statistics via the SDKs, this API is not actively maintained and may be deprecated in future. We recommend using app-level stats via the Control API.

The following is an example of querying app-level statistics using the Ably SDK stats method.

RealtimeREST
JavaScriptNode.jsRubyPythonJavaC# .NETObjective-CSwift
realtime_javascript

const realtime = new Ably.Realtime('<loading API key, please wait>');
const resultPage = await realtime.stats({ unit: 'hour' });
console.log(resultPage.items[0]);

API Key:
Demo Only
Copy
Copied!

You can subscribe to app statistics using the [meta]stats:minute metachannel. Events are published at one minute intervals and contain the statistics for the previous minute.

The following is an example of subscribing to the [meta]stats:minute channel:

Realtime
JavaScriptPythonGoFlutterJava
realtime_javascript

const channel = ably.channels.get("[meta]stats:minute");


await channel.subscribe('update', event => {
  console.log(JSON.stringify(event, undefined, 2));
});

Copy
Copied!

App statistics are available as graphs, tabular data, and for download from each application dashboard in your account.

Statistic API and SDK requests return an array of Statistics entry types.

An example simplified response with one stats entry is shown below:

[
  {
    entries: {
      'messages.all.all.count': 245,
      'messages.all.all.data': 58654,
      'messages.all.all.uncompressedData': 58654,
      'messages.all.all.billableCount': 245,
      'messages.all.messages.count': 245,
      'messages.all.messages.data': 58654,
      'messages.all.messages.uncompressedData': 58654,
      'messages.all.messages.billableCount': 245,
      'messages.inbound.realtime.all.count': 145,
      'messages.inbound.realtime.all.data': 29127,
      'messages.inbound.realtime.all.uncompressedData': 29127,
      'messages.inbound.realtime.messages.count': 145,
      ...
    },
    schema: 'https://schemas.ably.com/json/app-stats-0.0.5.json',
    appId: '<appId>',
    inProgress: '2025-01-20:15:11',
    unit: 'hour',
    intervalId: '2025-01-20:15'
  }
]

Copy
Copied!

The following metadata is returned for each entry:

All messages metrics include all messages types, such as those sent and received by Ably and clients, messages delivered via integrations and push notifications delivered to devices.

Inbound messages metrics include those messages that are sent by clients and received inbound from those clients by Ably.

Outbound message metrics include those messages that are sent outbound from Ably to either clients that subscribe or request messages (such as history requests), to integrations, or to push notification targets.

Persisted messages metrics are calculated from the number of messages stored by Ably.

Message deltas metrics are calculated from the number of messages delta generated.

Connection metrics include all realtime connections made to Ably.

Channel metrics include all active channels that are used to separate messages into different topics throughout Ably.

API request metrics include all HTTP requests made to Ably, including those related to token authentication and push notifications. They do not include those requests made to the Control API.

Push notification metrics include all notifications sent to devices via one of the push transports such as APNS, FCM or web.

The following metrics will only be returned when querying account statistics.