Get Monthly Metrics
profitwell.get_monthly_metrics
ActionBusiness appsconnection required
Calls the ProfitWell API with the connection's credentials.
Read month-by-month subscription trends such as MRR, churn and LTV.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ProfitWell
- Secret shape
- the private API token, or {"api_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
metrics The trends to return, as a comma-separated list such as 'recurring_revenue,active_customers'. Leave blank for every trend ProfitWell publishes for this scope. | string | No | — | — | recurring_revenue,active_customers |
plan_id Only return the trends for this plan id. Leave blank for the whole company — some trends are published only for one or the other. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"metrics": "recurring_revenue,active_customers"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
data One key per requested trend; each value is a list of {date, value} records. | object | — |
trends The trend names present in 'data', sorted. | array | — |
{
"data": {},
"trends": []
}Notes
- Values are monthly: amounts in the company's own currency, rates as percentages (8.3 means 8.3%). A rate can be null when the previous month's base was zero.
See Get Monthly Metrics run in a workflow.
In a technical demo we add the ProfitWell connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.