VUZDevelopers

Get client status distribution

GET
/analytics/clients/status

Retrieves distribution of clients by activity status.

Status Definitions:

  • New: Created in last 30 days
  • Active: Transaction in last 90 days
  • Inactive: No transaction in 90-180 days
  • Churned: No transaction in 180+ days

Data Returned:

  • Count and percentage per status
  • At-risk client count (approaching churn)

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/clients/status"
{  "distribution": [    {      "status": "active",      "statusHe": "string",      "statusEn": "string",      "count": 0,      "percentage": 0    }  ],  "atRisk": 0}