/
v3.0.11Get access

getCustomerJourneys

Retrieves information about the customer's bonus journeys

Request parameters:

The method works without parameters

Call example:

getCustomerJourneys()

Response examples:

{
  code: 0,
  rid: 696916106,
  data: {
    details: {
      Data: [{
        DueDate: '2026-10-28T00:00:53.188Z',
        Id: 1414,
        Subject: 'CJ visualisation V3',
        Body: '',
        Steps: [{
          Subject: 'G1',
          Icon: 'Casino',
          IsPassed: false,
          Id: 4870,
          Body: '',
          OrderKey: 1,
          SubSteps: [{
            Body: 'Make any sport bet >= 1 usd',
            OrderKey: 1,
            IsPassed: true,
            Button: {
              Subject: 'Go to Profile',
              Page: 'redirect_to_sport',
              Params: {}
            },
            Progress: {
              Subject: 'Sport Bet Amount',
              Current: 2,
              Goal: null,
              CurrencyId: 'USD'
            },
            Id: 57791,
            Subject: 'Sport Bet',
            Icon: 'Payment',
            Reward: {
              Subject: 'FreeBet',
              Body: 'jt jhgdjfdugfjhgc rgddgc',
              ClientBonusId: 3132449365
            },
            Unlock: null,
            DueDate: '2026-11-04T00:00:53.188Z'
          }, {
            Reward: {
              Subject: 'Boost Bonus',
              Body: '',
              ClientBonusId: null
            },
            Unlock: {
              RequiredStepId: 57791,
              IsUnlocked: true,
              UnlockDate: null
            },
            DueDate: '2026-11-01T00:00:53.188Z',
            Id: 57792,
            Subject: 'Sport Bet 2',
            Body: 'Make your 2nd sport bet >=1 usd',
            OrderKey: 2,
            IsPassed: false,
            Button: {
              Subject: 'Go To Casino',
              Page: 'redirect_to_casino',
              Params: {}
            },
            Progress: {
              Current: null,
              Goal: 1,
              CurrencyId: 'USD',
              Subject: 'Sport Bet 2 Amount'
            },
            Icon: 'Casino'
          }, {
            Button: {
              Subject: 'Go To Messages',
              Page: 'redirect_to_profile',
              Params: {}
            },
            Progress: null,
            Subject: 'Login again',
            Body: '',
            OrderKey: 3,
            IsPassed: false,
            Icon: 'Profile',
            Reward: null,
            Unlock: {
              IsUnlocked: false,
              UnlockDate: null,
              RequiredStepId: 57792
            },
            DueDate: null,
            Id: 57793
          }, {
            Unlock: {
              UnlockDate: null,
              RequiredStepId: 57793,
              IsUnlocked: false
            },
            Id: 57794,
            Body: '',
            OrderKey: 4,
            IsPassed: false,
            DueDate: null,
            Progress: null,
            Subject: 'Opt in',
            Icon: '',
            Reward: {
              Subject: 'opt-in bonus',
              Body: '',
              ClientBonusId: null
            },
            Button: {
              Subject: 'Go to Profile',
              Page: 'redirect_to_profile',
              Params: {}
            }
          }],
          DueDate: '2026-11-01T00:00:53.188Z'
        }, {
          Icon: 'Sport',
          IsPassed: false,
          Id: 4871,
          Body: '',
          OrderKey: 2,
          SubSteps: [{
            Reward: null,
            Unlock: null,
            DueDate: '2026-10-28T00:00:53.188Z',
            Progress: null,
            Id: 57795,
            IsPassed: false,
            Button: null,
            Subject: 'G2S1',
            Body: '',
            OrderKey: 1,
            Icon: ''
          }],
          DueDate: '2026-10-28T00:00:53.188Z',
          Subject: 'G2'
        }]
      }],
      HasError: false,
      AlertType: 'success',
      AlertMessage: null,
      Message: null,
      ModelErrors: null
    },
    result: 0
  }
}

Response parameters:

NameDescriptionTypeValues
Id
Unique ID of the journey (bonus)number-
Subject
Header/title of the journeystring-
Body
Description/tooltip content of the journeystring-
DueDate
Date and time by which the journey must be completed (ISO 8601)string-
Steps
List of steps that make up the journeyarray-
└─
A single journey stepobject
└─ Id
Unique ID of the stepnumber-
└─ Subject
Header/title of the stepstring-
└─ Body
Description text of the stepstring-
└─ OrderKey
Display order of the step within the journeynumber-
└─ IsPassed
Whether the customer has completed the stepbooleantrue / false
└─ Icon
Name of the icon shown for the step (e.g. Casino, Sport)string-
└─ DueDate
Date and time by which the step must be completed (ISO 8601); null when there is no deadlinestring-
└─ SubSteps
List of sub-steps that make up the steparray-
└─
A single sub-stepobject
└─ Id
Unique ID of the sub-stepnumber-
└─ Subject
Header/title of the sub-stepstring-
└─ Body
Description/instruction text of the sub-stepstring-
└─ OrderKey
Display order of the sub-step within its stepnumber-
└─ IsPassed
Whether the customer has completed the sub-stepbooleantrue / false
└─ Icon
Name of the icon shown for the sub-step (e.g. Casino, Payment, Profile); empty string when nonestring-
└─ DueDate
Date and time by which the sub-step must be completed (ISO 8601); null when there is no deadlinestring-
└─ Button
Action button displayed on the sub-step; null when the sub-step has no buttonobject
└─ Subject
Label of the action button shown on the sub-stepstring-
└─ Page
Identifier of the page/route the button redirects to (e.g. redirect_to_sport, redirect_to_casino, redirect_to_profile)string-
└─ Params
Additional parameters passed to the redirect target; empty object when noneobject
└─ Progress
Numeric progress toward completing the sub-step; null when progress is not trackedobject
└─ Subject
Label describing what the progress measures (e.g. Sport Bet Amount)string-
└─ Current
Amount the customer has accumulated so far; null when no progress has been recordednumber-
└─ Goal
Amount the customer must reach to complete the sub-step; null when there is no numeric goalnumber-
└─ CurrencyId
Currency code in which Current and Goal are expressed (e.g. USD)string-
└─ Reward
Reward granted upon completing the sub-step; null when there is no rewardobject
└─ Subject
Title of the reward granted for completing the sub-stepstring-
└─ Body
Description text of the rewardstring-
└─ ClientBonusId
ID of the client bonus issued to the customer for this reward; null while the reward has not been issuednumber-
└─ Unlock
Unlock condition of the sub-step; null when the sub-step is always availableobject
└─ RequiredStepId
ID of the sub-step that must be completed before this sub-step becomes availablenumber-
└─ IsUnlocked
Whether the sub-step is currently unlocked and available to the customerbooleantrue / false
└─ UnlockDate
Date and time the sub-step was or will be unlocked; null when not setstring-