get_dashboard_metrics
Return headline dashboard metrics — MRR, active subscribers, churn, and plan-level breakdown — with a period-over-period comparison.
Return headline dashboard metrics for the current creator: MRR, active subscribers, churn, and a plan-level breakdown. Delegates to the same analytics service that powers the Livewire dashboard, so responses ride the same 5-minute cache — agent calls warm the human-facing view and vice versa.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
project_idstringoptionalOptional project UUID to scope the metrics to. Leave blank for all projects in the current team.
periodstringoptionalPeriod preset — 7d, 14d, 30d, 60d, 90d, mtd, qtd, ytd, 1y, all. Defaults to 30d. Ignored when both from and to are supplied.
fromstringoptionalExplicit start date (ISO YYYY-MM-DD). Overrides period when paired with "to".
tostringoptionalExplicit end date (ISO YYYY-MM-DD). Overrides period when paired with "from".
compare_periodstringoptionalBaseline to compare against — "previous" (prior window) or "none". Defaults to "previous".
plan_idsarrayoptionalOptional plan-UUID allow-list.
statusesarrayoptionalOptional SubscriptionStatus allow-list.
payment_method_idsarrayoptionalOptional payment-method UUID allow-list.
What it returns
{ "data": { "mrr": "5280.00", "active_subscribers": 182, "new_subscribers": 14, "churn_rate": 3.2, "by_plan": [ { "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b", "name": "Premium", "active": 120 } ] }, "meta": { "period": "30d", "compare_period": "previous", "project_id": null }}mrr is recurring monthly income from active subscriptions on recurring plans, normalized to a monthly figure from each plan's billing cycle. One-time and lifetime plans do not contribute.
How it fails
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks dashboard:read.
How is this guide?
Last updated on