Get Customer Stamps Progress

Changed on

Retrieve the progress of a specific customer within a particular Stamps campaign in Gameball. It returns how many steps the customer has completed, how many times they've earned the campaign reward, and whether they are eligible to continue.

get/api/v4.0/integrations/customers/{customerId}/stamps/{challengeId}

Request

  • Base URL: https://api.gameball.co
  • URL: https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/stamps/{challengeId}
  • Auth: API key in header apikey and API key in header secretkey

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.

challengeIdinteger required

Unique identifier of the Stamps campaign to retrieve progress for.

Response

Customer stamps progress found

numberOfCompletedStepsnumber

The number of steps completed by the customer in the current challenge cycle

numberOfTimesEarnednumber

The total number of times the customer has successfully completed the challenge

canAchieveAgainboolean

Whether the customer is currently eligible to continue the challenge

remainingTriesnumber

The number of remaining allowed completions within the current time interval

challengeEndDatestring

The end date of the challenge in the client's local timezone

rewardNamestring

The name of the reward as defined in the client's configured language

couponNamestring

The name or value of the discount coupon assigned

Changes