Get revenue breakdown analytics

GET

https://numueg.app/api/v1/stores/{store_id}/analytics/revenue-breakdown

Last modified:2026-09-19 16:39:33

x-numu-scope:analytics:read

Get revenue breakdown: gross, discounts, shipping, refunds, net.

Two SQL aggregates (totals + coupon usage) replace the previous
truncated 5000-order Python loop. Every figure — including refunds —
is measured over the same live instant window, so this screen and
/overview cannot report different totals for the same range.

gross_revenue is deliberately SUM(subtotal): this endpoint
DECOMPOSES revenue, listing shipping and tax as their own lines.
/overview's collected_revenue uses SUM(total) because it is a
single headline figure that must be comparable with total_sales.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://numueg.app/api/v1/stores//analytics/revenue-breakdown?days=&start_date=&end_date=&granularity=&tz=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "gross_revenue": 0,
        "discounts": 0,
        "shipping_collected": 0,
        "refunds": 0,
        "net_revenue": 0,
        "tax_collected": 0,
        "tax_inclusive": 0,
        "tax_added": 0,
        "tax_by_rate": [
            {
                "rate_pct": 0,
                "orders": 0,
                "tax_cents": 0
            }
        ],
        "coupon_usage": [
            {
                "code": "string",
                "uses": 0,
                "revenue_impact": 0
            }
        ]
    },
    "message": "string"
}

Modified at 2026-09-19 16:39:33

Get orders breakdown analytics

Get customer RFM segmentation