VUZDevelopers

Get revenue growth analytics

GET
/analytics/revenue-growth

Retrieves time-series data for revenue growth over different periods.

Supported Periods:

  • week: Last 12 weeks by default
  • month: Last 12 months by default (recommended for most use cases)
  • quarter: Last 4 quarters by default
  • year: Last 5 years by default

Data Returned:

  • Total revenue per period (from issued documents)
  • Invoice and receipt counts
  • Paid vs outstanding amounts
  • Average invoice amount
  • Summary statistics with growth rate and collection rate

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

period*string

Time period for grouping data

Value in

  • "week"
  • "month"
  • "quarter"
  • "year"
startDate?string

Start date for analytics range (ISO date string)

endDate?string

End date for analytics range (ISO date string)

currency?string

Currency code for filtering (defaults to business currency)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/revenue-growth?period=month"
{  "period": "month",  "currency": "ILS",  "startDate": "2024-11-01",  "endDate": "2025-11-09",  "dataPoints": [    {      "date": "2024-11-01",      "label": "נובמבר 2024",      "totalRevenue": 45000.5,      "totalInvoices": 25,      "totalReceipts": 18,      "paidAmount": 38000,      "outstandingAmount": 7000.5,      "averageInvoiceAmount": 1800.02    }  ],  "summary": {    "totalRevenue": 145000.5,    "averageRevenue": 48333.5,    "growthRate": 15.56,    "totalInvoicesIssued": 83,    "totalPaymentsReceived": 60,    "collectionRate": 87.24  }}