Units analytics

Management This method returns information about the total number of Points spent, expired, blocked, pending, and all active Points.

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

Responses

200

Returned when successful

application/json

totalPointsActivenumber · floatOptionalExample: 72544.8

totalPointsSpentnumber · floatOptionalExample: 3425.25

totalPointsAddednumber · floatOptionalExample: 47563

totalPointsExpirednumber · floatOptionalExample: 432.9

totalPointsPendingnumber · floatOptionalExample: 65764.76

401Error

application/json

403

Forbidden.

application/json

get/api/{storeCode}/analytics/points

GET /api/{storeCode}/analytics/points HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "totalPointsActive": 72544.8,
    "totalPointsSpent": 3425.25,
    "totalPointsAdded": 47563,
    "totalPointsExpired": 432.9,
    "totalPointsPending": 65764.76
  }
]