Obtener métrica por plan en Baremetrics, con una API
Desglosa una métrica por plan para cada día de un rango de fechas: cada valor viene con el plan al que pertenece. Los valores monetarios vienen en centavos.
- Identificador
- baremetrics_get_metric_plan_breakout
La llamada
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>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| metric | string | Sí | Name of the metric to break down, for example mrr.Valores: 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_date | string | Sí | First day of the range, YYYY-MM-DD. |
| end_date | string | Sí | Last day of the range, YYYY-MM-DD. |
Conexiones posibles
Tu cliente conecta su cuenta de Baremetrics una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/baremetrics_get_metric_plan_breakout. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Baremetrics
- Listar fuentesGETLista las fuentes de la cuenta: cada proveedor de pagos conectado, como Stripe, y la propia API de Baremetrics. El id de una fuente es el source_id que aceptan planes, clientes y suscripciones.
- Obtener resumen de métricasGETDevuelve todas las métricas de la cuenta para cada día de un rango de fechas, como mrr, arr, arpu, ltv, active_customers, new_customers y user_churn. Los valores monetarios vienen en centavos.
- Obtener métricaGETDevuelve el valor de una métrica para cada día de un rango de fechas, cada uno con el valor de compare_to días antes y el cambio porcentual. Los valores monetarios vienen en centavos, así que un mrr de 6024087 es 60.240,87.
- Listar clientes de una métricaGETLista, para cada día de un rango de fechas, los clientes que componen una métrica, con la contribución de cada uno al MRR en centavos y el plan actual y el anterior. Por ejemplo, la métrica upgrades devuelve los clientes que hicieron upgrade en el rango.
- Listar planesGETLista los planes de una fuente con name, oid, intervalo de facturación e importes en centavos. La respuesta tiene meta.pagination.has_more; envía page para leer la página siguiente.
- Listar clientesGETLista los clientes de una fuente con oid, correo, LTV y MRR actual en centavos, planes actuales y si están activos o cancelados. La respuesta tiene meta.pagination.has_more; envía page para leer la página siguiente.
- Listar suscripcionesGETLista las suscripciones de una fuente con cliente, plan, cantidad, descuento y las fechas de inicio y cancelación como timestamps Unix. La respuesta tiene meta.pagination.has_more; envía page para leer la página siguiente.
- Listar usuariosGETLista los usuarios de la cuenta de Baremetrics con id, nombre, correo y si son administradores. El id es el user_id que acepta Create annotation.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
