Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
reward-campaigns-progress
Get Customer Campaigns Progress
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/reward-campaigns-progress \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
[
  {
    "rewardsCampaignName": "<string>",
    "rewardsCampaignId": 123,
    "isUnlocked": true,
    "highScoreAmount": 123,
    "currentStreak": 123,
    "highestStreak": 123,
    "completionPercentage": 123,
    "achievedCount": 123,
    "canAchieve": true,
    "rewardCampaignConfiguration": {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "isRepeatable": true,
      "maxAchievement": 123,
      "type": "<string>",
      "visibility": "<string>",
      "icon": "<string>",
      "redirectionButtonText": "<string>",
      "redirectionButtonLink": "<string>",
      "widgetDetailsParameter": "<string>",
      "activation": {
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z"
      },
      "rewards": [
        {
          "rankReward": 123,
          "walletReward": 123,
          "walletRewardFactor": 123,
          "couponReward": {
            "couponType": "<string>",
            "discountValue": 123,
            "product": {
              "productId": "<string>",
              "productName": "<string>",
              "variantId": "<string>",
              "variantName": "<string>",
              "productDisplayName": "<string>"
            },
            "collections": [
              {
                "collectionId": "<string>",
                "collectionName": "<string>"
              }
            ],
            "group": {
              "handle": "<string>",
              "title": "<string>",
              "url": "<string>",
              "iconPath": "<string>",
              "description": "<string>",
              "maxPerCustomer": 123,
              "startDate": "2023-11-07T05:31:56Z",
              "expiryDate": "2023-11-07T05:31:56Z",
              "isAvailable": true,
              "isActive": true
            },
            "options": {
              "name": "<string>",
              "expiryAfter": 123,
              "usageLimit": 123,
              "capping": 123,
              "minOrderValue": 123,
              "codePrefix": "<string>",
              "redeemInstructions": "<string>"
            }
          }
        }
      ]
    }
  }
]
This API retrieves a customer’s progress within Gameball’s reward campaigns, providing insights into their achievements and current status in each campaign. By accessing completion percentages and unlock statuses, you can track how customers are engaging with various reward opportunities.
Security: Requires apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
string
header
required

Path Parameters

​
customerId
string
required

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

Response

200 - application/json

Customer campaigns progress retrieved successfully

​
rewardsCampaignName
string

The name of the rewards campaign.

​
rewardsCampaignId
number

The unique ID of the rewards campaign.

​
isUnlocked
boolean

Indicates if the customer has unlocked the campaign.

​
highScoreAmount
number | null

The highest score achieved by the customer. This value is applicable only in the context of a high score rewards campaign.

​
currentStreak
number | null

The current number of consecutive days the customer has visited the website. This value is applicable only in the context of a streak (daily visit) rewards campaign.

​
highestStreak
number | null

The maximum number of consecutive days the customer has visited the website. This value is also applicable only in the context of a streak (daily visit) rewards campaign.

​
completionPercentage
number

The percentage of the campaign the customer has completed. For example, in a second-order campaign where the customer must make 2 orders, if they have only placed 1 order, the completion percentage will be 50%.

​
achievedCount
number

The number of times the customer has achieved the campaign.

​
canAchieve
boolean

A flag that determines whether the customer is currently eligible to participate in and achieve this reward campaign. It provides a quick indication of the customer's ability to meet the campaign's conditions based on their current status.

​
rewardCampaignConfiguration
object

Comprehensive description of the reward campaign configuration.