Metrics

Métricas de Kiwify con la API

Tu cliente conecta su cuenta de Kiwify y tu producto consulta 59 métricas por el mismo endpoint que las demás plataformas. Cada métrica tiene un identificador (reference_key) que va en la llamada.

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"
      ]
    }
  ]
}
Ejemplo: "Total de Productos" en octubre, comparado con septiembre.

Más ejemplos de llamadas a Kiwify

El mismo endpoint para cada tipo de métrica. Los campos metrics y dimensions de cada ítem vienen del catálogo de la plataforma (GET /api/metrics/{integration_slug}).

Gráfico

Ventas por País

Gráfico de barras que muestra la distribución de ventas 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"
      ]
    }
  ]
}

Tabla

Productos destacados

Resumen del rendimiento de los productos registrados en la cuenta.

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

Productos Activos

Número de productos que están actualmente activos.

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 Productos

    Número total de productos registrados en la plataforma.

    kiwify:total_products
  • Productos Activos

    Número de productos que están actualmente activos.

    kiwify:active_products
  • Total de Pedidos

    Número total de ventas realizadas durante el período analizado.

    kiwify:total_orders
  • Ingresos Brutos Totales ($)

    Ingresos totales generados por ventas antes de cualquier deducción.

    kiwify:total_gross_revenue
  • Ingresos Brutos Totales (R$)

    Ingresos totales generados por ventas antes de cualquier deducción.

    kiwify:total_gross_revenue_brl
  • Ingresos Netos Totales ($)

    Ingresos totales después de deducciones como tarifas, reembolsos y contracargos.

    kiwify:total_net_revenue
  • Ingresos Netos Totales (R$)

    Ingresos totales después de deducciones como tarifas, reembolsos y contracargos.

    kiwify:total_net_revenue_brl
  • Ticket Promedio ($)

    Valor promedio de cada transacción de venta.

    kiwify:average_ticket
  • Ticket Promedio (R$)

    Valor promedio de cada transacción de venta.

    kiwify:average_ticket_brl
  • Total Pagado a Socios ($)

    Monto total pagado a los socios como parte de la distribución de ingresos.

    kiwify:total_paid_to_partners
  • Total Pagado a Socios (R$)

    Monto total pagado a los socios como parte de la distribución de ingresos.

    kiwify:total_paid_to_partners_brl
  • Ventas concluidas ($)

    Número de ventas que fueron completamente finalizadas.

    kiwify:completed_sales
  • Ventas concluidas (R$)

    Número de ventas que fueron completamente finalizadas.

    kiwify:completed_sales_brl
  • Ventas canceladas ($)

    Número de ventas que fueron canceladas debido a problemas o impedimentos.

    kiwify:canceled_sales
  • Ventas canceladas (R$)

    Número de ventas que fueron canceladas debido a problemas o impedimentos.

    kiwify:canceled_sales_brl
  • Ventas rechazadas ($)

    Valor total de las ventas que fueron rechazadas.

    kiwify:refused_sales
  • Ventas rechazadas (R$)

    Valor total de las ventas que fueron rechazadas.

    kiwify:refused_sales_brl
  • En espera de pago ($)

    Valor total de las ventas que están esperando pago.

    kiwify:waiting_payment_sales
  • En espera de pago (R$)

    Valor total de las ventas que están esperando pago.

    kiwify:waiting_payment_sales_brl
  • Tarifas ($)

    Valor total de las tarifas cobradas por las ventas realizadas.

    kiwify:fee
  • Tarifas (R$)

    Valor total de las tarifas cobradas por las ventas realizadas.

    kiwify:fee_brl
  • Valor de los Impuestos sobre Ventas ($)

    Valor total de los impuestos cobrados por las ventas realizadas.

    kiwify:sale_tax_amount
  • Valor de los Impuestos sobre Ventas (R$)

    Valor total de los impuestos cobrados por las ventas realizadas.

    kiwify:sale_tax_amount_brl
  • Ventas pendientes ($)

    Número de ventas pendientes de confirmación.

    kiwify:pending_sales
  • Ventas pendientes (R$)

    Número de ventas pendientes de confirmación.

    kiwify:pending_sales_brl
  • Conteo de ventas reembolsadas ($)

    Número de ventas que fueron reembolsadas.

    kiwify:refunded_count
  • Conteo de ventas reembolsadas (R$)

    Número de ventas que fueron reembolsadas.

    kiwify:refunded_count_brl
  • Tasa de reembolso ($)

    Porcentaje de ventas que resultaron en reembolsos.

    kiwify:refund_rate
  • Tasa de reembolso (R$)

    Porcentaje de ventas que resultaron en reembolsos.

    kiwify:refund_rate_brl
  • Chargebacks ($)

    Número total de contracargos registrados durante el período analizado.

    kiwify:chargebacks
  • Chargebacks (R$)

    Número total de contracargos registrados durante el período analizado.

    kiwify:chargebacks_brl
  • Tasa de aprobación de la tarjeta de crédito ($)

    Percentage of card sales that were approved.

    kiwify:credit_card_approval_rate
  • Tasa de aprobación de la tarjeta de crédito (R$)

    Percentage of card sales that were approved.

    kiwify:credit_card_approval_rate_brl
  • Ventas por Boleto Bancario

    Número de ventas realizadas utilizando boleto bancario como método de pago.

    kiwify:sales_by_bank_slip
  • Ventas por Pix

    Número de ventas realizadas utilizando Pix como método de pago.

    kiwify:sales_by_pix
  • Ventas por tarjeta ($)

    Número de ventas realizadas utilizando tarjeta de crédito o débito.

    kiwify:sales_by_card
  • Ventas por tarjeta (R$)

    Número de ventas realizadas utilizando tarjeta de crédito o débito.

    kiwify:sales_by_card_brl
  • Tasa de chargeback ($)

    Porcentaje de ventas que terminaron en contracargo.

    kiwify:chargeback_rate
  • Tasa de chargeback (R$)

    Porcentaje de ventas que terminaron en contracargo.

    kiwify:chargeback_rate_brl
  • Ventas aprobadas por tarjeta ($)

    Number of sales approved using credit or debit card.

    kiwify:approved_card_sales
  • Ventas aprobadas por tarjeta (R$)

    Number of sales approved using credit or debit card.

    kiwify:approved_card_sales_brl
  • Tasa de Boletos Bancarios

    Porcentaje de ventas realizadas mediante boleto bancario.

    kiwify:bank_slip_rate
  • Total de Afiliados

    Número total de afiliados registrados en el sistema.

    kiwify:total_affiliates
  • Total de Comisiones de Afiliados ($)

    Total de comisiones pagadas a los afiliados.

    kiwify:total_affiliate_commissions
  • Total de Comisiones de Afiliados (R$)

    Total de comisiones pagadas a los afiliados.

    kiwify:total_affiliate_commissions_brl

