VUZDevelopers

Get dashboard revenue/collections chart data

GET
/analytics/dashboard-chart

Retrieves time-series data for the dashboard chart showing revenue and collections.

Time Range Options:

  • last7days: Last 7 days (daily granularity)
  • last30days: Last 30 days (daily granularity) - DEFAULT
  • last3months: Last 3 months (weekly granularity)
  • ytd: Year to date (monthly granularity)
  • lastyear: Last 12 months (monthly granularity)
  • custom: Custom range with startDate and endDate

Data Returned:

  • Revenue per period (from tax invoices + tax invoice/receipts)
  • Collections per period (from receipts + tax invoice/receipts)
  • Summary with totals 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

range*string

Time range for the chart

Default"last30days"

Value in

  • "last7days"
  • "last30days"
  • "last3months"
  • "ytd"
  • "lastyear"
  • "custom"
startDate?string

Start date for custom range (ISO date string)

endDate?string

End date for custom 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/dashboard-chart?range=last30days"
{  "range": "last30days",  "granularity": "daily",  "startDate": "2025-12-01",  "endDate": "2025-12-30",  "currency": "ILS",  "dataPoints": [    {      "date": "2025-01-15",      "label": "15 ינואר",      "revenue": 15000.5,      "collections": 12500    }  ],  "summary": {    "totalRevenue": 150000.5,    "totalCollections": 125000,    "collectionRate": 83.28  }}