Dashboard stats
GET
header
x-api-key<token>Organization-scoped API key with scope metadata.
Success
application/json- response
totalProducts*numberactiveProducts*numbertotalOrders*numberpaidOrders*numberOrders that reached paid, even if later refunded.
totalRevenue*numbertotalCustomers*numberlast30Days*The 30 days up to now.
prior30Days*The 30 days before those.
recentOrders*array<>ordersByStatus*canTakeOrders*booleanTrue when a payment provider is connected, or when that couldn't be checked. Paid orders are refused without one, whatever this says.
curl -X GET 'https://api-prood.vercel.app/v1/admin/dashboard'Example Response
{ "totalProducts": 0, "activeProducts": 0, "totalOrders": 0, "paidOrders": 0, "totalRevenue": 0, "totalCustomers": 0, "last30Days": { "orders": 0, "revenue": 0 }, "prior30Days": { "orders": 0, "revenue": 0 }, "recentOrders": [ { "id": "string", "orderNumber": "string", "status": "placed", "paymentStatus": "unpaid", "fulfillmentStatus": "unfulfilled", "items": [ { "id": "string", "productId": "string", "variantId": "string", "name": { "property1": "string", "property2": "string" }, "variantName": { "property1": "string", "property2": "string" }, "image": { "url": "string", "alt": "string", "width": 0, "height": 0 }, "quantity": 0, "price": { "amount": 0, "currency": "string", "formatted": "string" }, "totalPrice": { "amount": 0, "currency": "string", "formatted": "string" }, "fulfillmentStatus": "unfulfilled", "productType": "physical" } ], "totals": { "subtotal": { "amount": 0, "currency": "string", "formatted": "string" }, "shipping": { "amount": 0, "currency": "string", "formatted": "string" }, "tax": { "amount": 0, "currency": "string", "formatted": "string" }, "discount": { "amount": 0, "currency": "string", "formatted": "string" }, "total": { "amount": 0, "currency": "string", "formatted": "string" } }, "shippingAddress": { "firstName": "string", "lastName": "string", "phone": "string", "street": "string", "street2": "string", "city": "string", "state": "string", "country": "string", "postalCode": "string" }, "billingAddress": { "firstName": "string", "lastName": "string", "phone": "string", "street": "string", "street2": "string", "city": "string", "state": "string", "country": "string", "postalCode": "string" }, "shippingMethod": { "id": "string", "name": { "property1": "string", "property2": "string" }, "provider": "string", "fulfillmentType": "shipping", "estimatedDays": { "min": 0, "max": 0 }, "price": { "amount": 0, "currency": "string", "formatted": "string" }, "cashOnDelivery": true }, "paymentMethod": { "id": "string", "type": "string", "name": { "property1": "string", "property2": "string" }, "provider": "string", "installments": { "count": 0, "amount": 0, "currency": "string" }, "icon": "string" }, "paymentProvider": "string", "paymentTransactionId": "string", "paymentDetails": { "method": "card", "entity": "string", "reference": "string", "expiresAt": "string" }, "couponCode": "string", "trackingNumber": "string", "trackingUrl": "string", "note": "string", "customerId": "string", "contactEmail": "string", "requiresShipping": true, "placedAt": "string", "approvedAt": "string", "cancelledAt": "string", "fulfilledAt": "string", "createdAt": "string", "updatedAt": "string" } ], "ordersByStatus": { "property1": 0, "property2": 0 }, "canTakeOrders": true}