v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-017439390.7 KB

Get Customer Daily Streak Progress

Retrieve 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.

get/api/v4.0/integrations/customers/{customerId}/streaks/{campaignId}

Path parameters

customerIdstring 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.

campaignIdinteger required

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

Response

Customer daily streak progress found

currentStreakCountnumber

Number of consecutive periods completed in the current active streak

highestStreakCountnumber

Highest streak count ever reached by this customer for this campaign

totalRewardsEarnednumber

Total streak rewards earned across all time

nextMilestonenumber nullable

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

lastActivityDatestring date-time

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

campaignEndDatestring date-time nullable

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