Retrieve general overview

Management The endpoint is used to retrieve a general overview of the analytics dashboard. To use the endpoint, you must provide a "dataType" parameter that specifies the type of data you want to retrieve. Additionally, you can provide optional query parameters to filter the data.

You can specify an "aggregationType" parameter to group the data by day, week, month, or year. You can also specify an "intervalStartDate" and "intervalEndDate" parameter to retrieve data for a specific time range.

If you don't specify the "aggregationType" parameter, aggregation will be based on interval:

• 1-30 - days daily aggregation

• 31-90 - days weekly aggregation

• 91-360 - days monthly aggregation

• over 360 - days annual aggregation

If you don't provide any optional query parameters and don't specify an interval, it will return all data from the beginning to today.

get

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

Query parameters

dataTypestring · enumRequiredPossible values:

aggregationTypestring · enumOptionalPossible values:

intervalStartDatestring · dateOptional

intervalEndDatestring · dateOptional

Responses

200

Data for general overview dashboard

application/json

intervalStartDatestring · date-timeOptional

intervalEndDatestring · date-timeOptional

aggregationTypestring · enumOptionalPossible values:

dataTypestring · enumOptionalPossible values:

400

Bad request.

application/json

401

Unauthorized.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/analytics/dashboard/general-overview

GET /api/{storeCode}/analytics/dashboard/general-overview?dataType=registeredMembers HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "intervalStartDate": "2026-01-01T00:00:00.000Z",
  "intervalEndDate": "2026-01-01T00:00:00.000Z",
  "header": {
    "registeredMembers": 1,
    "activeMembers": 1,
    "revenue": 1,
    "avgSpending": 1,
    "transactions": 1,
    "avgTransactionValue": 1,
    "avgNumberOfTransactions": 1,
    "returnTransactions": 1,
    "totalReturns": 1,
    "avgReturnValue": 1,
    "avgNumberOfReturnTransactions": 1
  },
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "aggregationType": "day",
  "dataType": "registeredMembers"
}