Dashboard Stats

dashboard-stats

Fetches dashboard statistics for the authenticated brand. Supports date ranges, comparison periods, and filtering by workflow.

Parameters

Name	Type	Required	Description	Default
stats	string[]	Yes	List of stat names to fetch (1–10). See available stats below.	—
from	string	No	Start date in YYYY-MM-DD format	30 days ago
to	string	No	End date in YYYY-MM-DD format	Today
compareFrom	string	No	Comparison period start date in YYYY-MM-DD format	—
compareTo	string	No	Comparison period end date in YYYY-MM-DD format	—
workflowId	string	No	Filter stats to a specific workflow	—
timezone	string	No	Timezone for date calculations	America/New_York

Available Stats

conversations, conversationsReplied, orderRecovered, recoveredSales, recoveryRate, commissions, subscriptionRevenue, totalRevenue, aov, impact, totalStoreSales, customerContacted, avgResponseTime

Example Prompt

Show me recovered sales and recovery rate for the last 30 days, compared to the previous 30 days

Example Response

{
  "stats": [
    {
      "name": "recoveredSales",
      "title": "Recovered Sales",
      "description": "Total revenue recovered from abandoned checkouts",
      "currentValue": "$12,450.00",
      "previousValue": "$9,800.00",
      "progress": 27.04,
      "chart": {
        "dates": ["Jan 15", "Jan 16", "Jan 17"],
        "values": [450, 380, 520]
      }
    }
  ],
  "errors": [],
  "dateRange": {
    "from": "2025-01-01",
    "to": "2025-01-31",
    "compareFrom": "2024-12-02",
    "compareTo": "2025-01-01"
  },
  "brandId": "abc-123"
}

Notes

• Request up to 10 stats at once
• The progress field is the percentage change between current and previous periods
• Some stats like recoveryRate, totalRevenue, aov, and impact are computed from multiple underlying metrics
• Use workflowId from list_workflows to see per-flow performance