Analytics & Billing

Every route below requires an administrator bearer token.

`GET /analytics/accuracy`

string

ISO date, optional

string

ISO date, optional

200 OK

{
  "totalIdentifyCalls": 3,
  "outcomeRates": { "match": 0.33, "no_match": 0.33, "liveness_failed": 0.33 },
  "proxyDisputedMatchRate": 0,
  "note": "outcomeRates and proxyDisputedMatchRate are proxies computed from operational logs, not calibrated FAR/FRR against a labeled validation set"
}

This is not a calibrated false-accept/false-reject rate. True FAR/FRR requires a labeled ground-truth validation set (known-genuine vs. known-impostor pairs) — see face-engine’s own COMPARE_THRESHOLD calibration notes in docs/models.mdx for why. What’s returned here are the closest honest proxies computable from operational logs alone: outcome-rate breakdowns, and a disputed-match rate as a weak signal for suspected false accepts.

`GET /analytics/volume`

Same query params as above.

200 OK

{ "breakdown": [{ "kind": "identify", "decision": "match", "count": 42 }, ...], "total": 210 }

`GET /billing/{orgId}`

200 OK

{ "orgId": "org-1", "tier": "standard", "monthlyIncludedVerifications": 10000, "usageThisMonth": 3, "overage": 0 }

Reads from a static contracted-tier config (CONTRACTED_TIERS in src/modules/analytics/service.ts) — no real billing/contracts system exists yet, this is a read-only reporting stub.

Getting Started

Architecture

Security

API Reference

`GET /analytics/accuracy`

`GET /analytics/volume`

`GET /billing/{orgId}`

​GET /analytics/accuracy

​GET /analytics/volume

​GET /billing/{orgId}

`GET /analytics/accuracy`

`GET /analytics/volume`

`GET /billing/{orgId}`