List distinct group values for a grouped leaderboard

Integration Returns the distinct group values present on the leaderboard's currently running iteration. Use these values to populate the group query parameter of the leaderboard ranking endpoint. Returns an empty list when: - the campaign's leaderboard is not grouped, - no iteration is currently running (the leaderboard hasn't started or just completed),

• the running iteration has no ranking rows yet. Returns 404 when the campaign does not exist for the given store, is not a leaderboard campaign, or belongs to a different tenant.

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

campaignstring · uuidRequired

Campaign ID

Query parameters

name[startsWith]stringOptional

Case-insensitive, left-anchored prefix filter on the group value (matches value%). Only the startsWith operator is supported — a disallowed operator such as name[like] returns HTTP 400. The short form name=<prefix> is treated identically to name[startsWith]=<prefix>.

Example: war

_pageinteger · min: 1Optional

1-based page index.

Default: 1

_itemsOnPageinteger · min: 1Optional

Page size.

Default: 10

_orderBy[groupValue]string · enumOptional

Sort direction for the groupValue column. Only asc and desc are accepted.

Default: ascPossible values:

Responses

200

Distinct group values for the running iteration.

application/json

itemsstring[]OptionalExample: Warsaw

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/campaign/{campaign}/leaderboard/group

GET /api/{storeCode}/campaign/{campaign}/leaderboard/group HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    "Warsaw"
  ],
  "total": {
    "all": 4,
    "filtered": 1,
    "estimated": false
  }
}