Custom report: metrics grouped by a chosen dimension

GET

https://numueg.app/api/v1/stores/{store_id}/analytics/report-builder

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

x-numu-scope:analytics:read

Group revenue / orders / AOV (and units, for products) by any
supported dimension — the merchant-facing custom report builder.
Metric selection happens client-side from the columns returned here,
so switching metric doesn't re-query.

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/report-builder?dimension=&days=&start_date=&end_date=&granularity=&tz=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "dimension": "string",
        "rows": [
            {
                "label": "string",
                "revenue_cents": 0,
                "orders": 0,
                "aov_cents": 0,
                "units": 0
            }
        ],
        "totals": {
            "label": "string",
            "revenue_cents": 0,
            "orders": 0,
            "aov_cents": 0,
            "units": 0
        }
    },
    "message": "string"
}

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

Anonymous peer benchmarks (k-anonymity gated)

Get weekly-digest preferences