Get merchant health score

GET

https://numueg.app/api/v1/stores/{store_id}/analytics/health-score

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

x-numu-scope:analytics:read

Get the merchant health score (cached daily or live calculation).

On first call (no cache), calculates live and caches the result in Redis
so subsequent calls are instant. Celery refreshes it daily.
Recommendations are regenerated per-request so they always match the
user's current language.

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/health-score?live=&lang=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "score": 0,
        "grade": "string",
        "insufficient_data": false,
        "insufficient_metrics": [],
        "metrics": {
            "delivery_success_rate": 0,
            "cod_acceptance_rate": 0,
            "order_completion_rate": 0,
            "return_rate": 0,
            "avg_response_hours": 0
        },
        "sub_scores": {
            "property1": 0,
            "property2": 0
        },
        "recommendations": [
            "string"
        ],
        "orders_analyzed": 0,
        "shipments_analyzed": 0,
        "window_days": 90,
        "empty_state_message": "string",
        "requirements": [],
        "calculated_at": "string"
    },
    "message": "string"
}

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

Get COD rejection statistics

Get orders breakdown analytics