Gigya Job Openings

gm.getActionsLog 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 support@gigya.com.

Description

This API retrieves a specified user's Game Mechanics (GM) actions and how many points are associated with each action. You can retrieve all the user's actions or only actions that were performed during a specific time frame.

Note: Summing up the action log does not necessarily result in the current point count, since a user cannot have negative points value, but the log does include negative values.

 

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
UIDstring
The UID for which to retrieve the actions log.
startTimeintegerThe start time for which to retrieve the actions log in Unix timestamp format.
endTimeintegerThe end time for which to retrieve the actions log in Unix timestamp format.
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

FieldTypeDescription
 
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.

 

actionsarrayAn array of actions. Each action is represented by an object that includes the following fields:
  • time - the time the action was performed
  • actionID - the GM action that was performed
  • points - the number of points the action received
  • ip - the IP address from where the action was performed
  • challengeID - the challenge ID to which the action is associated
  • operation - the type of operation of the log entry for this action. Can be either grant, when points were granted due to a gm.notifyAction or automatically for built-in actions, or redeem, when points were redeemed.

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

 

 

Response Example

{
  "actions": [
    {
      "time": "2012-04-16 09:17:00Z",
      "actionID": "1",
      "points": 10,
      "ip": "127.0.0.1",
      "challengeID" : "_default",
      "operation" : "grant"
    },
    {
      "time": "2012-04-16 09:16:45Z",
      "actionID": "_siteLogin",
      "points": 10,
      "ip": "192.168.10.213",
      "challengeID" : "books",
      "operation" : "grant"
    }
  ],
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "dd62d65ba14d4352ac239fc1f37a53c3",
  "time": "2012-04-16T09:18:25.943Z"
}

 

 

Using The Response

When using the SDK, you will likely need to convert the response to an appropriate JSON object, you can use the built-in toJsonString() function of the SDK to accomplish this. 

Example:

// If setting the format parameter to json (or default)
$responseObject = $response->getData()->toJsonString();
// Will give you the result shown above