Reports
Revenue, order, and product analytics. Date-filtered reporting endpoints.
Numbers, charts, and analytics. Revenue breakdowns, order charts, product performance, customer insights, subscription cohorts, refund analysis, and retention metrics. All date-filterable, all JSON.
Endpoints
Overview
| Method | Endpoint | Description |
|---|---|---|
GET | Get reports overview | Summary for the reports dashboard |
GET | Get report overview | Summarised report overview |
GET | Get dashboard summary | Key metrics for the main dashboard |
GET | Get report dashboard stats | Dashboard statistics |
GET | Get report meta | Report metadata |
GET | Get report sources | Available report data sources |
GET | Get quick order stats | Quick order statistics for a date range |
GET | Get recent orders | Most recent orders for the dashboard |
GET | Get recent activities | Recent activity log entries |
Revenue & Sales
| Method | Endpoint | Description |
|---|---|---|
GET | Get revenue | Revenue report |
GET | Get revenue by group | Revenue segmented by group or category |
GET | Get sales report | Comprehensive sales report |
GET | Get sales growth | Sales growth metrics over time |
GET | Get sales growth chart | Sales growth chart data |
Orders
| Method | Endpoint | Description |
|---|---|---|
GET | Get order chart | Order chart data |
GET | Get orders by group | Orders segmented by group |
GET | Get order completion time | Time-to-completion analytics |
GET | Get order value distribution | Order value distribution |
GET | Get item count distribution | Orders by number of items |
GET | Get unfulfilled orders | Orders not yet shipped |
GET | Get report by day and hour | Order activity heatmap data |
Products
| Method | Endpoint | Description |
|---|---|---|
GET | Get product report | Product performance with sales data |
GET | Get product performance | Product performance metrics |
GET | Get top products sold | Top-selling products by units |
GET | Get top sold products | Top-selling products with revenue |
GET | Get top sold variants | Top-selling variants with revenue |
GET | Get cart report | Cart analytics and abandonment rates |
Customers
| Method | Endpoint | Description |
|---|---|---|
GET | Get customer report | Customer analytics |
GET | Get daily signups | Daily customer signup counts |
GET | Get new vs returning | New vs returning customer breakdown |
GET | Search repeat customers | Find repeat customers |
GET | Get country heat map | Customer distribution by country |
Subscriptions
| Method | Endpoint | Description |
|---|---|---|
GET | Get subscription chart | Subscription chart data |
GET | Get subscription cohorts | Subscription cohort analysis |
GET | Get subscription retention | Subscription retention metrics |
GET | Get future renewals | Upcoming renewal dates and expected revenue |
Refunds
| Method | Endpoint | Description |
|---|---|---|
GET | Get refund chart | Refund chart data |
GET | Get refund data by group | Refund data by grouping dimension |
GET | Get weeks between refund | Average time from purchase to refund |
Retention
| Method | Endpoint | Description |
|---|---|---|
GET | Get retention chart | Retention chart data |
GET | Get retention status | Retention snapshot generation status |
POST | Generate retention snapshots | Trigger retention snapshot generation |
Licensing
| Method | Endpoint | Description |
|---|---|---|
GET | Get license chart | Licence issuance and activation over time |
GET | Get license pie chart | Licence distribution chart |
GET | Get license summary | Licence summary statistics |