Get customer analytics

GET

https://numueg.app/api/v1/stores/{store_id}/analytics/customers

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

x-numu-scope:analytics:read

Get customer analytics for the store.

"New vs returning" comes from a CTE that joins active-in-window
customers against their first-order timestamp across all time, so a
customer whose first order pre-dates the window is "returning" even
if their only window order was today.

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

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "total_customers": 0,
        "new_customers": 0,
        "returning_customers": 0,
        "avg_customer_value": 0
    },
    "message": "string"
}

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

Get sales by location

Get conversion statistics