Analytics
Baremetrics no seu produto e nos seus agentes de IA, por uma API
O toolkit do Baremetrics lê as métricas da conta por dia, com quebra por plano e os clientes por trás de cada métrica, além de fontes, planos, clientes, assinaturas e usuários. Também cria e apaga anotações nos gráficos. Pelo Connect, um produto ou agente de IA acessa esses dados sem construir a integração com o Baremetrics.
15 dias para testar. Sem cartão de crédito.
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>"
}
}Como funciona
Do cliente conectado à primeira chamada no Baremetrics.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do Baremetrics. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o Baremetrics.
Métricas no seu dashboard
Busque mrr, arr, arpu e user_churn de um período e mostre ao lado dos demais dados do seu cliente.
Explicar um pico de churn
Deixe um agente de IA listar os clientes por trás de uma métrica em um dia e a quebra por plano, e resumir o que mudou.
Anotar lançamentos
Crie uma anotação no gráfico quando seu produto lançar uma versão ou iniciar uma campanha, para a data aparecer nos gráficos do Baremetrics.
Tools
12 tools do Baremetrics
- 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.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Perguntas sobre o toolkit do Baremetrics
Preciso implementar a API do Baremetrics?
Não. O Connect já traz 12 tools do Baremetrics descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do Baremetrics?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