Gráficos

11 métricas

  • Ventas por País

    Gráfico de barras que muestra la distribución de ventas por país.

    kiwify:sales_by_country_chart
  • Ventas por Tipo de Pago

    Gráfico circular que representa la distribución de ventas por diferentes métodos de pago.

    kiwify:sales_by_payment_type_chart
  • Estado de Ventas

    Gráfico circular indicando la distribución de ventas por estado, como aprobadas, completadas y canceladas.

    kiwify:sales_status_chart
  • Ingresos por Producto ($)

    Gráfico de barras que ilustra los ingresos generados por producto.

    kiwify:revenue_by_product_chart
  • Ingresos por Producto (R$)

    Gráfico de barras que ilustra los ingresos generados por producto.

    kiwify:revenue_by_product_chart_brl
  • Ticket Promedio por Producto ($)

    Gráfico de barras que muestra el valor promedio del ticket por producto.

    kiwify:average_ticket_by_product_chart
  • Ticket Promedio por Producto (R$)

    Gráfico de barras que muestra el valor promedio del ticket por producto.

    kiwify:average_ticket_by_product_chart_brl
  • Ventas a lo largo del tiempo ($)

    Gráfico de líneas mostrando la evolución de ventas durante el período seleccionado.

    kiwify:sales_over_time_chart
  • Ventas a lo largo del tiempo (R$)

    Gráfico de líneas mostrando la evolución de ventas durante el período seleccionado.

    kiwify:sales_over_time_chart_brl
  • Ingresos a lo Largo del Tiempo ($)

    Gráfico de líneas mostrando la evolución de los ingresos a lo largo del tiempo.

    kiwify:revenue_over_time_chart
  • Ingresos a lo largo del tiempo (R$)

    Gráfico de líneas mostrando la evolución de los ingresos a lo largo del tiempo.

    kiwify:revenue_over_time_chart_brl

Tablas

3 métricas

  • Productos destacados

    Resumen del rendimiento de los productos registrados en la cuenta.

    kiwify:products_table
  • Ventas por producto

    Resumen del rendimiento de las ventas por producto durante el período analizado.

    kiwify:sales_by_product_table
  • Eventos

    Resumen de eventos creados con estadísticas de disponibilidad y uso de entradas.

    kiwify:events

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.