Skip to content

Commands

alter analytics

Read-only usage analytics for the organization.

Read-only usage analytics — API-call volume, provider/app breakdowns, policy decision counts, latency, and errors. Handy for CI dashboards and monitoring jobs.

alter analytics api-calls [--app ...] [--provider ...] [--start ...] [--end ...] [--granularity ...]
alter analytics by-provider [--app ...] [--start ...] [--end ...]
alter analytics by-app [--start ...] [--end ...]
alter analytics summary
alter analytics policy [--app ...] [--start ...] [--end ...]
alter analytics latency [--app ...] [--start ...] [--end ...]
alter analytics errors [--app ...] [--start ...] [--end ...]
alter analytics dashboard

All subcommands require the dashboard_analytics:read scope and return aggregates only (never policy configuration). When --start / --end are omitted the window defaults to the last 30 days. Output defaults to JSON since the payloads are nested.

Common flags — each subcommand accepts only the filters its endpoint honors:

FlagDefaultDescriptionAccepted by
--app <app-id>all appsFilter by application ID.api-calls, by-provider, policy, latency, errors
--start <iso>30 days agoWindow start (ISO 8601).all except summary and dashboard
--end <iso>nowWindow end (ISO 8601).all except summary and dashboard

by-app is already a per-app breakdown, so it takes no --app filter; summary and dashboard are org-wide rollups with no filters at all.

API-call volume over time, with success/failure breakdown.

FlagDefaultDescription
--provider <provider-id>allFilter to one OAuth provider.
--granularity <bucket>dayTime bucket: hour, day, week, or month.
Terminal window
alter analytics api-calls --granularity week

API-call breakdown by OAuth provider.

Terminal window
alter analytics by-provider --start 2026-05-01

API-call breakdown by application.

Terminal window
alter analytics by-app

High-level summary statistics (totals, success rate, busiest provider/app).

Terminal window
alter analytics summary

Policy decision analytics — ALLOW vs DENY counts and the top denied providers.

Terminal window
alter analytics policy --output table

Latency metrics (average and percentiles, broken down by provider).

Terminal window
alter analytics latency

Error breakdown by status code and provider.

Terminal window
alter analytics errors

Org-level summary stats (app counts, user metrics, connection statistics, popular providers, API usage). No date/app filters.

Terminal window
alter analytics dashboard