Tools do Baremetrics
As 12 operações do Baremetrics que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar fontesGETLista as fontes da conta: cada provedor de pagamento conectado, como o Stripe, e a própria API do Baremetrics. O id de uma fonte é o source_id que planos, clientes e assinaturas aceitam.
- Obter resumo das métricasGETRetorna todas as métricas da conta para cada dia de um período, como mrr, arr, arpu, ltv, active_customers, new_customers e user_churn. Valores monetários vêm em centavos.
- Obter métricaGETRetorna o valor de uma métrica para cada dia de um período, cada um com o valor de compare_to dias antes e a variação percentual. Valores monetários vêm em centavos, então um mrr de 6024087 é 60.240,87.
- Listar clientes de uma métricaGETLista, para cada dia de um período, os clientes que compõem uma métrica, com a contribuição de cada um ao MRR em centavos e o plano atual e o anterior. Por exemplo, a métrica upgrades retorna os clientes que fizeram upgrade no período.
- Obter métrica por planoGETDivide uma métrica por plano para cada dia de um período: cada valor vem com o plano a que pertence. Valores monetários vêm em centavos.
- Listar planosGETLista os planos de uma fonte com name, oid, intervalo de cobrança e valores em centavos. A resposta tem meta.pagination.has_more; envie page para ler a próxima página.
- Listar clientesGETLista os clientes de uma fonte com oid, e-mail, LTV e MRR atual em centavos, planos atuais e se estão ativos ou cancelados. A resposta tem meta.pagination.has_more; envie page para ler a próxima página.
- Listar assinaturasGETLista as assinaturas de uma fonte com cliente, plano, quantidade, desconto e as datas de início e cancelamento como timestamps Unix. A resposta tem meta.pagination.has_more; envie page para ler a próxima página.
- Listar usuáriosGETLista os usuários da conta do Baremetrics com id, nome, e-mail e se são administradores. O id é o user_id que Create annotation aceita.
- Listar anotaçõesGETLista as anotações dos gráficos, cada uma com id, métrica, texto, data, se aparece em todos os gráficos e o usuário que a adicionou. A resposta tem meta.pagination.has_more; envie page para ler a próxima página.
- Criar anotaçãoPOSTAdiciona uma anotação aos gráficos em uma data, como um lançamento ou uma campanha, e a retorna com seu id. Os cinco campos são obrigatórios.
- Excluir anotaçãoDELETEExclui uma anotação dos gráficos. O app responde 202 com o corpo vazio.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
