Selling cash on delivery
Analytics
Read the store's numbers - sales, visits, cash, couriers, best sellers, customer insights and team performance - as the dashboard shows them.
Analytics endpoints are read only, and computed by the same code as the dashboard, so a report built on them always matches what the merchant sees. They need the analytics:read scope.
Overview
GET /v1/analytics/overview?period=30d returns the Overview page's numbers:
| Part | What it holds |
|---|---|
summary | Orders, revenue, storefront visits and conversion, each with its change against the period before. |
series | One point per hour (today), day (up to 92 days) or month, to chart. |
pipeline | How far the period's orders got: confirmed, shipped, delivered, returned, cancelled, still open. |
cash | Where the money of the period's orders stands: on the road, held by couriers, paid, returned. |
couriers | Per courier: on the road, delivered, returned and the cash it holds. |
top_products, top_regions | Best sellers by units, and where orders go with their delivery rate. |
period is today, 7d, 30d, 90d or all. For a custom range send start_date and end_date (YYYY-MM-DD, a year at most).
The numbers are computed when you ask. Poll every few minutes at most; for events as they happen, use webhooks.
Customers
GET /v1/analytics/customers is Customers → Insights: buyers by month and how many came back, reliability, the best customers and the valuable ones going quiet (at_risk), regions, sources and how long customers take to order again. Default window: the last 12 months (from, to to change it). segment_id narrows it to one saved segment.
Team
GET /v1/analytics/team?days=30 gives, per active teammate, the orders they confirmed, the orders assigned to them and how many of those were delivered.
