Gigya Job Openings

comments.getTopRatedStreams JS

Skip to end of metadata
Go to start of metadata

Description

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 to

REST API > comments.getTopRatedStreams.

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription

categoryIDstringThe 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).
limitintegerThe number of streams to retrieve. The default is 20 streams. The maximum is 1000.
maxStreamAgeintegerThe 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).
minRatingCountintegerThe minimum amount of ratings that is required in order to consider the stream in the top-rated list. The default is 1.
streamTagstringThis parameter is used to filter the top streams. The method returns only streams that are associated with this tag.

 

Response Object Data Members

FieldTypeDescription
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Response Codes and Errors table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.
streamsArray of Stream info objectsAn array listing the streams. Each stream is represented by a Stream info object.

 

Code Sample

function printResponse(response) {  
    if ( response.errorCode == 0 ) {             
        if ( null!=response.streams && response.streams.length>0) {        
            var msg = 'My top commenting stream is:\n\n';        
            msg += 'Stream title: ' + response.streams[0].streamTitle + ',  RSS URL: ' + response.streams[0].rssURL;
            alert(msg);
        }
        else {
            alert('No streams were returned');
        }
    } else {
        alert('Error :' + response.errorMessage);
    }
}

var params = {
    callback:printResponse
};

gigya.comments.getTopRatedStreams(params); 

Notes:

  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the gigya.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.