The method retrieves the most commented streams in the recent defined time period. The method retrieves only streams that were created within the past predefined number of days.
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.getTopStreams.
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 maximum number of streams to retrieve. The default is 20 streams. The maximum is 100.|
|||maxStreamAge||integer||The number of days. The method retrieves only streams that were created within the past maxStreamAge days. The default is 3 days. The maximum is 7 days.|
|||includeLastComment||Boolean||This parameter specifies whether to include the most recent comment in each 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 in each of the stream objects (see the Response Data table and Response Example below).|
A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes.
The callback function should be defined with the following signature: functionName(Response).
The "Response Object Data Members" table below provides specification of the data that is passed to the callback function.
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
|||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.|