Metrics
Kiwify metrics via API
Your customer connects their Kiwify account and your product queries 59 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.
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"
]
}
]
}More Kiwify request examples
The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).
Chart
Sales by Country
Bar chart displaying the distribution of sales by country.
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"
]
}
]
}Table
Featured Products
Performance summary of the products registered in the account.
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"
]
}
]
}Number
Active Products
Number of products that are currently active.
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"
]
}
]
}Numbers
45 metrics
Total Products
Total number of products available on the platform.
kiwify:total_productsActive Products
Number of products that are currently active.
kiwify:active_productsTotal Orders
Total number of sales completed during the analyzed period.
kiwify:total_ordersTotal Gross Revenue ($)
Total revenue generated from sales before any deductions.
kiwify:total_gross_revenueTotal Gross Revenue (R$)
Total revenue generated from sales before any deductions.
kiwify:total_gross_revenue_brlTotal Net Revenue ($)
Total revenue after deductions such as fees, refunds, and chargebacks.
kiwify:total_net_revenueTotal Net Revenue (R$)
Total revenue after deductions such as fees, refunds, and chargebacks.
kiwify:total_net_revenue_brlAverage Ticket ($)
Average value of each sale transaction.
kiwify:average_ticketAverage Ticket (R$)
Average value of each sale transaction.
kiwify:average_ticket_brlTotal Paid to Partners ($)
Total amount paid to partners as part of the revenue sharing.
kiwify:total_paid_to_partnersTotal Paid to Partners (R$)
Total amount paid to partners as part of the revenue sharing.
kiwify:total_paid_to_partners_brlCompleted Sales ($)
Number of sales that have been fully completed.
kiwify:completed_salesCompleted Sales (R$)
Number of sales that have been fully completed.
kiwify:completed_sales_brlCanceled Sales ($)
Number of sales that were canceled due to issues or impediments.
kiwify:canceled_salesCanceled Sales (R$)
Number of sales that were canceled due to issues or impediments.
kiwify:canceled_sales_brlRefused Sales ($)
Total amount of sales that were refused.
kiwify:refused_salesRefused Sales (R$)
Total amount of sales that were refused.
kiwify:refused_sales_brlWaiting Payment ($)
Total amount of sales that are waiting for payment.
kiwify:waiting_payment_salesWaiting Payment (R$)
Total amount of sales that are waiting for payment.
kiwify:waiting_payment_sales_brlFees ($)
Total fees charged for the sales made.
kiwify:feeFees (R$)
Total fees charged for the sales made.
kiwify:fee_brlSale Tax Amount ($)
Total tax amount charged for the sales made.
kiwify:sale_tax_amountSale Tax Amount (R$)
Total tax amount charged for the sales made.
kiwify:sale_tax_amount_brlPending Sales ($)
Number of sales awaiting confirmation.
kiwify:pending_salesPending Sales (R$)
Number of sales awaiting confirmation.
kiwify:pending_sales_brlRefunded Sales Count ($)
Number of sales that have been refunded.
kiwify:refunded_countRefunded Sales Count (R$)
Number of sales that have been refunded.
kiwify:refunded_count_brlRefund Rate ($)
Percentage of sales that resulted in refunds.
kiwify:refund_rateRefund Rate (R$)
Percentage of sales that resulted in refunds.
kiwify:refund_rate_brlChargebacks ($)
Total number of chargebacks recorded during the analyzed period.
kiwify:chargebacksChargebacks (R$)
Total number of chargebacks recorded during the analyzed period.
kiwify:chargebacks_brlCredit Card Approval Rate ($)
Percentage of card sales that were approved.
kiwify:credit_card_approval_rateCredit Card Approval Rate (R$)
Percentage of card sales that were approved.
kiwify:credit_card_approval_rate_brlSales by Bank Slip
Number of sales completed using bank slip as the payment method.
kiwify:sales_by_bank_slipSales by Pix
Number of sales completed using Pix as the payment method.
kiwify:sales_by_pixSales by Card ($)
Number of sales completed using credit or debit card.
kiwify:sales_by_cardSales by Card (R$)
Number of sales completed using credit or debit card.
kiwify:sales_by_card_brlChargeback Rate ($)
Percentage of sales that ended in a chargeback.
kiwify:chargeback_rateChargeback Rate (R$)
Percentage of sales that ended in a chargeback.
kiwify:chargeback_rate_brlApproved Card Sales ($)
Number of sales approved using credit or debit card.
kiwify:approved_card_salesApproved Card Sales (R$)
Number of sales approved using credit or debit card.
kiwify:approved_card_sales_brlBank Slip Rate
Percentage of sales completed using bank slip.
kiwify:bank_slip_rateTotal Affiliates
Total number of affiliates registered in the system.
kiwify:total_affiliatesTotal Affiliate Commissions ($)
Total commissions paid to affiliates.
kiwify:total_affiliate_commissionsTotal Affiliate Commissions (R$)
Total commissions paid to affiliates.
kiwify:total_affiliate_commissions_brl
Charts
11 metrics
Sales by Country
Bar chart displaying the distribution of sales by country.
kiwify:sales_by_country_chartSales by Payment Type
Pie chart representing the distribution of sales across different payment methods.
kiwify:sales_by_payment_type_chartSales Status
Pie chart indicating the distribution of sales by status, such as approved, completed, and canceled.
kiwify:sales_status_chartRevenue by Product ($)
Bar chart illustrating revenue generated per product.
kiwify:revenue_by_product_chartRevenue by Product (R$)
Bar chart illustrating revenue generated per product.
kiwify:revenue_by_product_chart_brlAverage Ticket by Product ($)
Bar chart showing the average ticket value for each product.
kiwify:average_ticket_by_product_chartAverage Ticket by Product (R$)
Bar chart showing the average ticket value for each product.
kiwify:average_ticket_by_product_chart_brlSales Over Time ($)
Line chart depicting the evolution of sales during the selected period.
kiwify:sales_over_time_chartSales Over Time (R$)
Line chart depicting the evolution of sales during the selected period.
kiwify:sales_over_time_chart_brlRevenue Over Time ($)
Line chart showing the evolution of revenue over time.
kiwify:revenue_over_time_chartRevenue Over Time (R$)
Line chart showing the evolution of revenue over time.
kiwify:revenue_over_time_chart_brl
Tables
3 metrics
Featured Products
Performance summary of the products registered in the account.
kiwify:products_tableSales by Product
Performance summary of the sales by product during the analyzed period.
kiwify:sales_by_product_tableEvents
List of events with ticket availability and usage stats.
kiwify:events
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
