VUZDevelopers

Get the latest weekly business review

GET
/analytics/weekly-review

Retrieves the most recent AI-generated weekly business review.

Generated Every Sunday at 6:00 AM (Israel time)

Data Returned:

  • AI-generated summary in Hebrew and English
  • Key highlights (positive/negative/neutral)
  • Actionable recommendations with priorities
  • Week-over-week comparison metrics
  • Weekly snapshot (revenue, collections, overdue, etc.)

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

week?number

Week number (1-52). If not provided, returns latest review.

year?number

Year. Defaults to current year.

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/weekly-review"
{  "id": "string",  "businessId": "string",  "weekStartDate": "2025-01-05",  "weekEndDate": "2025-01-11",  "weekNumber": 0,  "year": 0,  "status": "pending",  "snapshot": {    "revenue": 0,    "collected": 0,    "newClients": 0,    "overdueAmount": 0,    "totalReceivables": 0,    "expenseTotal": 0,    "topClients": [],    "invoiceCount": 0,    "paidInvoiceCount": 0  },  "summaryHe": "string",  "summaryEn": "string",  "highlights": [    {      "type": "positive",      "textHe": "string",      "textEn": "string",      "metric": {}    }  ],  "recommendations": [    {      "priority": "high",      "textHe": "string",      "textEn": "string",      "actionUrl": "string",      "actionType": "call",      "relatedEntityId": "string",      "relatedEntityType": "client"    }  ],  "weekOverWeekChanges": {    "revenueChange": 0,    "collectionRateChange": 0,    "clientCountChange": 0,    "averageInvoiceChange": 0  },  "currency": "ILS",  "generatedAt": "string",  "isViewed": true,  "createdAt": "string"}