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 provide information about all applications in your account.

You can retrieve account statistics from:

• The Control API or REST API
• Your account dashboard

You can retrieve account statistics from the Control API or the REST API.

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 --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_ID}/stats' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ${ACCESS_TOKEN}' \
--data-raw '{
    "unit": "minute",
    "limit": 2
}'

Copy
Copied!

Use the /me endpoint to find your accountId, or alternatively find it in the Settings page of your account dashboard:

curl --location --request GET 'https://control.a...' \
--header 'Authorization: Bearer ${ACCESS_TOKEN}'

Copy
Copied!

You can use the REST API to retrieve account statistics by making a GET request to the stats endpoint. For example, to retrieve account statistics aggregated by hour:

curl https://rest.ably.io/stats?unit=hour \
 -u "<loading API key, please wait>"

API Key:
Demo Only
Copy
Copied!

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

App statistics provide information about a specific 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 appId and accessToken:

curl --location --request POST '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!

Your appId can be found in the Settings tab of an application within your application dashboard.

App-level statistics are also available programmatically using an Ably SDK at one minute intervals, or aggregated up to the hour, day or month.

The following is an example of querying app-level statistics:

RealtimeREST
JavaScriptNode.jsRubyPythonJavaC# .NETObjective-CSwift
Select...

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 channel:

Realtime
JavaScriptPythonGoFlutterJava
Select...

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.

Statistics responses are sparse to reduce the size of the JSON and improve performance.

This means that if a metric is empty, or contains only zero values then the metric will be omitted completely from the response.

{
  entries: {
    'messages.all.all....': 245,
    'messages.all.all....': 58654,
    'messages.all.all....': 58654,
    'messages.all.all....': 245,
    'messages.all.mess...': 245,
    'messages.all.mess...': 58654,
    'messages.all.mess...': 58654,
    'messages.all.mess...': 245,
    'messages.inbound....': 145,
    'messages.inbound....': 29127,
    'messages.inbound....': 29127,
    'messages.inbound....': 145,
    ...
  },
  schema: 'https://schemas.a...',
  appId: '<appId>',
  inProgress: '2025-01-20:15:11',
  unit: 'hour',
  intervalId: '2025-01-20:15'
}

Copy
Copied!

The following metadata is returned for each request:

The following metrics can be returned for all messages. ‘All messages’ includes totals for all messages sent and received by Ably and clients.

The following metrics can be returned for inbound messages. Inbound messages are messages that are sent by clients and received by Ably.

The following metrics can be returned for outbound messages. Outbound messages are messages that are sent from Ably to a client.

The following metrics can be returned for persisted messages. Persisted messages are messages stored by Ably.

The following metrics can be returned for message deltas. Message deltas are messages that are compressed by using the delta feature.

The following metrics can be returned for connections. Connections are all client connections made to Ably.

The following metrics can be returned for channels. Channels are used to separate messages into different topics throughout Ably.

The following metrics can be returned for API requests. API requests are 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.

The following metrics can be returned for push notifications. Push notifications are all notifications sent to devices via a push transport.

The following metrics can only be returned when querying account statistics: