VUZDevelopers

Get client growth analytics

GET
/analytics/client-growth

Retrieves time-series data for client 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:

  • New clients per period
  • Total clients at end of each period
  • Active clients at end of each period
  • Summary statistics with growth 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)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/client-growth?period=month"
{  "period": "month",  "startDate": "2024-11-01",  "endDate": "2025-11-09",  "dataPoints": [    {      "date": "2024-11-01",      "label": "נובמבר 2024",      "newClients": 5,      "totalClients": 55,      "activeClients": 42    }  ],  "summary": {    "totalNewClients": 16,    "averagePerPeriod": 5.33,    "growthRate": 29.09,    "previousPeriodTotal": 55  }}