Skip to main content
The Dashboard Data API provides pre-aggregated analytics for the platform’s monitoring dashboards. Data is aggregated via SQL to avoid loading large result sets.

GET /api/v1/dashboard-data

Retrieve dashboard data by type.

Query Parameters

ParameterTypeRequiredDescription
typestringNoData type to retrieve (default: summary)

Data Types

TypeDescription
summaryHigh-level counts: active offers, channels, experiments, journeys, triggers, pending approvals
acceptance_rateAcceptance rate per offer (impressions vs. positive outcomes)
offer_performanceTop 20 active offers with impressions, conversions, revenue, and conversion rate
channel_effectivenessImpressions, conversions, and effectiveness rate per channel
budget_burnBudget allocation utilization: allocated, spent, remaining, burn rate
funnelOffer funnel: total offers, active, with creatives, active creatives
attribution_summaryAttribution results grouped by model with conversion counts and total value
daily_trend7-day trend of impressions and conversions
model_metrics_trendAUC trend and feature importance from active algorithm models

Example

curl "https://playground.kaireonai.com/api/v1/dashboard-data?type=summary" \
  -H "X-Tenant-Id: my-tenant"

Response — summary

{
  "activeOffers": 15,
  "activeChannels": 4,
  "activeExperiments": 2,
  "totalJourneys": 3,
  "activeTriggers": 5,
  "pendingApprovals": 1
}

Response — offer_performance

{
  "data": [
    {
      "offerId": "clx...",
      "name": "Premium Card Upgrade",
      "priority": 90,
      "creativeCount": 3,
      "impressions": 1250,
      "conversions": 87,
      "revenue": 4350.00,
      "conversionRate": "7.0"
    }
  ]
}

Response — daily_trend

{
  "data": [
    { "name": "Mar 12", "impressions": 340, "conversions": 22 },
    { "name": "Mar 13", "impressions": 420, "conversions": 31 },
    { "name": "Mar 14", "impressions": 380, "conversions": 28 }
  ]
}

Response — model_metrics_trend

{
  "aucTrend": [
    { "name": "Mar 15", "auc": 0.82 },
    { "name": "Mar 16", "auc": 0.84 }
  ],
  "featureImportance": [
    { "name": "tenure_months", "value": 0.32 },
    { "name": "monthly_spend", "value": 0.28 }
  ],
  "modelCount": 2
}