Lister les sources avec l'API Baremetrics
Liste les sources du compte : chaque fournisseur de paiement connecté, comme Stripe, et l'API Baremetrics elle-même. L'id d'une source est le source_id que prennent les plans, clients et abonnements.
- Identifiant
- baremetrics_list_sources
L'appel
POST https://connect.reportei.com/api/tools/baremetrics_list_sources/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {}
}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
Cette tool ne prend aucun argument.
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_list_sources. Il devient la définition de tool de votre agent sans conversion.
Autres tools Baremetrics
- Obtenir le résumé des métriquesGETRenvoie toutes les métriques du compte pour chaque jour d'une période, comme mrr, arr, arpu, ltv, active_customers, new_customers et user_churn. Les montants sont en centimes.
- Obtenir une métriqueGETRenvoie 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.
- Lister les clients d'une métriqueGETListe, pour chaque jour d'une période, les clients qui composent une métrique, avec la contribution de chacun au MRR en centimes et le plan actuel et précédent. Par exemple, la métrique upgrades renvoie les clients qui ont fait un upgrade sur la période.
- Obtenir une métrique par planGETVentile une métrique par plan pour chaque jour d'une période : chaque valeur vient avec le plan auquel elle appartient. Les montants sont en centimes.
- Lister les plansGETListe les plans d'une source avec name, oid, intervalle de facturation et montants en centimes. La réponse a meta.pagination.has_more ; envoyez page pour lire la page suivante.
- Lister les clientsGETListe les clients d'une source avec oid, e-mail, LTV et MRR actuel en centimes, plans actuels et s'ils sont actifs ou résiliés. La réponse a meta.pagination.has_more ; envoyez page pour lire la page suivante.
- Lister les abonnementsGETListe les abonnements d'une source avec client, plan, quantité, remise et les dates de début et de résiliation en timestamps Unix. La réponse a meta.pagination.has_more ; envoyez page pour lire la page suivante.
- Lister les utilisateursGETListe les utilisateurs du compte Baremetrics avec id, nom, e-mail et s'ils sont administrateurs. L'id est le user_id que prend Create annotation.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
