Obtenir une métrique avec l'API Baremetrics

Renvoie la valeur d'une métrique pour chaque jour d'une période, chacune avec la valeur de compare_to jours avant et la variation en pourcentage. Les montants sont en centimes, donc un mrr de 6024087 vaut 60 240,87.

Identifiant
baremetrics_get_metric

L'appel

POST https://connect.reportei.com/api/tools/baremetrics_get_metric/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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
metricstringOuiName of the metric.Valeurs : 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_datestringOuiFirst day of the range, YYYY-MM-DD.
end_datestringOuiLast day of the range, YYYY-MM-DD.
compare_tointegerNonHow many days back each value is compared to. The default is 30.

Connexions possibles

Votre client connecte son compte Baremetrics une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/baremetrics_get_metric. Il devient la définition de tool de votre agent sans conversion.

Autres tools Baremetrics

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.