Skip to main content

Getting campaign progress

User Progress​

When using the get-campaign or get-campaigns endpoint it is possible to query a summary of a users history with the campaign. This information will be returned in the user_progress field.

The user_progress of a user can appear in several different formats:

  • Standard - The standard user_progress object appears in the get-campaign and get-campaigns response for the following campaign types birthday, cashback, interaction, item_purchase_count, login, progress, purchase_count, referral, and signup. The standard user_progress object contains award_count which is the number of times user has been awarded by the campaign and total_amount_awarded which is the total amount awarded to the user by the campaign in the currency of the campaign.

For example:

"user_progress": {
    "award_count": 2,
    "total_amount_awarded": 251
}
  • Loyalty - The loyalty user_progress object appears in the get-campaign and get-campaigns response for the loyalty campaign type. This shows a summary of a users loyalty status, including the current status level, the points balance and the points required to reach the next level.

For example:

"user_progress": {
    "campaign_id": 159,
    "date_reached": "2022-11-15T15:23:59+00:00",
    "description": "Level 1 in ACME rewards Programme",
    "last_review_date": "2022-04-11T11:10:58+00:00",
    "loyalty_level_id": 2,
    "monetary_balance_current": null,
    "name": "Bronze",
    "next_review_date": null,
    "points_balance_current": 251,
    "points_to_proceed_next_level": 249,
    "points_to_remain_current_level": 0
},
  • Wallet - The wallet user_progress object appears in the get-campaign and get-campaigns response for the points_wallet and wallet campaign types. This shows a summary of a users wallet balance, including the current saved_amount and the total_amount added to the wallet as well as the currency of wallet.

For example:

"user_progress": {
    "currency": {
        "code": "PTS",
        "display_position": "after",
        "id": 5,
        "name_en": "Points",
        "symbol": "pts"
    },
    "is_redeemable": false,
    "saved_amount": 251,
    "target_count": 0,
    "total_amount": 251
}