Dashboard
Growth Command Center
Everything the main dashboard needs in one call: KPIs with period-over-period deltas, revenue and order trends, segment breakdown, top and declining products, customer health and detected anomalies.
Authorization
HTTPBearer AuthorizationBearer <token>
JWT access token
In: header
Query Parameters
days?integer
Look-back window in days.
Range
7 <= value <= 180Default
30merchant_id?|
Optional merchant to act on. Must be one you are a member of.
Format
uuidHeader Parameters
X-Merchant-ID?string|null
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/dashboard/overview"{ "data": { "anomalies": [ { "description": "", "detected_on": "2019-08-24", "deviation_pct": 0, "dimension": "overall", "dimension_value": "all", "expected": 0, "label": "string", "metric": "string", "severity": "HIGH", "value": 0, "z_score": 0 } ], "customer_metrics": { "active_customers": 0, "avg_customer_value": 0, "avg_orders_per_customer": 0, "by_daypart": [ { "aov": 0, "avg_service_minutes": 0, "change_pct": 0, "daypart": "string", "label": "string", "negative_review_share_pct": 0, "orders": 0, "repeat_customers": 0, "repeat_customers_change_pct": 0, "revenue": 0, "revenue_share_pct": 0, "service_minutes_change_pct": 0, "unique_customers": 0 } ], "churn_risk_customers": 0, "cohorts": [ { "aov": 0, "change_pct": 0, "customers": 0, "key": "string", "label": "string", "orders": 0, "revenue": 0, "share_pct": 0 } ], "new_customers": 0, "repeat_customers": 0, "repeat_rate": 0, "retention_curve": [ { "cohort_month": "string", "cohort_size": 0, "month_index": 0, "retained": 0, "retention_pct": 0 } ], "retention_rate": 0, "total_customers": 0 }, "daypart_breakdown": [ { "aov": 0, "avg_service_minutes": 0, "change_pct": 0, "daypart": "string", "label": "string", "negative_review_share_pct": 0, "orders": 0, "repeat_customers": 0, "repeat_customers_change_pct": 0, "revenue": 0, "revenue_share_pct": 0, "service_minutes_change_pct": 0, "unique_customers": 0 } ], "declining_products": [ { "attach_rate_pct": 0, "category": "string", "change_pct": 0, "gross_margin": 0, "margin_pct": 0, "name": "string", "orders": 0, "previous_revenue": 0, "price": 0, "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1", "revenue": 0, "revenue_share_pct": 0, "sku": "string", "trend": "UP", "units_sold": 0 } ], "generated_at": "2019-08-24T14:15:22Z", "headline_insight": "", "kpis": [ { "change_abs": 0, "change_pct": 0, "direction": "UP_IS_GOOD", "is_anomaly": false, "key": "string", "label": "string", "previous_value": 0, "sample_size": 0, "unit": "currency", "value": 0 } ], "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "merchant_name": "string", "orders_trend": [ { "date": "2019-08-24", "label": "string", "secondary_value": 0, "value": 0 } ], "period": { "current": { "end": "2019-08-24", "start": "2019-08-24" }, "days": 0, "label": "string", "previous": { "end": "2019-08-24", "start": "2019-08-24" } }, "previous_summary": { "aov": 0, "avg_service_minutes": 0, "discount_total": 0, "gross_margin": 0, "gross_margin_pct": 0, "new_customers": 0, "orders": 0, "repeat_customers": 0, "repeat_rate": 0, "revenue": 0, "unique_customers": 0 }, "provenance": { "data_source": "SEEDED", "is_simulated": true, "note": "Seeded demo dataset - not computed from a live PayPal merchant account." }, "revenue_trend": [ { "date": "2019-08-24", "label": "string", "secondary_value": 0, "value": 0 } ], "summary": { "aov": 0, "avg_service_minutes": 0, "discount_total": 0, "gross_margin": 0, "gross_margin_pct": 0, "new_customers": 0, "orders": 0, "repeat_customers": 0, "repeat_rate": 0, "revenue": 0, "unique_customers": 0 }, "top_products": [ { "attach_rate_pct": 0, "category": "string", "change_pct": 0, "gross_margin": 0, "margin_pct": 0, "name": "string", "orders": 0, "previous_revenue": 0, "price": 0, "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1", "revenue": 0, "revenue_share_pct": 0, "sku": "string", "trend": "UP", "units_sold": 0 } ] }, "meta": {}, "success": true}