get_overview
Returns the requested window, current MRR, estimated ARR/ARPU/LTV, subscription/shop counts, observed installs/uninstalls, collections and MRR movements.
On this page
Purpose
Call this first for any question about current business health: MRR, ARR, ARPU, estimated LTV, active subscriptions, installs/uninstalls, collected revenue, and the MRR movement split (new/expansion/contraction/churned) for a time window.
Credentials and scope
Owner workspace credential. The credential determines tool visibility. For tools with appId, use the HeyCrust app UUID from list_apps; the dashboard app selector does not supply MCP arguments for you.
Inputs
appId: optional; string or nulldays: optional; integer or null; default: 30 — Time window in days; null for all time. Default 30.
Example request
The identifiers and merchant are fictional. Replace them with records returned for your own workspace; this example is schema-checked, not a promise that the fictional record exists.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_overview",
"arguments": {
"appId": "11111111-1111-4111-8111-111111111111",
"days": 30
}
}
}
POST this JSON to https://heycrust.com/api/mcp with Content-Type: application/json and Authorization: Bearer <YOUR_CREDENTIAL>. The tool result normally contains JSON encoded as text in result.content; inspect JSON-RPC errors and result.isError before using it.
Result
Returns the requested window, current MRR, estimated ARR/ARPU/LTV, subscription/shop counts, observed installs/uninstalls, collections and MRR movements. scope and dataStatus describe the selected app and source observations; estimates are not collected cash.
Effects and verification
Reads existing records or definitions. It does not create a payment or send a message. Verify the returned app/merchant identity and source coverage before interpreting the result.
Troubleshooting
A missing tool can mean that the credential lacks its catalog or required scopes. Invalid arguments are different from unavailable source data or a record outside the workspace. A handler can return a business error even when the argument schema is valid. Read MCP overview and Help.