iotoms Docs

Get day cycle analytics

GET
/api/v1/ops/day-cycles/analytics

Returns KPIs for day cycles with a business date between from and to (inclusive, both default to today): open and closed counts, sales, transactions, cash and credit totals, and store visit coverage. from after to is rejected.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

Start date, YYYY-MM-DD.

Formatdate
to?string

End date, YYYY-MM-DD.

Formatdate

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

Summary KPIs across all day cycles in the requested date range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ops/day-cycles/analytics'
Example Response
{  "status": "string",  "message": "string",  "data": {    "from": "2019-08-24",    "to": "2019-08-24",    "totalCycles": 0,    "openCycles": 0,    "closedCycles": 0,    "totalSales": 0,    "totalTransactions": 0,    "totalCashCollected": 0,    "totalCreditTotal": 0,    "totalStoresAssigned": 0,    "totalStoresVisited": 0,    "overallCoveragePercent": 0.1  }}