Get campaign leaderboard
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
Store code
Campaign ID
The type of cycle for which the ranking is to be returned.
Scope the ranking to a single group of a grouped leaderboard. Required for grouped leaderboards — calling the endpoint without group on a grouped leaderboard returns an empty list (items: [], total.all: 0). Ignored for non-grouped leaderboards. Only the EQUAL operator is accepted; operators like [neq] are rejected with HTTP 400. Maximum length: 255.
WarsawCampaign leaderboard with member rankings.
Unauthorized
Forbidden.
Not found.
GET /api/{storeCode}/campaign/{campaign}/leaderboard HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"member": {
"customerId": "90fb7967-34cb-4440-8786-651dd861d874",
"firstName": "text",
"lastName": "text",
"email": "zella.wisoky1@yahoo.com",
"phone": "501911936",
"loyaltyCardNumber": "3581"
},
"ranking": {
"score": 123.1,
"recalculatedAt": "2010-01-01T01:01:01Z",
"position": 1,
"changedPositionAt": "2010-01-01T01:01:01Z",
"progress": {
"general": 4,
"recalculated": 0,
"period": 2
}
}
}
],
"total": {
"all": 1,
"filtered": 1,
"estimated": true
}
}Last updated
Was this helpful?

