Campaigns Configurations

curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns \
  --header 'apikey: <api-key>'

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "isRepeatable": true,
    "maxAchievement": 123,
    "type": "<string>",
    "visibility": "<string>",
    "streakIntervalUnit": "Day",
    "icon": "<string>",
    "availability": {
      "minTier": 123,
      "tags": [
        "<string>"
      ]
    },
    "redirectionButtonText": "<string>",
    "redirectionButtonLink": "<string>",
    "activation": {
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    },
    "rewards": [
      {
        "rankReward": 123,
        "walletReward": 123,
        "walletRewardFactor": 123,
        "order": 123,
        "startStep": 123,
        "endStep": 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>"
          }
        }
      }
    ]
  }
]

GET

api

v4.0

integrations

configurations

reward-campaigns

Campaigns Configurations

curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns \
  --header 'apikey: <api-key>'

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "isRepeatable": true,
    "maxAchievement": 123,
    "type": "<string>",
    "visibility": "<string>",
    "streakIntervalUnit": "Day",
    "icon": "<string>",
    "availability": {
      "minTier": 123,
      "tags": [
        "<string>"
      ]
    },
    "redirectionButtonText": "<string>",
    "redirectionButtonLink": "<string>",
    "activation": {
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    },
    "rewards": [
      {
        "rankReward": 123,
        "walletReward": 123,
        "walletRewardFactor": 123,
        "order": 123,
        "startStep": 123,
        "endStep": 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>"
          }
        }
      }
    ]
  }
]

Streak campaign rewards

For campaigns with type set to Streak, the response includes the interval used to count the streak and the step range for every reward. streakIntervalUnit is Day, Week, or Month. Each reward’s startStep and endStep are measured in that unit: day 7 of a daily streak, week 7 of a weekly streak, or month 7 of a monthly streak.

Field	Description
`streakIntervalUnit`	The unit used to count streak steps. `Day`, `Week`, or `Month`. Returned only for streak campaigns.
`rewards[].order`	The display order of this reward tier, starting at 1.
`rewards[].startStep`	The first step (in `streakIntervalUnit`) at which this reward applies.
`rewards[].endStep`	The last step at which this reward applies. Omitted on the final open-ended tier, which applies from `startStep` onward.

Tiers with walletReward of 0 are progress ranges with no points. Use them to render the full streak timeline, then highlight the tiers that grant points or a coupon.

Example: Daily streak campaign

[
  {
    "id": 2783,
    "name": "Daily Visit ",
    "internalName": "YAWMI",
    "isActive": true,
    "description": "Visit our website daily and earn some fun progressive rewards the more you do!",
    "rewards": [
      {
        "rankReward": 0,
        "walletReward": 0,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 1,
        "startStep": 1,
        "endStep": 6
      },
      {
        "rankReward": 0,
        "walletReward": 10,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 2,
        "startStep": 7,
        "endStep": 7
      },
      {
        "rankReward": 0,
        "walletReward": 0,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 3,
        "startStep": 8,
        "endStep": 13
      },
      {
        "rankReward": 0,
        "walletReward": 20,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 4,
        "startStep": 14,
        "endStep": 14
      },
      {
        "rankReward": 0,
        "walletReward": 0,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 5,
        "startStep": 15,
        "endStep": 20
      },
      {
        "rankReward": 0,
        "walletReward": 30,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 6,
        "startStep": 21,
        "endStep": 21
      },
      {
        "rankReward": 0,
        "walletReward": 0,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 7,
        "startStep": 22,
        "endStep": 29
      },
      {
        "rankReward": 0,
        "walletReward": 100,
        "walletRewardFactor": null,
        "couponReward": null,
        "order": 8,
        "startStep": 30
      }
    ],
    "isRepeatable": true,
    "maxAchievement": -1,
    "type": "Streak",
    "visibility": "Always Visible",
    "showInWidget": true,
    "streakIntervalUnit": "Day"
  }
]

In this daily streak (streakIntervalUnit: "Day"):

Steps	Reward
Days 1–6	No points
Day 7	10 points
Days 8–13	No points
Day 14	20 points
Days 15–20	No points
Day 21	30 points
Days 22–29	No points
Day 30 onward	100 points

The last reward has startStep 30 and no endStep, so it applies from day 30 onward. To read a customer’s position against these steps, call Customer Campaigns Progress with campaignId.

Authorizations

apikey

string

header

required

Headers

lang

string

If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language.

Query Parameters

customerId

string

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. If provided, the API filters and returns only the campaigns that can be achieved by this customer.

collectionId

string

Unique identifier for a product collection. If provided, the API returns the transactional campaigns applicable to the specified collection.

productSku

string

The SKU (Stock Keeping Unit) of a product. If provided, the API returns the transactional campaigns applicable to the specified product.

Response

200 - application/json

Campaigns retrieved successfully

number

Unique identifier for the reward campaign.

name

string

Name of the reward campaign.

description

string | null

A brief description of the reward campaign.

isRepeatable

boolean

Indicates whether the campaign can be earned multiple times. Example: If set to true, a customer can earn the campaign reward each time they meet the criteria, and if set to false, the campaign can only be earned once per customer.

maxAchievement

number

Specifies the maximum number of times the campaign can be earned if the value of isRepeatable is true. If the value is -1, it means the campaign can be earned indefinitely. Example: A value of 3 means the customer can earn the campaign reward up to three times before it is no longer available.

type

string

The type of the campaign. Possible values: SignUp (Reward is given when a user signs up), SocialMedia (Reward is linked to social media activity), ScheduledChallenge (A time-based challenge that gives rewards), Spin The Wheel (Rewards are given based on a spin-the-wheel game), EventBased (Reward is given based on specific customer events), HighScore (Reward is given based on achieving high scores in a campaign), Birthday (Reward is given for birthday-related activity), Streak (Reward is given for consecutive actions over a Day, Week, or Month interval).

visibility

string

The visibility status of the campaign. Possible values: AlwaysVisible (The campaign is always visible on the widget), NotVisible (The campaign is not visible to the customer on the widget), VisibleIfEarned (The campaign becomes visible once the customer earns it on the widget).

streakIntervalUnit

enum<string> | null

The unit used to count streak steps. Returned only for streak campaigns. Each step in startStep and endStep is measured in this unit: Day (consecutive days), Week (consecutive weeks), or Month (consecutive months).

Available options:

Day,

Week,

Month

icon

string | null

The URL of the campaign's icon image. This icon visually represents the campaign and can be used in marketing materials or on the platform.

availability

object

Defines the criteria determining which customers are eligible to earn this reward campaign.

Show child attributes

redirectionButtonText

string | null

The text displayed on the redirection button within the reward campaign page on the widget. Example: "Claim Your Reward" would prompt customers to take action.

redirectionButtonLink

string | null

The URL that the redirection button points to. When customers click the button, they will be redirected to this link. It should lead to a relevant page that provides more information or facilitates the reward campaign achievement. Example: "https://yourwebsite.com/rewards" directs customers to a page where they can view their rewards.

activation

object | null

Defines the activation criteria for the campaign, which may include specific start and end dates.

Show child attributes

rewards

object[]

Details of the rewards that the customer will earn once achieving this reward campaign.

Show child attributes

API documentation

Webhooks

Campaigns Configurations

Streak campaign rewards

Example: Daily streak campaign

Authorizations

Headers

Query Parameters

Response