Returns meta information of a specified commenting stream.
us1.gigya.com- For the US data center.
eu1- For the European data center.
au1- For the Australian data center.
ru1- For the Russian data center.
cn1- For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
|||categoryID||string||The identifier of the comments category to which the requested stream belongs.|
|||streamID||string||The unique ID of the stream that you would like to retrieve.|
|||includeLastComment||Boolean||This 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).|
Indicates whether to return the ratingDetails object in the response. ratingDetails is an array of all dimensions and "_overall". For example:
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.
|||streamIDs||array or string||A 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.
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:
Please refer to the Authorization Parameters section for details.
|streamInfo||Stream info object||A 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.|
|streamTags||array||An array of tags (strings) that are associated with the stream.|
A field that does not contain data will not appear in the response.