The method retrieves a list of the streams that received the highest average stars via Gigya's R&R plugin or the comments.postComment API. The method only retrieves streams that were created within the past predefined number of days and that contain a streamURL.
Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer toREST API > comments.getTopRatedStreams.
The following table lists the available parameters:
|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 number of streams to retrieve. The default is 20 streams. The maximum is 1000.|
|||maxStreamAge||integer||The maximum number of days since the streams were created. The method retrieves only streams that were created within the past maxStreamAge days. The default is 3 and the maximum is 7. Specify 0 to retrieve all streams regardless of age (the number of streams retrieved will still be limited by the limit parameter).|
|||minRatingCount||integer||The minimum amount of ratings that is 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.|
Response Object Data Members
|streams||Array of Stream info objects||An array listing the streams. Each stream is represented by a Stream info object.|