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.
us1.gigya.com- For the US data center.
eu1- For the European data center.
au1- For the Australian data center.
ru1- For the Russian data center.
cn1- For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
|||challengeID||string||The ID of the challenge for which to retrieve the variants.|
|||variantID||string||A comma-separated list of variantIDs. Each variantID represents an action attribute. When not specified all the variants are returned.|
|||actionAttributes||JSON||A JSON object defining the action attributes.|
|||limit||integer||The maximum number of variants to return. The default value is 100 and the maximum value is 1000.|
|||start||string||Defines 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.|
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:
Please refer to the Authorization Parameters section for details.
|variants||array||An array of variants. Each variant is represented by an object that includes the following fields:|
|next||string||A 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.|
A field that does not contain data will not appear in the response.