AblyDocs

Stats app

Open in

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

Synopsis

ably stats app [app-name-or-id] [options]

Arguments

app-name-or-id

The app name or ID to retrieve stats for. If not provided, the currently selected app is used.

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 stats for the current app:

ably stats app

Retrieve stats for a specific app:

ably stats app app-id

Retrieve stats for an app by name:

ably stats app "My App"

Retrieve hourly stats:

ably stats app --unit hour

Subscribe to live stats updates:

ably stats app --live

Retrieve hourly stats for a specific app:

ably stats app app-id --unit hour

Retrieve stats for a specific app within a time range:

ably stats app app-id --start "2023-01-01T00:00:00Z" --end "2023-01-02T00:00:00Z"

Retrieve stats for a specific app from the last hour:

ably stats app app-id --start 1h

Retrieve a limited number of stats entries for a specific app:

ably stats app app-id --limit 10

Retrieve stats for an app by name with options:

ably stats app "My App" --start 1h --limit 10

Subscribe to live stats for a specific app:

ably stats app app-id --live

Subscribe to live stats with a custom polling interval:

ably stats app --live --interval 15

Retrieve app stats in JSON format:

ably stats app app-id --json

Retrieve app stats in formatted JSON output:

ably stats app app-id --pretty-json

See also

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