Metrics
Métricas do Hotmart pela API
Seu cliente conecta a conta do Hotmart e seu produto consulta 33 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"comparison_start": "2026-09-01",
"comparison_end": "2026-09-30",
"metrics": [
{
"id": "m1",
"reference_key": "ht:final_revenue_usd",
"component": "number_v1",
"metrics": [
"final_revenue_usd"
]
}
]
}Mais exemplos de chamadas no Hotmart
O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).
Gráfico
Porcentagem de vendas por produto
Este gráfico mostra o porcentual de vendas agrupado pelos produtos de sua conta.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "ht:purchases_by_product",
"component": "chart_v1",
"metrics": [
"sales_count"
],
"dimensions": [
"product"
]
}
]
}Tabela
Vendas por Produto
Resumo de desempenho dos produtos, durante o período analisado.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "ht:revenue_by_product",
"component": "datatable_v1",
"metrics": [
"sales_count",
"sales_rate",
"revenue_brl",
"revenue_brl_rate",
"revenue_usd",
"revenue_usd_rate",
"revenue_eur",
"revenue_eur_rate"
],
"dimensions": [
"product.name"
]
}
]
}Número
Receita Líquida (R$)
Valor total da receita de vendas, excluindo compras canceladas, chargebacks e reembolsos. Esse valor é calculado reduzindo os valores de compras canceladas, chargebacks e reembolsos da receita total.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "ht:final_revenue_brl",
"component": "number_v1",
"metrics": [
"final_revenue_brl"
]
}
]
}Números
24 métricas
Receita Líquida ($)
Valor total da receita de vendas, excluindo compras canceladas, chargebacks e reembolsos. Esse valor é calculado reduzindo os valores de compras canceladas, chargebacks e reembolsos da receita total.
ht:final_revenue_usdReceita Líquida (R$)
Valor total da receita de vendas, excluindo compras canceladas, chargebacks e reembolsos. Esse valor é calculado reduzindo os valores de compras canceladas, chargebacks e reembolsos da receita total.
ht:final_revenue_brlReceita Líquida (€)
Valor total da receita de vendas, excluindo compras canceladas, chargebacks e reembolsos. Esse valor é calculado reduzindo os valores de compras canceladas, chargebacks e reembolsos da receita total.
ht:final_revenue_eurReceita Total ($)
Valor total da receita de vendas, incluindo compras canceladas, chargebacks e reembolsos.
ht:revenue_usdReceita Total (R$)
Valor total da receita de vendas, incluindo compras canceladas, chargebacks e reembolsos.
ht:revenue_brlReceita Total (€)
Valor total da receita de vendas, incluindo compras canceladas, chargebacks e reembolsos.
ht:revenue_eurValor de chargebacks ($)
Valor total de estornos realizados durante o período analisado. Chargeback é quando o cliente solicita o reembolso da compra diretamente na operadora de seu cartão de crédito.
ht:chargeback_usdValor de chargebacks (R$)
Valor total de estornos realizados durante o período analisado. Chargeback é quando o cliente solicita o reembolso da compra diretamente na operadora de seu cartão de crédito.
ht:chargeback_brlValor de chargebacks (€)
Valor total de estornos realizados durante o período analisado. Chargeback é quando o cliente solicita o reembolso da compra diretamente na operadora de seu cartão de crédito.
ht:chargeback_eurValor total de compras canceladas ($)
Valor total das compras que foram canceladas por algum problema ou impedimento.
ht:canceled_usdValor total de compras canceladas (R$)
Valor total das compras que foram canceladas por algum problema ou impedimento.
ht:canceled_brlValor total de compras canceladas (€)
Valor total das compras que foram canceladas por algum problema ou impedimento.
ht:canceled_eurValor total de reembolsos ($)
Valor total de vendas que foram reembolsadas ou que sofreram chargeback.
ht:refunded_chargeback_usdValor total de reembolsos (R$)
Valor total de vendas que foram reembolsadas ou que sofreram chargeback.
ht:refunded_chargeback_brlValor total de reembolsos (€)
Valor total de vendas que foram reembolsadas ou que sofreram chargeback.
ht:refunded_chargeback_eurReembolsos ($)
Valor total de reembolsos ($)
ht:refunded_usdReembolsos (R$)
Valor total de reembolsos (R$)
ht:refunded_brlReembolsos (€)
Valor total de reembolsos (€)
ht:refunded_eurVendas
Número total de vendas realizadas desconsiderando o número de vendas canceladas.
ht:complete_countVendas canceladas
Número total de vendas que foram canceladas devido algum problema ou impedimento.
ht:canceled_sales_countChargebacks
Número total de estornos realizados durante o período analisado. Chargeback é quando o cliente solicita o reembolso da compra diretamente na operadora de seu cartão de crédito.
ht:chargeback_countTotal de vendas
Número total de vendas com status de aprovadas ou completas, durante o período analisado.
ht:final_sales_amountNúmero de Reembolsos
Número de compras reembolsadas
ht:refunded_sales_countNúmero Total de Reembolsos
Número de compras reembolsadas + estornos
ht:total_refunded_sales_count
Gráficos
8 métricas
Porcentagem de vendas por produto
Este gráfico mostra o porcentual de vendas agrupado pelos produtos de sua conta.
ht:purchases_by_productVendas ao Longo do Tempo
Este gráfico mostra a evolução de suas vendas ao longo do período analisado.
ht:purchases_over_timeReceita ao longo do tempo ($)
Este gráfico mostra a evolução da receita durante o período de análise selecionado. São levadas em conta as vendas aprovadas e completas, sem desconsiderar o valor dos chargebacks e reembolsos.
ht:revenue_over_time_usdReceita ao longo do tempo (R$)
Este gráfico mostra a evolução da receita durante o período de análise selecionado. São levadas em conta as vendas aprovadas e completas, sem desconsiderar o valor dos chargebacks e reembolsos.
ht:revenue_over_time_brlReceita ao longo do tempo (€)
Este gráfico mostra a evolução da receita durante o período de análise selecionado. São levadas em conta as vendas aprovadas e completas, sem desconsiderar o valor dos chargebacks e reembolsos.
ht:revenue_over_time_eurReceita líquida ao longo do tempo ($)
Este gráfico mostra a evolução da receita líquida durante o período de análise selecionado. Apenas vendas aprovadas e completas são consideradas; compras canceladas, chargebacks e reembolsos são excluídos.
ht:final_revenue_over_time_usdReceita líquida ao longo do tempo (R$)
Este gráfico mostra a evolução da receita líquida durante o período de análise selecionado. Apenas vendas aprovadas e completas são consideradas; compras canceladas, chargebacks e reembolsos são excluídos.
ht:final_revenue_over_time_brlReceita líquida ao longo do tempo (€)
Este gráfico mostra a evolução da receita líquida durante o período de análise selecionado. Apenas vendas aprovadas e completas são consideradas; compras canceladas, chargebacks e reembolsos são excluídos.
ht:final_revenue_over_time_eur
Tabelas
1 métrica
Vendas por Produto
Resumo de desempenho dos produtos, durante o período analisado.
ht:revenue_by_product
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
