Skip to main content
Identities

Get identity statistics

Get aggregate Identity statistics for the current account.

GET /api/v1/forward/identities/stats

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>

Example response

HTTP 200 OK
{
  "total_identities": 12,
  "active_identities": 8,
  "total_agents": 5,
  "total_sessions": 126
}

Response fields

FieldTypeDescription
total_identitiesintegerTotal number of Identities in the current account.
active_identitiesintegerNumber of recently active Identities.
total_agentsintegerNumber of Templates used by the current account.
total_sessionsintegerTotal number of sessions in the current account.

Errors

HTTPTypeCodeTrigger
401authentication_errorauthentication_requiredThe PAT or SAT is invalid, expired, or missing.
500api_error-The statistics query failed.

Notes

active_identities counts Identities that have had activity within the last seven days.