iotoms Docs

List top customers by spend

GET
/api/v1/reports/customer/top

Returns the top customers ranked by net spend between from and to (both default to today). limit caps the list (default 10).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

Start date (YYYY-MM-DD), defaults to today

Formatdate
to?string

End date (YYYY-MM-DD), defaults to today

Formatdate
limit?integer

Max results, default 10

Formatint32
Default10

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?array<>|

Customers ranked by net spend, highest first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/customer/top' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "rank": 0,      "customerNumber": "string",      "customerName": "string",      "totalSpend": 0,      "orderCount": 0,      "avgOrderValue": 0    }  ]}