VUZDevelopers

Get revenue summary metrics

GET
/analytics/revenue/summary

Retrieves comprehensive revenue summary metrics for the specified period.

Default Period: Year-to-date (YTD) if no dates provided

Metrics Returned:

  • Total revenue for the period
  • Average monthly revenue
  • Growth rate compared to same period last year
  • Best performing month
  • Total document 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 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/summary"
{  "totalRevenue": 450000.5,  "averageMonthly": 37500.04,  "growthRate": 15.5,  "bestMonth": {    "month": "ינואר 2025",    "monthEn": "January 2025",    "amount": 125000.5  },  "documentCount": 156,  "currency": "ILS",  "startDate": "2025-01-01",  "endDate": "2025-12-31"}