Metrics
Nuvemshop metrics via API
Your customer connects their Nuvemshop account and your product queries 26 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": "nuvem_shop:sales",
"component": "number_v1",
"metrics": [
"sales_count"
],
"dimensions": [
"orders"
]
}
]
}More Nuvemshop 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
Orders over time
This graph illustrates the amount of sales made over the selected 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": "nuvem_shop:orders_over_time",
"component": "chart_v1",
"metrics": [
"sales_count"
],
"dimensions": [
"orders"
]
}
]
}Table
Installments Quantity
This table shows the number of orders and revenue by number of installments.
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": "nuvem_shop:number_of_installments",
"component": "datatable_v1",
"metrics": [
"sales_count",
"revenue_value"
],
"dimensions": [
"installments"
]
}
]
}Number
Revenue
The sum of payments made by your customers (not including canceled orders) during 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": "nuvem_shop:revenue",
"component": "number_v1",
"metrics": [
"revenue_value"
],
"dimensions": [
"orders"
]
}
]
}Numbers
13 metrics
Sales
The total number of sales with confirmed payment in the selected period.
nuvem_shop:salesRevenue
The sum of payments made by your customers (not including canceled orders) during the analyzed period.
nuvem_shop:revenueValid Coupons
The number of active coupons in the period analyzed.
nuvem_shop:couponsRecurring Customers
The number of customers who have made previous purchases and returned to purchase during the period analyzed.
nuvem_shop:recurring_customersNew Customers
The number of customers who made their first purchase during the period analyzed.
nuvem_shop:new_customersSold Products
The total number of items sold during the period analyzed.
nuvem_shop:sold_productsAverage Ticket
The average ticket is calculated by dividing total revenue by the number of sales made in the selected period. This metric provides insight into the average amount spent per transaction.
nuvem_shop:average_ticketCarts converted into sales
The number of times users clicked 'Place Order' at checkout.
nuvem_shop:all_salesCarts that can become sales
The number of times the checkout was abandoned after filling in the shipping address and advancing to the second stage of the purchase process. This metric may return different data for the same period, as Nuvemshop stores abandoned cart data for up to 30 days. After this period, it is no longer possible to check the data for these carts.
nuvem_shop:abandoned_checkoutsSelected payment method
The total number of times a payment method was selected at checkout. This metric may return different data for the same period, as Nuvemshop stores abandoned cart data for up to 30 days. After this period, it is no longer possible to verify the data for these carts.
nuvem_shop:selected_payment_methodsSelected shipping method
The total number of times a customer selected a shipping method during checkout. This metric may return different data for the same period, as Nuvemshop stores abandoned cart data for up to 30 days. After this period, it is no longer possible to verify the data for these carts.
nuvem_shop:selected_shipping_methodsComplete personal data
The total number of times users filled in the email field at checkout. This metric may return different data for the same period, as Nuvemshop stores abandoned cart data for up to 30 days. After this period, it is no longer possible to verify the data for these carts.
nuvem_shop:personal_data_filledFull addresses
The total number of times users filled in the shipping address at checkout. This metric may return different data for the same period, as Nuvemshop stores abandoned cart data for up to 30 days. After this period, it is no longer possible to verify the data for these carts.
nuvem_shop:shipping_address_filled
Charts
4 metrics
Orders over time
This graph illustrates the amount of sales made over the selected period.
nuvem_shop:orders_over_timeProducts over time
Quantity of items sold over the period analyzed.
nuvem_shop:products_over_timeNew and Returning customers over time
This graph shows the evolution of the number of New Customers and Returning Customers during the selected period. It shows the days in which there were new and returning customers.
nuvem_shop:new_returning_customers_over_timeRevenue and average ticket over time
This graph shows the evolution of Total Revenue and Average Ticket over the period analyzed.
nuvem_shop:revenue_averageTicket_over_time
Tables
9 metrics
Installments Quantity
This table shows the number of orders and revenue by number of installments.
nuvem_shop:number_of_installmentsCoupons Performance
This table shows the coupon performance summary.
nuvem_shop:coupon_performanceProvince Performance
This table shows a summary of performance by state during the period analyzed.
nuvem_shop:province_performanceShipping Performance
This table shows sales value and revenue grouped by shipping configuration.
nuvem_shop:shipping_performanceShipping Method Performance
This table shows the performance of shipping methods during the period analyzed.
nuvem_shop:shipping_method_performancePayment Method Performance
This table shows the performance of each of the available payment methods.
nuvem_shop:payment_method_performancePayment System Performance
This table shows the performance of each of the available payment systems.
nuvem_shop:payment_system_performanceProducts Performance
Summary of product sales performance over the period analyzed.
nuvem_shop:product_performanceUtm Sources
This table shows revenue and sales value, grouped by information about where visitors who purchased from your store came from.
nuvem_shop:traffic_source_performance
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
