API ReferenceDashboard

Dashboard API

Portal dashboard endpoints for KPIs, goals, ROI tracking, and action items.

GET /api/dashboard/kpis

Get key performance indicators for the current client.

Auth: Required (portal session)

Response:

{ "kpis": { "visibilityScore": 78, "contentHealth": 85, "reviewScore": 4.2, "socialEngagement": 1250 } }

Cache: s-maxage=300 (5 min CDN cache)

GET /api/dashboard/goals

Get active goals and progress for the current client.

Auth: Required

Response (200):

{ "ok": true, "data": [ { "goal_id": "g1", "title": "Increase New Patients", "goal_type": "leads", "category": "growth", "target_value": 60, "current_value": 48, "baseline_value": 35, "unit": "count", "status": "in_progress", "priority": "high", "progress_percent": 52, "is_overdue": false, "deadline": "2026-03-31" } ], "summary": { "total": 4, "completed": 1, "inProgress": 2, "overdue": 1 } }

Export: GET /api/exports/goals returns CSV download.

GET /api/dashboard/roi

Get ROI metrics and financial impact data.

Auth: Required

Response:

{ "roi": { "totalInvestment": 5000, "estimatedReturn": 15000, "roiPercentage": 200, "period": "quarterly" } }

GET /api/dashboard/action-items

Get prioritized action items for the current client.

Auth: Required

Response: Array of action items with priority, status, and due dates.

GET /api/dashboard/content-impact

Get content performance impact metrics.

Auth: Required

Response: Content engagement, conversion, and traffic attribution data.

Last updated on