Gigya Job Openings

socialize.getRawData REST

Skip to end of metadata
Go to start of metadata

 

 

Enables retrieving raw data directly from the provider. This allows accessing provider specific information, which is not supported by Gigya.
The response is returned exactly as it is received from the provider without translation by Gigya, so it is the site's responsibility to know how to use the information.

 

Note: The response from the provider is not sanitized. Keep this in mind when calling the API.

 

Supporting Providers

This operation is currently supported by the following providers: *Facebook, Twitter, Yahoo, LinkedIn, Google+, Xing, Odnoklassniki, Wechat, Microsoft, Instagram and Foursquare. (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). 

*Facebook does not support FQL requests for apps created after August 2014. If you have a newer app, instead of using this method with the 'fields' parameter to send an FQL request, you should use the 'path' parameter or use the socialize.facebookGraphOperation method.

Refer to the following links for information about the available data fields and the format of the response:

 

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
providerstringThe provider to retrieve data from. The following values are currently supported for use with this parameter: "facebook", "twitter", "yahoo", "linkedin", "googleplus", "xing", "odnoklassniki", "wechat", "microsoft", "instagram", "foursquare". (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used).
UIDstringThe user ID of the user for whom to retrieve the information.
fieldsstring

(Facebook only) Deprecated! A comma-separated list of provider-specific fields to retrieve. If you are using Facebook's Graph API this parameter may also be used for Facebook Query Language (FQL) queries. If the string starts with "SELECT" it will run as FQL.

The last version of the Facebook that supported this parameter is no longer available.

pathstring(Facebook only) For Facebook Graph API operations, this parameter specifies the path of the API from which you want to retrieve data, e.g./me/photos. This path is appended to the base API path, which is https://graph.facebook.com, to form the request.

You may also include parameters for the request, e.g. /v2.2/12341354253?fields=from,link.

Notes for users of Facebook app version 2.1 or higher:

  • Facebook does not support FQL requests for version 2.1 or higher, so you must always use 'path' instead of 'fields'.
  • If you do not pass either 'fields' or 'path' in the parameters, the API call defaults to FQL, which will result in an error.
dataFormatstringChoose the preferred format of the raw data. The options are:
  • json (default)
  • xml
Note: Not all the providers support both formats.
cidstring
A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.
   
format string Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are:
  • json
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
  • xml (default) - Deprecated. We do not support XML as a valid value any longer, however, it is the default response type due to backwards compatibility. You can only set the format parameter to either json or jsonp.
callback string This parameter is relevant only when the format parameter is set to jsonp (see above). In such case this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
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 occurs.

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.

 

dataanyThe data returned by the provider as-is, without any manipulation by Gigya.

Note: Every provider returns his individual data structure.

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

 

Response Example

 {
        "data": "[{\"uid\":70391,\"first_name\":\"Joe\",\"last_name\":\"Cook\",\"birthday\":\"May 31, 1972\}]",
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "2590f30a824c4429a0950fc91fbed58a"
    } 

 

The above is the response to the following request:

https://socialize.gigya.com/socialize.getRawData?apiKey=someValidGigyaApiKey&provider=facebook&UID=Z1sHOcDVFPhI8TfddDz7nA%3D%3D&path=%2Fme%3Ffields%3Did%2Cname&oauth_token=0