Metrics
WooCommerce metrics via API
Your customer connects their WooCommerce account and your product queries 30 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": "woo_commerce:number_orders_total",
"component": "number_v1",
"metrics": [
"orders_total"
],
"dimensions": [
"orders"
]
}
]
}More WooCommerce 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
Refunds over time
Total amount of money returned to customers through a refund over the analyzed period.
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": "woo_commerce:refunds_over_time",
"component": "chart_v1",
"metrics": [
"refunds"
],
"dimensions": [
"date"
]
}
]
}Table
Revenue per day
Breakdown of the store's daily revenue over the analyzed period.
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": "woo_commerce:revenue_by_day",
"component": "datatable_v1",
"metrics": [
"orders",
"sales",
"net_sales",
"refunds",
"tax",
"shipping",
"coupons"
],
"dimensions": [
"daily_revenue"
]
}
]
}Number
Pending orders
Number of orders received, but payment has not yet been initiated. Orders with this status are not considered paid.
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": "woo_commerce:number_pending_orders",
"component": "number_v1",
"metrics": [
"pending_orders"
],
"dimensions": [
"orders"
]
}
]
}Numbers
16 metrics
Orders
Total number of new orders in the analyzed period, excluding orders with pending payment, canceled orders, and orders with failures.
woo_commerce:number_orders_totalPending orders
Number of orders received, but payment has not yet been initiated. Orders with this status are not considered paid.
woo_commerce:number_pending_ordersOrders on hold
Number of orders on hold.
woo_commerce:number_on_hold_ordersNet discount value
Total sum of coupon discounts during the analyzed period.
woo_commerce:number_net_discountTotal fees
Total value of fees for the analyzed period. The metric is calculated by summing the Order fee + Delivery fee.
woo_commerce:number_total_taxesRefunds
Total amount of money returned to customers through a refund during the analyzed period.
woo_commerce:number_refundsItems sold
The total number of items sold during the analyzed period.
woo_commerce:number_items_soldAverage order value
Average revenue generated by each order placed in the online store. This metric is calculated by dividing the total net sales by the total number of orders during the analyzed period.
woo_commerce:number_avg_order_valueTotal sales
Total sales value for the analyzed period. This metric is calculated as follows: Gross sales – Refunds – Coupons + Fees + Shipping.
woo_commerce:number_total_salesNet sales
Net sales value for the analyzed period. This metric is calculated as follows: Gross sales – Refunds – Coupons.
woo_commerce:number_net_salesGross sales
Sales price of products multiplied by the number of products ordered. Does not include refunds, coupons, fees, or shipping.
woo_commerce:number_gross_salesOrder rate
The total of fees applied to the items in an order during the analyzed period.
woo_commerce:number_order_taxShipping tax
The total of fees applied to the shipping in an order during the analyzed period.
woo_commerce:number_shipping_taxDiscounted orders
Number of orders with a coupon applied during the analyzed period.
woo_commerce:number_orders_with_couponDelivery
Delivery costs associated with an order or refund.
woo_commerce:number_total_deliveryOut of stock products
Number of products that do not have units available in stock for sale.
woo_commerce:number_products_out_of_stock
Charts
8 metrics
Refunds over time
Total amount of money returned to customers through a refund over the analyzed period.
woo_commerce:refunds_over_timeOrders over time
The total number of new orders made over the analyzed period.
woo_commerce:orders_over_timeDeliveries over the period
Deliveries over the period
woo_commerce:deliveries_over_timeAverage order value over time
Average revenue generated by each order made in the online store over the period. This metric is calculated by dividing the total net sales by the total number of orders during the analyzed period.
woo_commerce:avg_order_value_over_timeItems sold over time
The total number of items sold over the analyzed period.
woo_commerce:items_sold_over_timeValue of coupons used
Total sum of discounts from the coupons used over the analyzed period.
woo_commerce:coupon_value_over_timeTotal sales
Total sales value over the analyzed period. This metric is calculated as follows: Gross sales – Refunds – Coupons + Fees + Shipping.
woo_commerce:total_sales_over_timeNet sales over time
Net sales value over the period. This metric is calculated as follows: Gross sales – Refunds – Coupons.
woo_commerce:net_sales_over_time
Tables
6 metrics
Revenue per day
Breakdown of the store's daily revenue over the analyzed period.
woo_commerce:revenue_by_dayFeatured customers
Customers who spent the most money in your store during the analyzed period.
woo_commerce:featured_customers_performancePerformance by category
Summary of performance of your store's product categories over the analyzed period.
woo_commerce:category_performanceCoupon performance
Summary of coupon performance over the analyzed period.
woo_commerce:coupon_performanceFee performance
Summary of performance of fees charged in your store.
woo_commerce:tax_performanceProduct performance
Sales performance of each product in the store during the analyzed period.
woo_commerce:product_performance
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
