Obter métrica no Baremetrics, por uma API

Retorna 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.

Identificador
baremetrics_get_metric

A chamada

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>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
metricstringSimName of the metric.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_datestringSimFirst day of the range, YYYY-MM-DD.
end_datestringSimLast day of the range, YYYY-MM-DD.
compare_tointegerNãoHow many days back each value is compared to. The default is 30.

Conexões possíveis

O seu cliente conecta a conta do Baremetrics uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

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.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/baremetrics_get_metric. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Baremetrics

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.