Metrics
Shopify metrics via API
Your customer connects their Shopify account and your product queries 33 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": "shopify:processed_orders",
"component": "number_v1",
"metrics": [
"fulfilledOrdersTotal"
],
"dimensions": [
"orders_date"
]
}
]
}More Shopify 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 channel
Total sales for the period associated with each active sales channel.
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": "shopify:sales_per_channel",
"component": "chart_v1",
"metrics": [
"totalSales"
],
"dimensions": [
"orders_channel"
]
}
]
}Table
Top selling products
Summary of sales performance for each product during the analyzed period. Includes orders placed across all sales channels.
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": "shopify:best_selling_products",
"component": "datatable_v1",
"metrics": [
"vendor",
"productType",
"currentQuantity",
"grossSales",
"liquidSales",
"discount",
"refund",
"tax",
"totalSales"
],
"dimensions": [
"orders_products"
]
}
]
}Number
Total gross profit
The total profit obtained from the products during the analyzed period. It is calculated by subtracting the cost from net sales.
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": "shopify:gross_profit",
"component": "number_v1",
"metrics": [
"grossProfitTotal"
],
"dimensions": [
"orders_products"
]
}
]
}Numbers
21 metrics
Processed orders
The cumulative number of orders processed and marked as processed during the analysis period.
shopify:processed_ordersTotal gross profit
The total profit obtained from the products during the analyzed period. It is calculated by subtracting the cost from net sales.
shopify:gross_profitTotal Sales
Total sales equal gross sales plus shipping, taxes, import duties, and fees, minus the value of discounts and returns. It includes all sales channels.
shopify:total_sales_valueRefunds
Total number of items returned during the selected period.
shopify:refundsTotal orders
The total number of orders placed across all sales channels.
shopify:total_ordersRecurring Customer Rate
The percentage of people who have placed more than one order in the store. The rate is calculated by dividing the number of recurring customers by the total number of customers who have placed an order in the selected period.
shopify:recurring_customers_rateAverage Ticket
The average value of all orders (excluding gift cards) divided by the total number of orders with at least one non-gift card product. The order value excludes post-order adjustments such as edits, exchanges, or returns, as well as import duties, other taxes, shipping, and discounts.
shopify:average_ticketDiscounts
Total value of discounts granted during the analyzed period. This metric includes all sales channels.
shopify:discountsGross Sales
Value of all items purchased before the addition of taxes or other adjustments, such as duties, shipping, discounts, or returns. This metric includes all sales channels.
shopify:gross_salesSell-through Rate
Value of all items purchased before the addition of taxes or other adjustments, such as duties, shipping, discounts, or returns. This metric includes all sales channels.
shopify:sell_throughAverage Order Quantity
Average number of units ordered during the analysis period.
shopify:average_units_soldCanceled orders
Total number of orders canceled during the selected period.
shopify:canceled_ordersDelivered orders
Total number of orders delivered during the selected period.
shopify:delivered_ordersNet profit
Total profit obtained from the products during the analyzed period. It is calculated by subtracting the cost from net sales.
shopify:net_profitNet sales
Total sales minus the value of discounts and returns. It includes all sales channels.
shopify:net_salesPaid sales
Net sales counting only orders with confirmed payment. Orders with pending or expired payment, such as unpaid Pix or boleto, are left out until they are paid.
shopify:paid_salesRefunds value
Total value of refunds granted during the analyzed period. This metric includes all sales channels.
shopify:refunds_valueShipping value
Total value of shipping costs during the analyzed period. This metric includes all sales channels.
shopify:shipping_valueNew Customers
The number of customers who made their first purchase during the period analyzed.
shopify:new_customersRecurring Customers
The number of customers who have made previous purchases and returned to purchase during the period analyzed.
shopify:recurring_customersTotal Sales from New Customers
Total sales from the first purchase of new customers during the period analyzed. Total sales equal gross sales plus shipping, taxes, import duties, and fees, minus the value of discounts and returns. It includes all sales channels.
shopify:new_customers_total_sales
Charts
5 metrics
Sales by channel
Total sales for the period associated with each active sales channel.
shopify:sales_per_channelOrders over time
Number of orders made over the analyzed period.
shopify:orders_over_timeOrders processing over time
The cumulative number of orders processed and marked as processed over the analyzed period.
shopify:orders_processing_over_timeTotal sales over time
Total sales over the selected period. It equals gross sales plus shipping, taxes, import duties, and fees, minus the value of discounts and returns. Includes all sales channels.
shopify:sales_over_timeTotal sales per hour
Total value of sales per hour. The data is calculated by adding gross sales plus shipping, taxes, import duties, and fees, minus the value of discounts and returns. The value includes all sales channels.
shopify:sales_per_hour
Tables
7 metrics
Top selling products
Summary of sales performance for each product during the analyzed period. Includes orders placed across all sales channels.
shopify:best_selling_productsProfit per product
Summary of gross profit performance by product for the selected period. Only products whose cost was recorded at the time of sale are listed.The number of sales.
shopify:profit_by_productProfit per product variant
Summary of gross profit performance by product variant for the selected period. Only products whose cost was recorded at the time of sale are listed.
shopify:profit_by_product_variantSales by Traffic Referrer
Total sales from each traffic source during the analyzed period.
shopify:sales_by_referrerSales by Originating Social Network
Total sales resulting from virtual store sessions that came from social network referrer sources, such as Facebook and Instagram. This metric is only valid for the Virtual Store sales channel.
shopify:sales_by_sourceOrder summary
Summary of orders for the analyzed period
shopify:orders_summarySales Summary
Performance summary of sales for the period over the analyzed timeframe.
shopify:sales_summary
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
