One defined metric
get_metricRead-onlyIdempotent
A financial metric computed by Aggregate with a fixed definition, never estimated: value, basis, as-of time, formula, included and excluded accounts, stale sources, items pending review and how many AI-added entries it includes. It matches what the user sees in the app; a sum of listed rows may not.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Period end (YYYY-MM-DD). | |
| from | No | Period start (YYYY-MM-DD). | |
| basis | No | ||
| metric | Yes | cash: Money in bank, processor and cash-on-hand accounts marked as cash, in home currency. card_balances: What is owed on credit cards right now. net_cash: Cash minus card balances. gross_burn: Average monthly money out over the last 3 full months, excluding transfers between own accounts. net_burn: Average monthly money out minus money in over the last 3 full months. runway: Months until cash runs out at the current net burn. "not_burning" when cash is growing. mrr: Monthly recurring revenue from active subscriptions (Stripe definition). arr: MRR × 12. revenue: Revenue in the period, cash or accrual basis, gross of processor fees (fees are a separate expense, "Processor fees"). Payouts and transfers are not revenue. query_transactions rows show processor charges net of fees, so summing them gives less. ar_open: Total unpaid on invoices you sent. ar_overdue: Unpaid on invoices past their due date. ap_due: Unpaid bills due in the period. payroll_cost: Gross pay plus employer taxes and benefits in the period. recurring_spend: Monthly total of detected recurring charges. owner_balance: What the company owes its owners (+) or they owe it (−): loans, unreimbursed expenses, unspecified owner money. intercompany_balance: What your companies owe each other. fully_diluted: Fully diluted shares and ownership. data_health: Things needing a look, counted and worded exactly as the Workspace shows them: items to review, balances that don't match, transfers not seen arriving, connections not syncing, missing months. 0 means all reconciled; checks shows how many pass. mrr_churn_rate: Last complete month: churned plus downgraded MRR as a fraction of MRR at its start, per customer. net_new_mrr: Last complete month: new + expansion + reactivation − contraction − churned MRR. | |
| company | No | Company name or id, "Personal", or "all". Omit for every company this connection can see. |