Metrics

Métriques Kiwify via l'API

Votre client connecte son compte Kiwify et votre produit interroge 59 métriques par le même endpoint que les autres plateformes. Chaque métrique a un identifiant (reference_key) qui figure dans l'appel.

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"
      ]
    }
  ]
}
Exemple : « Total des Produits » en octobre, comparé à septembre.

Plus d'exemples d'appels Kiwify

Le même endpoint pour chaque type de métrique. Les champs metrics et dimensions de chaque élément viennent du catalogue de la plateforme (GET /api/metrics/{integration_slug}).

Graphique

Ventes par Pays

Graphique à barres présentant la répartition des ventes par pays.

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

Tableau

Produits en vedette

Résumé des performances des produits enregistrés dans le compte.

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

Chiffre

Produits Actifs

Nombre de produits actuellement actifs.

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

Chiffres

45 métriques

  • Total des Produits

    Nombre total de produits enregistrés sur la plateforme.

    kiwify:total_products
  • Produits Actifs

    Nombre de produits actuellement actifs.

    kiwify:active_products
  • Total des Commandes

    Nombre total de ventes réalisées pendant la période analysée.

    kiwify:total_orders
  • Revenu Brut Total ($)

    Revenu total généré par les ventes avant toute déduction.

    kiwify:total_gross_revenue
  • Revenu Brut Total (R$)

    Revenu total généré par les ventes avant toute déduction.

    kiwify:total_gross_revenue_brl
  • Revenu Net Total ($)

    Revenu total après déductions telles que frais, remboursements et rétrofacturations.

    kiwify:total_net_revenue
  • Revenu Net Total (R$)

    Revenu total après déductions telles que frais, remboursements et rétrofacturations.

    kiwify:total_net_revenue_brl
  • Ticket Moyen ($)

    Valeur moyenne de chaque transaction de vente.

    kiwify:average_ticket
  • Ticket Moyen (R$)

    Valeur moyenne de chaque transaction de vente.

    kiwify:average_ticket_brl
  • Total Payé aux Partenaires ($)

    Montant total payé aux partenaires dans le cadre du partage des revenus.

    kiwify:total_paid_to_partners
  • Total Payé aux Partenaires (R$)

    Montant total payé aux partenaires dans le cadre du partage des revenus.

    kiwify:total_paid_to_partners_brl
  • Ventes terminées ($)

    Nombre de ventes entièrement réalisées.

    kiwify:completed_sales
  • Ventes Complétées (R$)

    Nombre de ventes entièrement réalisées.

    kiwify:completed_sales_brl
  • Ventes annulées ($)

    Nombre de ventes annulées en raison de problèmes ou d’empêchements.

    kiwify:canceled_sales
  • Ventes Annulées (R$)

    Nombre de ventes annulées en raison de problèmes ou d’empêchements.

    kiwify:canceled_sales_brl
  • Ventes refusées ($)

    Montant total des ventes qui ont été refusées.

    kiwify:refused_sales
  • Ventes refusées (R$)

    Montant total des ventes qui ont été refusées.

    kiwify:refused_sales_brl
  • En attente de paiement ($)

    Montant total des ventes en attente de paiement.

    kiwify:waiting_payment_sales
  • En attente de paiement (R$)

    Montant total des ventes en attente de paiement.

    kiwify:waiting_payment_sales_brl
  • Frais ($)

    Montant total des frais facturés pour les ventes effectuées.

    kiwify:fee
  • Frais (R$)

    Montant total des frais facturés pour les ventes effectuées.

    kiwify:fee_brl
  • Montant des Taxes sur les Ventes ($)

    Montant total des taxes facturées pour les ventes effectuées.

    kiwify:sale_tax_amount
  • Montant des Taxes sur les Ventes (R$)

    Montant total des taxes facturées pour les ventes effectuées.

    kiwify:sale_tax_amount_brl
  • Ventes en attente ($)

    Nombre de ventes en attente de confirmation.

    kiwify:pending_sales
  • Ventes en Attente (R$)

    Nombre de ventes en attente de confirmation.

    kiwify:pending_sales_brl
  • Nombre de ventes remboursées ($)

    Nombre de ventes ayant fait l’objet d’un remboursement.

    kiwify:refunded_count
  • Nombre de Ventes Remboursées (R$)

    Nombre de ventes ayant fait l’objet d’un remboursement.

    kiwify:refunded_count_brl
  • Taux de remboursement ($)

    Pourcentage des ventes ayant entraîné des remboursements.

    kiwify:refund_rate
  • Taux de Remboursement (R$)

    Pourcentage des ventes ayant entraîné des remboursements.

    kiwify:refund_rate_brl
  • Rétrofacturations ($)

    Nombre total de rétrofacturations enregistrées durant la période analysée.

    kiwify:chargebacks
  • Rétrofacturations (R$)

    Nombre total de rétrofacturations enregistrées durant la période analysée.

    kiwify:chargebacks_brl
  • Taux d'approbation de la carte de crédit ($)

    Percentage of card sales that were approved.

    kiwify:credit_card_approval_rate
  • Taux d'approbation de la carte de crédit (R$)

    Percentage of card sales that were approved.

    kiwify:credit_card_approval_rate_brl
  • Ventes par Boleto

    Nombre de ventes effectuées via boleto comme moyen de paiement.

    kiwify:sales_by_bank_slip
  • Ventes par Pix

    Nombre de ventes effectuées via Pix comme moyen de paiement.

    kiwify:sales_by_pix
  • Ventes par carte ($)

    Nombre de ventes effectuées par carte de crédit ou débit.

    kiwify:sales_by_card
  • Ventes par Carte (R$)

    Nombre de ventes effectuées par carte de crédit ou débit.

    kiwify:sales_by_card_brl
  • Taux de rétrofacturation ($)

    Pourcentage des ventes ayant abouti à une rétrofacturation.

    kiwify:chargeback_rate
  • Taux de rétrofacturation (R$)

    Pourcentage des ventes ayant abouti à une rétrofacturation.

    kiwify:chargeback_rate_brl
  • Ventes approuvées par carte ($)

    Number of sales approved using credit or debit card.

    kiwify:approved_card_sales
  • Ventes approuvées par carte (R$)

    Number of sales approved using credit or debit card.

    kiwify:approved_card_sales_brl
  • Taux de Boleto

    Pourcentage des ventes réalisées via boleto.

    kiwify:bank_slip_rate
  • Total des Affiliés

    Nombre total d’affiliés enregistrés dans le système.

    kiwify:total_affiliates
  • Total des Commissions des Affiliés ($)

    Total des commissions versées aux affiliés.

    kiwify:total_affiliate_commissions
  • Total des Commissions des Affiliés (R$)

    Total des commissions versées aux affiliés.

    kiwify:total_affiliate_commissions_brl

