Metrics
Métricas do Kiwify pela API
Seu cliente conecta a conta do Kiwify e seu produto consulta 59 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": "kiwify:total_products",
"component": "number_v1",
"metrics": [
"total_products"
],
"dimensions": [
"product"
]
}
]
}Mais exemplos de chamadas no Kiwify
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
Vendas por País
Gráfico de barras mostrando a distribuição das vendas por país.
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": "kiwify:sales_by_country_chart",
"component": "chart_v1",
"metrics": [
"total_orders"
],
"dimensions": [
"country"
]
}
]
}Tabela
Produtos em destaque
Resumo de desempenho dos produtos cadastrados na 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": "kiwify:products_table",
"component": "datatable_v1",
"metrics": [
"status",
"total_orders",
"productPrice",
"affiliates_enabled"
],
"dimensions": [
"product"
]
}
]
}Número
Produtos Ativos
Número de produtos que estão atualmente ativos.
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": "kiwify:active_products",
"component": "number_v1",
"metrics": [
"active_products"
],
"dimensions": [
"product"
]
}
]
}Números
45 métricas
Total de Produtos
Número total de produtos cadastrados na plataforma.
kiwify:total_productsProdutos Ativos
Número de produtos que estão atualmente ativos.
kiwify:active_productsTotal de Pedidos
Número total de vendas concluídas durante o período analisado.
kiwify:total_ordersReceita Bruta Total ($)
Receita total gerada pelas vendas antes de quaisquer deduções.
kiwify:total_gross_revenueReceita Bruta Total (R$)
Receita total gerada pelas vendas antes de quaisquer deduções.
kiwify:total_gross_revenue_brlReceita Líquida Total ($)
Receita total após deduções como taxas, reembolsos e chargebacks.
kiwify:total_net_revenueReceita Líquida Total (R$)
Receita total após deduções como taxas, reembolsos e chargebacks.
kiwify:total_net_revenue_brlTicket Médio ($)
Valor médio de cada transação de venda.
kiwify:average_ticketTicket Médio (R$)
Valor médio de cada transação de venda.
kiwify:average_ticket_brlTotal Pago a Parceiros ($)
Valor total pago aos parceiros como parte do compartilhamento de receita.
kiwify:total_paid_to_partnersTotal Pago a Parceiros (R$)
Valor total pago aos parceiros como parte do compartilhamento de receita.
kiwify:total_paid_to_partners_brlVendas Concluídas ($)
Número de vendas que foram totalmente concluídas.
kiwify:completed_salesVendas Concluídas (R$)
Número de vendas que foram totalmente concluídas.
kiwify:completed_sales_brlVendas Canceladas ($)
Número de vendas que foram canceladas.
kiwify:canceled_salesVendas Canceladas (R$)
Número de vendas que foram canceladas.
kiwify:canceled_sales_brlVendas Recusadas ($)
Valor total das vendas que foram recusadas.
kiwify:refused_salesVendas Recusadas (R$)
Valor total das vendas que foram recusadas.
kiwify:refused_sales_brlAguardando Pagamento ($)
Total amount of sales that are waiting for payment.
kiwify:waiting_payment_salesAguardando Pagamento (R$)
Total amount of sales that are waiting for payment.
kiwify:waiting_payment_sales_brlTaxas ($)
Valor total das taxas cobradas pelas vendas realizadas.
kiwify:feeTaxas (R$)
Valor total das taxas cobradas pelas vendas realizadas.
kiwify:fee_brlValor dos Impostos sobre Vendas ($)
Valor total dos impostos cobrados pelas vendas realizadas.
kiwify:sale_tax_amountValor dos Impostos sobre Vendas (R$)
Valor total dos impostos cobrados pelas vendas realizadas.
kiwify:sale_tax_amount_brlVendas Pendentes ($)
Número de vendas aguardando confirmação.
kiwify:pending_salesVendas Pendentes (R$)
Número de vendas aguardando confirmação.
kiwify:pending_sales_brlContagem de Vendas Reembolsadas ($)
Número de vendas que foram reembolsadas.
kiwify:refunded_countContagem de Vendas Reembolsadas (R$)
Número de vendas que foram reembolsadas.
kiwify:refunded_count_brlTaxa de Reembolso ($)
Porcentagem de vendas que resultaram em reembolsos.
kiwify:refund_rateTaxa de Reembolso (R$)
Porcentagem de vendas que resultaram em reembolsos.
kiwify:refund_rate_brlChargebacks ($)
Número total de chargebacks registrados durante o período analisado.
kiwify:chargebacksChargebacks (R$)
Número total de chargebacks registrados durante o período analisado.
kiwify:chargebacks_brlTaxa de aprovação do cartão de crédito ($)
Percentage of card sales that were approved.
kiwify:credit_card_approval_rateTaxa de aprovação do cartão de crédito (R$)
Percentage of card sales that were approved.
kiwify:credit_card_approval_rate_brlVendas por Boleto
Número de vendas concluídas utilizando boleto como forma de pagamento.
kiwify:sales_by_bank_slipVendas por Pix
Número de vendas concluídas utilizando Pix como forma de pagamento.
kiwify:sales_by_pixVendas por Cartão ($)
Número de vendas concluídas utilizando cartão de crédito ou débito.
kiwify:sales_by_cardVendas por Cartão (R$)
Número de vendas concluídas utilizando cartão de crédito ou débito.
kiwify:sales_by_card_brlTaxa de chargeback ($)
Porcentagem de vendas que resultaram em chargeback.
kiwify:chargeback_rateTaxa de chargeback (R$)
Porcentagem de vendas que resultaram em chargeback.
kiwify:chargeback_rate_brlVendas Aprovadas por Cartão ($)
Number of sales approved using credit or debit card.
kiwify:approved_card_salesVendas Aprovadas por Cartão (R$)
Number of sales approved using credit or debit card.
kiwify:approved_card_sales_brlTaxa de Boleto
Porcentagem de vendas concluídas via boleto.
kiwify:bank_slip_rateTotal de Afiliados
Número total de afiliados registrados no sistema.
kiwify:total_affiliatesTotal de Comissões de Afiliados ($)
Total de comissões pagas aos afiliados.
kiwify:total_affiliate_commissionsTotal de Comissões de Afiliados (R$)
Total de comissões pagas aos afiliados.
kiwify:total_affiliate_commissions_brl
Gráficos
11 métricas
Vendas por País
Gráfico de barras mostrando a distribuição das vendas por país.
kiwify:sales_by_country_chartVendas por Tipo de Pagamento
Gráfico de pizza representando a distribuição das vendas entre diferentes métodos de pagamento.
kiwify:sales_by_payment_type_chartStatus das Vendas
Gráfico de pizza indicando a distribuição das vendas por status, como aprovadas, concluídas e canceladas.
kiwify:sales_status_chartReceita por Produto ($)
Gráfico de barras ilustrando a receita gerada por produto.
kiwify:revenue_by_product_chartReceita por Produto (R$)
Gráfico de barras ilustrando a receita gerada por produto.
kiwify:revenue_by_product_chart_brlTicket Médio por Produto ($)
Gráfico de barras mostrando o valor médio do ticket para cada produto.
kiwify:average_ticket_by_product_chartTicket Médio por Produto (R$)
Gráfico de barras mostrando o valor médio do ticket para cada produto.
kiwify:average_ticket_by_product_chart_brlVendas ao Longo do Tempo ($)
Gráfico de linha mostrando a evolução das vendas durante o período selecionado.
kiwify:sales_over_time_chartVendas ao Longo do Tempo (R$)
Gráfico de linha mostrando a evolução das vendas durante o período selecionado.
kiwify:sales_over_time_chart_brlReceita ao Longo do Tempo ($)
Gráfico de linha mostrando a evolução da receita ao longo do tempo.
kiwify:revenue_over_time_chartReceita ao Longo do Tempo (R$)
Gráfico de linha mostrando a evolução da receita ao longo do tempo.
kiwify:revenue_over_time_chart_brl
Tabelas
3 métricas
Produtos em destaque
Resumo de desempenho dos produtos cadastrados na conta.
kiwify:products_tableVendas por Produto
Resumo de desempenho das vendas por produto durante o período analisado.
kiwify:sales_by_product_tableEventos
Resumos sobre os eventos criados.
kiwify:events
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
