Gigya Job Openings

reports.getGMRedeemablePoints REST

Skip to end of metadata
Go to start of metadata

 

Description

This method retrieves the current total redeemable points across your user base, per challenge.
Redeemable points indicates the spending power of a site's user base at a given time.
 

Request URL


Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

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


Parameters

RequiredNameTypeDescription
challengeID stringID of the challenge you want to retrieve the redeemable points for. If no value is set, redeemable points for all challenges are returned.
dataFormatstringDetermines the format of the data field of the response. The options are either 'csv' (default) or 'json'.  

 

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 
 

Response Data

FieldTypeDescription
errorCodeIntegerThe 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.
errorMessageStringA 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.
errorDetailsStringThis field will appear in the response only in case of an error and will contain the exception info, if available.
callIdStringUnique identifier of the transaction, for debugging purposes.
headersArray of stringsThe headers of the response data.
dataCSVThe reports' data in CSV format.

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


Response Example

{
      "statusCode": 200,
      "errorCode": 0,
      "statusReason": "OK",
      "callId": "84f7c522626c4c9ebe743af31881849d",
      "time": "2015-03-22T11:42:25.943Z",
      "headers": [
        "challengeID",
        "points",
      ],
      "data": [
      [
        "MasterChildref",
        864.0
      ],
        [
        "qagroup",
        3735.0
      ],
      [
        "Ref1",
        500.0
      ],
      [
        "TimeFrame",
        1800
      ],
      [
        "_default",
        810.0
      ]
     ]
    }