Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
streaks
/
{campaignId}
Get Customer Daily Streak Progress
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/streaks/{campaignId} \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "currentStreakCount": 123,
  "highestStreakCount": 123,
  "totalRewardsEarned": 123,
  "ongoingReward": {
    "name": "<string>",
    "type": "<string>",
    "value": "<string>"
  },
  "nextMilestone": 123,
  "lastActivityDate": "2023-11-07T05:31:56Z",
  "campaignEndDate": "2023-11-07T05:31:56Z",
  "badges": [
    {
      "milestoneDay": 123,
      "name": "<string>",
      "imageUrl": "<string>",
      "earned": true,
      "earnedDate": "2023-11-07T05:31:56Z"
    }
  ]
}
This API retrieves the progress of a specific customer within a particular daily streak campaign in Gameball. It returns the current and highest streak counts, ongoing reward details, badge milestones, and the next milestone to unlock.
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.

​
campaignId
integer
required

Unique identifier of the daily streak campaign to retrieve progress for.

Response

Customer daily streak progress found

​
currentStreakCount
number

Number of consecutive periods completed in the current active streak

​
highestStreakCount
number

Highest streak count ever reached by this customer for this campaign

​
totalRewardsEarned
number

Total streak rewards earned across all time

​
ongoingReward
object

Details of the currently active reward tier

​
nextMilestone
number | null

Streak count at which the next reward unlocks, or null if at the last tier

​
lastActivityDate
string<date-time>

Date/time of the last qualifying action in the client's local timezone

​
campaignEndDate
string<date-time> | null

Campaign end date in the client's local timezone, or null if open-ended

​
badges
object[]

Badge milestones ordered by milestoneDay ascending