Gigya Job Openings

StreamInfo JS

Skip to end of metadata
Go to start of metadata



A JSON object containing the meta information of a comments stream.


Field NameTypeDescription
approvedCommentCountintegerThe number of approved comments in the stream.
avgRatingsJSON object

The average rating for this stream (the mean value of all the ratings in the stream). The object structure is {'_overall': ratingAvgValue} , where ratingAvgValue is a float rounded to 2 digits after the decimal point.


  • The avgRatings field is available only if this stream belongs to a Category that is defined with 'Operation mode: Rating & Reviews'. Learn more in the R&R guide.
  • Reviews awaiting moderation do not affect the average.

categoryIDstringThe ID of the category to which this stream belongs.
createDatelongThe stream creation time, in Unix time format, i.e. seconds since Jan. 1st 1970.
isUserSubscribedBooleanEquals  'true' if the currently logged-in user is subscribed to this stream.
lastCommentComment objectThis field is available only if the includeLastComment is set to 'true' in the request. In such cases, this field represents the most recent comment of this stream.
lastCommentTimestamplongThe GMT in which the last comment was posted to the stream. The timestamp is in Unix Time (i.e. the number of seconds since Jan. 1st 1970). Note: this field is returned even if the includeLastComment  field isn't included.

An object containing string values that specify the moderation mode for different comments according to their content type (see Moderation Modes for more information).

    "text": "post|pre|guest|inherit",
    "image": "post|pre|guest|inherit",
    "video": "post|pre|guest|inherit",
    "url": "post|pre|guest|inherit",
    "other": "post|pre|guest|inherit"

rssURLURLThe URL of the RSS.
statusstringThe value of this field may be one of the following: 'readonly', 'enabled', or 'disabled' .
streamIDstringA unique stream ID.
streamTitlestringThe title assigned to the commenting stream. For more information, see the  Comments add-on parameters.
streamURLURLThe stream URL assigned to the commenting stream (usually the URL of the page where the commenting stream is presented). For more information, see the  Comments add-on  parameters.
threadCountintegerThe number of comment threads in the stream.
commentCountinteger Deprecated.

Note: A field that does not contain data willnot appear in the object.

Example Object

     "streamID": "foo1",
     "categoryID": "17235654",
     "status": "enabled",
     "createDate": 1297087491153,
     "commentCount": 56,
     "threadCount": 43,
     "streamTitle": "Foo",
     "streamURL": "",
     "rssURL": "",
     "avgRatings": {"_overall" : 4.1},
     "isUserSubscribed" : false