VUZDevelopers

Get business health score

GET
/analytics/health-score

Calculates a composite health score (0-100) based on 5 weighted components:

Components & Weights:

  • Collection Rate (25%): How well invoices are collected
  • Growth Rate (25%): Revenue growth compared to previous period
  • Client Diversity (20%): Revenue distribution across clients
  • Cash Flow (15%): Ratio of collections to expenses
  • Expense Ratio (15%): Expenses as percentage of revenue

Score Levels:

  • 90+: Excellent
  • 70-89: Good
  • 50-69: Fair
  • 30-49: Needs Attention
  • 0-29: Critical

Data Returned:

  • Overall score and level
  • Detailed breakdown by component
  • Trend (improving/stable/declining)
  • Actionable recommendations
  • Historical data for visualization

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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/health-score"
{  "score": 82,  "level": "good",  "levelLabelHe": "טוב",  "levelLabelEn": "Good",  "trend": "improving",  "scoreChange": 5,  "breakdown": {    "collectionRate": {      "name": "collectionRate",      "labelHe": "גבייה",      "labelEn": "Collection Rate",      "value": 85.5,      "score": 85,      "weight": 0.25,      "weightedScore": 21.25,      "icon": "fi-rr-money-check-edit",      "context": "85.5% of invoices collected within 30 days"    },    "growthRate": {      "name": "collectionRate",      "labelHe": "גבייה",      "labelEn": "Collection Rate",      "value": 85.5,      "score": 85,      "weight": 0.25,      "weightedScore": 21.25,      "icon": "fi-rr-money-check-edit",      "context": "85.5% of invoices collected within 30 days"    },    "clientDiversity": {      "name": "collectionRate",      "labelHe": "גבייה",      "labelEn": "Collection Rate",      "value": 85.5,      "score": 85,      "weight": 0.25,      "weightedScore": 21.25,      "icon": "fi-rr-money-check-edit",      "context": "85.5% of invoices collected within 30 days"    },    "cashFlow": {      "name": "collectionRate",      "labelHe": "גבייה",      "labelEn": "Collection Rate",      "value": 85.5,      "score": 85,      "weight": 0.25,      "weightedScore": 21.25,      "icon": "fi-rr-money-check-edit",      "context": "85.5% of invoices collected within 30 days"    },    "expenseRatio": {      "name": "collectionRate",      "labelHe": "גבייה",      "labelEn": "Collection Rate",      "value": 85.5,      "score": 85,      "weight": 0.25,      "weightedScore": 21.25,      "icon": "fi-rr-money-check-edit",      "context": "85.5% of invoices collected within 30 days"    }  },  "recommendations": [    {      "priority": "high",      "textHe": "שפרו את שיעור הגבייה על ידי מעקב אחר חשבוניות פתוחות",      "textEn": "Improve collection rate by following up on open invoices",      "component": "collectionRate",      "actionPath": "/app/analytics/collections"    }  ],  "history": [    {      "date": "2025-12-01",      "score": 78    }  ],  "calculatedAt": "2025-12-30T10:30:00Z",  "period": "last_30_days"}