VUZDevelopers

Get client summary metrics

GET
/analytics/clients/summary

Retrieves comprehensive client summary metrics for the business.

Metrics Returned:

  • Total clients count
  • Active clients (transaction in last 90 days)
  • New clients in the period
  • Retention rate
  • Churn rate
  • Average lifetime value (LTV)
  • At-risk clients count

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

Query Parameters

startDate?string

Start date (ISO format)

endDate?string

End date (ISO format)

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/clients/summary"
{  "totalClients": 0,  "activeClients": 0,  "newClients": 0,  "retentionRate": 0,  "churnRate": 0,  "avgLifetimeValue": 0,  "currency": "string",  "atRiskClients": 0}