VUZDevelopers

Get top clients by value

GET
/analytics/clients/top

Retrieves top clients ranked by revenue, LTV, or transaction count.

Sort Options:

  • revenue: Total revenue (default)
  • ltv: Lifetime value
  • transactions: Transaction count

Data Returned:

  • Client details (name, ID)
  • Total revenue and transaction count
  • First and last transaction dates
  • Client status and segment

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

limit?number

Number of clients to return

Default10
sortBy?string
Default"revenue"

Value in

  • "ltv"
  • "revenue"
  • "transactions"

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/clients/top"
{  "clients": [    {      "id": "string",      "name": "string",      "totalRevenue": 0,      "transactionCount": 0,      "avgTransactionValue": 0,      "firstTransaction": "string",      "lastTransaction": "string",      "status": "active",      "segment": "platinum"    }  ],  "currency": "string",  "totalCount": 0}