Get metric plan breakout with the Baremetrics API

Breaks a metric down by plan for each day of a date range: each value comes with the plan it belongs to. Money values come in cents.

Identifier
baremetrics_get_metric_plan_breakout

The request

POST https://connect.reportei.com/api/tools/baremetrics_get_metric_plan_breakout/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "metric": "active_customers",
    "start_date": "<start_date>",
    "end_date": "<end_date>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
metricstringYesName of the metric to break down, for example mrr.Values: active_customers, active_subscriptions, active_trials, arpu, arr, cancellations, churned_customers, converted_trials, coupons, downgrades, failed_charges, fees, ltv, mrr, mrr_growth_rate, net_revenue, net_revenue_churn, new_customers, new_subscriptions, new_trials, other_revenue, plan_quantities, quick_ratio, reactivations, refunds, revenue_churn, trial_conversion, trial_time_to_cancelation, trial_time_to_conversion, upgrades, user_churn
start_datestringYesFirst day of the range, YYYY-MM-DD.
end_datestringYesLast day of the range, YYYY-MM-DD.

Supported connections

Your customer connects their Baremetrics account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/baremetrics_get_metric_plan_breakout. It becomes your agent's tool definition with no conversion.

Other Baremetrics tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.