Analytics
Baremetrics in your product and your AI agents, through one API
The Baremetrics toolkit reads the metrics of the account by day, with breakdowns by plan and the customers behind each metric, plus sources, plans, customers, subscriptions and users. It also creates and deletes chart annotations. Through Connect, a product or AI agent gets this data without building the Baremetrics integration.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/baremetrics_create_annotation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"metric": "<metric>",
"annotation": "<annotation>",
"date": "<date>",
"global": true,
"user_id": "<user_id>"
}
}How it works
From a connected customer to the first Baremetrics call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Baremetrics account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with Baremetrics.
Metrics inside your dashboard
Pull mrr, arr, arpu and user_churn for a date range and show them next to the rest of your customer's data.
Explaining a churn spike
Let an AI agent list the customers behind a metric on a given day and the plan breakout, then summarize what changed.
Annotating launches
Create a chart annotation when your product ships a release or starts a campaign, so the date shows up on the Baremetrics charts.
Tools
12 Baremetrics tools
- List sourcesGETLists the sources of the account: each connected payment provider, such as Stripe, and the Baremetrics API itself. The id of a source is the source_id that plans, customers and subscriptions take.
- Get metrics summaryGETReturns all the metrics of the account for each day of a date range, such as mrr, arr, arpu, ltv, active_customers, new_customers and user_churn. Money values come in cents.
- Get metricGETReturns the value of one metric for each day of a date range, each with the value of compare_to days before and the percent change. Money values come in cents, so an mrr of 6024087 is 60,240.87.
- List metric customersGETLists, for each day of a date range, the customers that make up a metric, with the MRR contribution of each one in cents and the current and previous plan. For example, the upgrades metric returns the customers who upgraded in the range.
- Get metric plan breakoutGETBreaks 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.
- List plansGETLists the plans of a source with name, oid, billing interval and price amounts in cents. The response has meta.pagination.has_more; pass page to read the next page.
- List customersGETLists the customers of a source with oid, email, LTV and current MRR in cents, current plans and whether they are active or canceled. The response has meta.pagination.has_more; pass page to read the next page.
- List subscriptionsGETLists the subscriptions of a source with customer, plan, quantity, discount and the start and cancellation dates as Unix timestamps. The response has meta.pagination.has_more; pass page to read the next page.
- List usersGETLists the users of the Baremetrics account with id, name, email and whether they are admins. The id is the user_id that Create annotation takes.
- List annotationsGETLists the annotations of the charts, each with id, metric, text, date, whether it shows on every chart and the user who added it. The response has meta.pagination.has_more; pass page to read the next page.
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.
Questions about the Baremetrics toolkit
Do I need to build against the Baremetrics API?
No. Connect ships 12 Baremetrics tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their Baremetrics account?
With the mode the toolkit accepts: API key. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
