Get product performance analytics

GET

https://numueg.app/api/v1/stores/{store_id}/analytics/product-performance

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

x-numu-scope:analytics:read

Get product-level performance, category breakdown, and inventory health.

Three SQL aggregations replace the previous 5000-order in-memory
loop: top_products (line_items unnest + GROUP BY), the optional
7-day daily trend per top product, and inventory bucket counts.
Catalog metadata (cost_price, category) is joined via a single
product fetch limited to the active SKUs.

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

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "products": [
            {
                "id": "string",
                "name": "string",
                "sku": "string",
                "image_url": "string",
                "revenue": 0,
                "quantity_sold": 0,
                "current_stock": 0,
                "revenue_trend": [
                    0
                ],
                "gross_sales": 0,
                "discounts": 0,
                "tax": 0,
                "net_sales": 0,
                "orders_count": 0,
                "cost_price": 0,
                "profit": 0,
                "margin_percent": 0
            }
        ],
        "categories": [
            {
                "category_id": "string",
                "category_name": "string",
                "revenue": 0,
                "quantity_sold": 0,
                "product_count": 0
            }
        ],
        "inventory": {
            "in_stock": 0,
            "low_stock": 0,
            "out_of_stock": 0,
            "dead_stock": 0
        }
    },
    "message": "string"
}

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

Get inventory analytics (sell-through, ABC, dead stock)

Get top storefront search terms