Stats account

Open in

Use the ably stats account command to get account-level statistics with optional live updates.

Synopsis

ably stats account [options]

Options

--start

The start of the time range to retrieve stats from. Accepts ISO 8601, Unix milliseconds, or relative time formats.

--end

The end of the time range to retrieve stats from. Accepts ISO 8601, Unix milliseconds, or relative time formats.

--unit

The unit of time for the stats interval. Options are minute, hour, day, or month. Defaults to minute.

--limit

The maximum number of stats records to retrieve. Defaults to 10.

--live

Subscribe to live stats updates at minute intervals. Defaults to false.

--interval

The polling interval in seconds for live mode. Defaults to 6.

--debug

Show debug information for live polling. Defaults to false.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

Retrieve recent account stats:

ably stats account

Retrieve hourly stats:

ably stats account --unit hour

Retrieve stats within a time range:

ably stats account --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z"

Subscribe to live stats updates:

ably stats account --live

Subscribe to live stats with a custom polling interval:

ably stats account --live --interval 10

Retrieve account stats from the last hour using relative time:

ably stats account --start 1h

Retrieve a limited number of account stats entries:

ably stats account --limit 10

Retrieve account stats in JSON format:

ably stats account --json

Retrieve account stats in formatted JSON output:

ably stats account --pretty-json

Output

The ably accounts stats command displays statistics for each time period:

MetricDescription
ConnectionsPeak, minimum, mean connections, plus opened, refused, and active counts
ChannelsPeak, minimum, mean channels, plus opened, refused, and active counts
MessagesTotal, published, delivered message counts and data volume
API RequestsSucceeded, failed, refused, and total request counts
Token RequestsSucceeded, failed, and refused token request counts
Peak RatesMaximum rates per second for messages, connections, channels, API requests, and token requests

See also

  • Stats — Explore all ably stats commands.
  • CLI reference — Full list of available commands.