VUZDevelopers

Get weekly review history

GET
/analytics/weekly-review/history

Retrieves historical weekly reviews for the business.

Default: Last 8 weeks

Use cases:

  • Trend analysis over time
  • Week-over-week comparisons
  • Historical reference

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

limit?number

Maximum number of reviews to return

Default8

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/weekly-review/history"
{  "reviews": [    {      "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"    }  ],  "total": 0}