Sign in

Get Customer Tier Progress

This API provides an overview of a customer's current tier and progression within Gameball's loyalty program. By retrieving the customer's current tier, progress level, and next tier details, this endpoint offers a clear view of their advancement within the tier structure.

get/api/v4.0/integrations/customers/{customerId}/tier-progress

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.

Query parameters

expandstring

Comma-separated expansions: tier,referrals

Headers

langstring

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.

Response

Customer tier progress retrieved successfully

progressnumber

The current progress of the customer toward the next tier, reflecting their activity and engagement within the program. This value is calculated based on the client's chosen tiering-up method, indicating how close the customer is to advancing to a higher tier. Example: If the progress value is 1500 and the tiering-up method is total points earned, this means the customer has earned a total of 1500 points toward their next tier. Possible Values: Total amount spent, Total points earned, Friends referred, Orders completed, Score.

Changes

Changed in 6 of the 38 revisions of this API.149

  • a38b379b77d41See the full diff
    • ○

      added the new optional header request parameter lang

      new-optional-request-parameter

  • d416385332611See the full diff
    • ○

      api operation id getCustomerTierProgress was added

      api-operation-id-added

  • 262228c134293See the full diff
    • ○

      the endpoint scheme security apiKey AND secretKey was added to the API

      api-security-added

    • ○

      the endpoint scheme security apiKey was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security secretKey was removed from the API

      api-security-removed

  • f4bae7aa83d443See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 2bc98dcabf951See the full diff
    • ○

      endpoint added

      endpoint-added

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 38 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog