API ReferenceAnalytics
Analytics
Aggregated login, signup, MFA adoption, and method-breakdown metrics for your tenant.
Analytics
AnalyticsService exposes read-only metrics over your tenant's authentication activity. Results are aggregated server-side; all endpoints are idempotent GETs.
Use it to power:
- Custom dashboards beyond the built-in
/developer/observabilitypages. - Weekly executive reports on MFA adoption and signup funnel.
- Anomaly detection -- compare current hour's login volume against the previous day.
Base URL: https://<Domain id="api"/>
Authentication: Bearer API key with analytics:read scope, or an admin session token.
RPCs
| Method | Path | Purpose |
|---|---|---|
| GetLoginMetrics | GET /v1/analytics:getLoginMetrics | Login counts + success rate over a time range |
| GetSignupMetrics | GET /v1/analytics:getSignupMetrics | Signup counts + activation funnel |
| GetMfaAdoption | GET /v1/analytics:getMfaAdoption | MFA enrollment breakdown by factor type |
| GetMethodBreakdown | GET /v1/analytics:getMethodBreakdown | Auth method usage (password, passkey, social, etc.) |
Granularity
Time-series endpoints accept a granularity query parameter:
| Value | Use when |
|---|---|
TIME_GRANULARITY_HOUR | Ranges under 72h |
TIME_GRANULARITY_DAY | Ranges under 90d |
TIME_GRANULARITY_WEEK | Quarter-level reporting |
TIME_GRANULARITY_MONTH | Year-level reporting |
Omit granularity to auto-select based on the range.
Data freshness
Metrics are computed from the audit event stream with a median 30s lag. Do not use these endpoints for per-request rate-limit decisions -- use RiskService.Assess for real-time checks.