VUZDevelopers

Get revenue breakdown by client

GET
/analytics/revenue/by-client

Retrieves revenue breakdown by client, showing top clients by revenue.

Data Returned:

  • Top N clients (default 10)
  • Revenue and percentage for each client
  • Document count per client
  • Total for "Other" clients

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 for analytics range (ISO date string)

endDate?string

End date for analytics range (ISO date string)

limit?number

Number of top clients to return

Default10

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/revenue/by-client"
{  "currency": "ILS",  "startDate": "2025-01-01",  "endDate": "2025-12-31",  "clients": [    {      "clientId": "uuid-client-123",      "clientName": "ABC Company Ltd.",      "revenue": 125000.5,      "percentage": 27.8,      "documentCount": 24,      "trend": 12.5    }  ],  "totalClients": 45,  "otherAmount": 85000,  "totalRevenue": 450000.5}