Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve campaign overview

Management "intervalEndDate" may run one day past the server's date, so that a client whose local calendar date is ahead of UTC is not rejected; beyond that the request returns 400. "intervalStartDate" carries no such upper bound. Either date later than the current server time is clamped to it and reported back clamped in the response.

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

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.
To refresh admin token POST /api/token/refresh Go to definition

Path parameters
storeCodestringRequired

Store code

campaignIdstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Query parameters
dataTypestring · enumRequiredPossible values:
aggregationTypestring · enumOptionalPossible values:
intervalStartDatestring · dateOptional
intervalEndDatestring · dateOptional
Responses
200

Data for general overview dashboard

application/json
campaignIdstring · uuidOptional
intervalStartDatestring · dateOptional
intervalEndDatestring · dateOptional
aggregationTypestring · enumOptionalPossible values:
dataTypestring · enumOptionalPossible values:
get/api/{storeCode}/analytics/campaign/single-view/{campaignId}
GET /api/{storeCode}/analytics/campaign/single-view/{campaignId}?dataType=totalEngagement HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "intervalStartDate": "2026-01-01",
  "intervalEndDate": "2026-01-01",
  "header": {
    "totalEngagement": 1,
    "engagedMembers": 1
  },
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "aggregationType": "day",
  "dataType": "totalEngagement"
}

Last updated

Was this helpful?