Skip to main content

Client Stats API

Base Path​

  • Combined app: /client/stats
  • Standalone client app: /stats

Authentication and Authorization​

This endpoint requires:

  • Client credentials headers:
    • x-client-id
    • x-client-secret
  • A bearer access token in Authorization: Bearer <token>
  • Permission: client.stats

If any requirement is missing or invalid, the API returns 401 or 403.

Endpoint​

Response Model​

ClientStatsResponse​

  • stats: object/map of { "<stat_key>": <value> }

Error Cases​

  • 401 Unauthorized
    • Missing x-client-id or x-client-secret
    • Invalid client credentials
    • Missing or invalid bearer token
    • Expired token
  • 403 Forbidden
    • Authenticated user does not have client.stats permission