VUZDevelopers

Get revenue breakdown by service/product category

GET
/analytics/revenue/by-category

Retrieves revenue breakdown by category based on document item descriptions.

Data Returned:

  • Categories with revenue amounts
  • Percentage of total for each category
  • Item count per category

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)

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/revenue/by-category"
{  "currency": "ILS",  "startDate": "2025-01-01",  "endDate": "2025-12-31",  "categories": [    {      "category": "ייעוץ עסקי",      "categoryEn": "Business Consulting",      "revenue": 180000,      "percentage": 40,      "itemCount": 45    }  ],  "totalRevenue": 450000.5}