VUZDevelopers

Get AI insights dashboard

GET
/analytics/insights/dashboard

Retrieves all AI-generated insights for the business, combined into a single dashboard view.

Insight Categories:

  • Cash Flow: Forecasts, shortage warnings, collection opportunities
  • Client Health: Payment risks, churn risks, dormant clients, star clients
  • Growth (coming soon): Seasonal patterns, opportunities
  • Efficiency (coming soon): Expense anomalies, profitability

Data Returned:

  • Summary counts by priority and category
  • Prioritized list of actionable insights
  • Quick snapshots for cash flow and client health

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

forecastDays?number

Number of days to look ahead for forecasts

Default30
limit?number

Maximum number of insights to return

Default10
includeDismissed?boolean

Include dismissed insights

Defaultfalse

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/insights/dashboard"
{  "summary": {    "totalInsights": 0,    "criticalCount": 0,    "highCount": 0,    "mediumCount": 0,    "lowCount": 0,    "cashFlowCount": 0,    "clientHealthCount": 0,    "growthCount": 0,    "efficiencyCount": 0,    "paymentPagesCount": 0  },  "insights": [    {      "id": "string",      "type": "cash_flow",      "category": "cash_shortage",      "title": "string",      "titleEn": "string",      "description": "string",      "descriptionEn": "string",      "priority": "critical",      "score": 0,      "relatedEntityType": "client",      "relatedEntityId": "string",      "relatedEntityName": "string",      "actionLabel": "string",      "actionLabelEn": "string",      "actionUrl": "string",      "metrics": [        {          "key": "string",          "labelHe": "string",          "labelEn": "string",          "value": {},          "trend": "up",          "unit": "string"        }      ],      "icon": "string",      "generatedAt": "string",      "expiresAt": "string",      "dismissedAt": "string",      "isAiGenerated": false    }  ],  "cashFlowSnapshot": {},  "clientHealthSnapshot": {},  "currency": "string",  "generatedAt": "string"}