VUZDevelopers

Get client segmentation data

GET
/analytics/clients/segments

Retrieves client segmentation based on revenue contribution.

Segment Definitions:

  • Platinum: Top 10% by revenue
  • Gold: Next 20% by revenue
  • Silver: Next 30% by revenue
  • Bronze: Bottom 40% by revenue

Data Returned:

  • Client count per segment
  • Total revenue per segment
  • Average revenue per client in 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

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/clients/segments"
{  "segments": [    {      "segment": "platinum",      "segmentHe": "string",      "segmentEn": "string",      "count": 0,      "percentage": 0,      "totalRevenue": 0,      "avgRevenue": 0,      "color": "string"    }  ],  "topSegmentRevenue": 0,  "avgRevenuePerClient": 0,  "currency": "string"}