Graphiques

11 métriques

  • Ventes par Pays

    Graphique à barres présentant la répartition des ventes par pays.

    kiwify:sales_by_country_chart
  • Ventes par Type de Paiement

    Graphique circulaire représentant la répartition des ventes par méthode de paiement.

    kiwify:sales_by_payment_type_chart
  • Statut des Ventes

    Graphique circulaire indiquant la répartition des ventes par statut, telles qu’approuvées, complétées et annulées.

    kiwify:sales_status_chart
  • Revenu par Produit ($)

    Graphique à barres illustrant les revenus générés par produit.

    kiwify:revenue_by_product_chart
  • Revenu par Produit (R$)

    Graphique à barres illustrant les revenus générés par produit.

    kiwify:revenue_by_product_chart_brl
  • Ticket Moyen par Produit ($)

    Graphique à barres indiquant la valeur moyenne du ticket par produit.

    kiwify:average_ticket_by_product_chart
  • Ticket Moyen par Produit (R$)

    Graphique à barres indiquant la valeur moyenne du ticket par produit.

    kiwify:average_ticket_by_product_chart_brl
  • Ventes au fil du temps ($)

    Graphique linéaire montrant l’évolution des ventes pendant la période sélectionnée.

    kiwify:sales_over_time_chart
  • Ventes au fil du temps (R$)

    Graphique linéaire montrant l’évolution des ventes pendant la période sélectionnée.

    kiwify:sales_over_time_chart_brl
  • Revenus au Fil du Temps ($)

    Graphique linéaire illustrant l’évolution des revenus au fil du temps.

    kiwify:revenue_over_time_chart
  • Revenu au Fil du Temps (R$)

    Graphique linéaire illustrant l’évolution des revenus au fil du temps.

    kiwify:revenue_over_time_chart_brl

Tableaux

3 métriques

  • Produits en vedette

    Résumé des performances des produits enregistrés dans le compte.

    kiwify:products_table
  • Ventes par produit

    Résumé des performances des ventes par produit durant la période analysée.

    kiwify:sales_by_product_table
  • Événements

    Résumé des événements créés avec disponibilité et statistiques d’utilisation des billets.

    kiwify:events

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.