Gigya Job Openings

comments.getStreamInfo REST

Skip to end of metadata
Go to start of metadata

 

Description

Returns meta information of a specified commenting stream.

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
categoryIDstringThe identifier of the comments category to which the requested stream belongs.
streamIDstringThe unique ID of the stream that you would like to retrieve.
includeLastCommentBooleanThis parameter specifies whether to include the most recent comment in the stream. The default value of this parameter is 'false'. If this parameter is set to 'true', the response of this method includes a "lastComment" field within the Stream info object (see the Response Data table and Response Example below).
includeRatingDetailsBoolean

Indicates whether to return the ratingDetails object in the response. ratingDetails is an array of all dimensions and "_overall". For example:

ratingDetails: {
   "_overall" : {
      ratings: [0,5,3,6,9],
      avg: 3.82
   }
   "dimension1": {
      ratings: [1,4,2,1,0],
      avg: 2.37
   }
}

The ratings array represents the number of users who gave a specific rating, where the position in the array represents the given rating. So in the above example, 0 users gave a rating of 1 star, 5 users gave a rating of 2 stars, 3 users gave a rating of 3 stars etc. The average of the ratings is also returned.

streamIDsarray or stringA comma delimited list of stream IDs or an array of stream IDs, i.e. "['stream1','stream2']". When this parameter exists, it overrides the streamID parameter.
This parameter supports up to 100 stream IDs.
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. 

Sample Requests

 

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.

 

streamInfoStream info objectA JSON object containing meta information of the requested commenting stream. When multiple streamIDs are requested, the response streamInfo is an array of Stream info objects.
streamTagsarrayAn array of tags (strings) that are associated with the stream.

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

Response Example

{
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "31ba039fb8d340ceb2f43d52c89bf187",
        "time": "2015-03-22T11:42:25.943Z",
        "streamInfo": {
            "streamID": "foo1",
            "categoryID": "17235654",
            "status": "enabled",
            "createDate": 1297087491153,
            "commentCount": 56,
            "threadCount": 43,
            "streamTitle": "Foo",
            "streamURL": "http://wildfiresocial.com/Foo.htm",
            "rssURL": "http://comments.gigya.com/comments/rss/1069621/17235654/foo1",
            "avgRatings": {"_overall" : 4.1}
        }
}

Unable to render {include} The included page could not be found.