Gigya Job Openings

gm.getChallengeVariants REST

Skip to end of metadata
Go to start of metadata

Note: If you plan on integrating the Loyalty platform, we highly recommend reading the Loyalty - Gamification and User Behavior Guide. Loyalty is a premium Gigya platform that requires separate activation. If it is not yet a part of your existing site package, please contact Gigya Support via the Support link in the top menu of your Console Dashboard or email


This API retrieves the variants of a challenge. Each variant represents an action attribute, which is used to annotate actions with additional information, such as the section of the web site that generated the action. Read more about Variants and Action Attributes.

Request URL

Where <Data_Center> is:
  • - For the US data center.
  • - For the European data center.
  • - For the Australian data center.
  • - For the Russian data center.
  • - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.


challengeIDstringThe ID of the challenge for which to retrieve the variants.
variantIDstringA comma-separated list of variantIDs. Each variantID represents an action attribute. When not specified all the variants are returned. 
actionAttributesJSONA JSON object defining the action attributes.
limitintegerThe maximum number of variants to return. The default value is 100 and the maximum value is 1000.
startstringDefines what should be the starting point of the variants to retrieve. The purpose of this parameter is pagination of the variants. For the first page don't set the start parameter. The response includes a next field, which is a pointer to the starting point of the next page. Set the start parameter with the value of the next field received in the response of the previous getChallengeVariants request.
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 


Response Data

variantsarrayAn array of variants. Each variant is represented by an object that includes the following fields:
  • variantID - the variant unique identifier
  • actionAttributes - the JSON objects representing the action attributes
nextstringA pointer to the starting point of the next variants page. The purpose of this field is pagination of the variants. Use this field as the value of the 'start' parameter of the next getChallengeVariants request, thus retrieving the next variants and avoid retrieving the same variants again.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.


A field that does not contain data will not appear in the response.



Response Example

  "variants": [{
      "variantID": "864787092646246987",
      "actionAttributes": {
        "glee": [
      "variantID": "Code- 222-",
      "actionAttributes": {
        "Code": [ "222" ]
      "variantID": "Code-100-",
      "actionAttributes": {
        "Code": [
  "next": "Code-300-",
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "e8dbf561e17944e28ef93c5ab27aff3c",
  "time": "2015-03-22T11:42:25.943Z"