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"
      ]
    }
  ]
}
Example: "Orders" in October, compared to September.

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_total
  • Pending orders

    Number of orders received, but payment has not yet been initiated. Orders with this status are not considered paid.

    woo_commerce:number_pending_orders
  • Orders on hold

    Number of orders on hold.

    woo_commerce:number_on_hold_orders
  • Net discount value

    Total sum of coupon discounts during the analyzed period.

    woo_commerce:number_net_discount
  • Total fees

    Total value of fees for the analyzed period. The metric is calculated by summing the Order fee + Delivery fee.

    woo_commerce:number_total_taxes
  • Refunds

    Total amount of money returned to customers through a refund during the analyzed period.

    woo_commerce:number_refunds
  • Items sold

    The total number of items sold during the analyzed period.

    woo_commerce:number_items_sold
  • Average 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_value
  • Total sales

    Total sales value for the analyzed period. This metric is calculated as follows: Gross sales – Refunds – Coupons + Fees + Shipping.

    woo_commerce:number_total_sales
  • Net sales

    Net sales value for the analyzed period. This metric is calculated as follows: Gross sales – Refunds – Coupons.

    woo_commerce:number_net_sales
  • Gross sales

    Sales price of products multiplied by the number of products ordered. Does not include refunds, coupons, fees, or shipping.

    woo_commerce:number_gross_sales
  • Order rate

    The total of fees applied to the items in an order during the analyzed period.

    woo_commerce:number_order_tax
  • Shipping tax

    The total of fees applied to the shipping in an order during the analyzed period.

    woo_commerce:number_shipping_tax
  • Discounted orders

    Number of orders with a coupon applied during the analyzed period.

    woo_commerce:number_orders_with_coupon
  • Delivery

    Delivery costs associated with an order or refund.

    woo_commerce:number_total_delivery
  • Out 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_time
  • Orders over time

    The total number of new orders made over the analyzed period.

    woo_commerce:orders_over_time
  • Deliveries over the period

    Deliveries over the period

    woo_commerce:deliveries_over_time
  • Average 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_time
  • Items sold over time

    The total number of items sold over the analyzed period.

    woo_commerce:items_sold_over_time
  • Value of coupons used

    Total sum of discounts from the coupons used over the analyzed period.

    woo_commerce:coupon_value_over_time
  • Total 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_time
  • Net 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_day
  • Featured customers

    Customers who spent the most money in your store during the analyzed period.

    woo_commerce:featured_customers_performance
  • Performance by category

    Summary of performance of your store's product categories over the analyzed period.

    woo_commerce:category_performance
  • Coupon performance

    Summary of coupon performance over the analyzed period.

    woo_commerce:coupon_performance
  • Fee performance

    Summary of performance of fees charged in your store.

    woo_commerce:tax_performance
  • Product 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.