VUZDevelopers

Get revenue trend data

GET
/analytics/revenue/trend

Retrieves time-series revenue trend data for visualization.

Granularity Options:

  • daily: Individual day data points
  • weekly: Weekly aggregated data
  • monthly: Monthly aggregated data (default)

Data Returned:

  • Revenue per period
  • Moving average (3-period)
  • Document count per period

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)

granularity?string

Granularity of data points

Default"monthly"

Value in

  • "daily"
  • "weekly"
  • "monthly"

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/revenue/trend"
{  "granularity": "monthly",  "currency": "ILS",  "startDate": "2025-01-01",  "endDate": "2025-12-31",  "dataPoints": [    {      "date": "2025-01-01",      "label": "ינואר 2025",      "labelEn": "January 2025",      "revenue": 45000.5,      "movingAverage": 42000,      "previousPeriod": 38000,      "documentCount": 12    }  ],  "totalRevenue": 450000.5}