This API retrieves a list of the streams that received the highest average stars via Gigya's Rating and Reviews plugin or the comments.postComment API. The method only retrieves streams created within the past predefined number of days and that contain a streamURL. You can set a streamURL using the comments.setStreamInfo API.
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 from which to retrieve the top streams. |
If this parameter is not specified, the method returns all site top streams (of all categories).
|||limit||integer||The maximum number of streams to retrieve. The default is 20 streams. The maximum is 1000 streams.|
|||maxStreamAge||integer||The maximum number of days since the streams were created (0-7). The method retrieves only streams that were created within the past maxStreamAge days. The default is 7, which means streams will be retrieved that are no more than 7 days old. To view streams more than 7 days old this must be set to 0.|
|||minRatingCount||integer||The minimum amount of ratings that are required in order to consider the stream in the top-rated list. The default is 1.|
|||streamTag||string||This parameter is used to filter the top streams. The method returns only streams that are associated with this tag.|
Each REST API request must contain identification and authorization parameters.
Please refer to the Authorization Parameters section for details.
|streams||Array of Stream info objects||An array listing the streams. Each stream is represented by a Stream info object.|
|isUserSubscribed||boolean||Whether or not the user making the API request is subscribed to get changes/updates to the stream.|
A field that does not contain data will not appear in the response.