Was this article helpful?

socialize.getTopShares

Last modified 11:21, 21 Aug 2012

Description

The method allows to see the content (URLs) most shared on a site in the recent defined time period (up to 7 days).

 

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 > socialize.getTopShares.

 

Syntax

gigya.socialize.getTopShares(params)

 

Method Parameters

The following table lists the params object members:

Required Name Type Description
Required age integer The age of the share in days, up to 7 days.
Optional tag string
The tag by which to filter the list of shares. The default is an empty string.
  limit integer The number of rows to retrieve. The default is 100 rows. The maximum allowed value is 1000.

 

Response Object Data Members

Field Type Description
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 Error Codes table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
operation string The name of the API method that generated this response.
context object The context object passed by the application as parameter to the API method, or null if no context object has been passed.
topShares array An array of JSON objects that include:
  • url - a string representing the url that was shared
  • count - the number of times the url was shared

 

Code Sample

function printResponse(response) {
    if ( response.errorCode == 0 ) {           
        var myTopShares = response['topShares'];        
        if ( null!=myTopShares && myTopShares.length>0) {      
            var msg = 'Top Shares: \n';      
     for (var index in myTopShares) {
                msg += myTopShares[index].url + ': ' + myTopShares[index].count + '\n';
            }
            alert(msg);
        }
        else {
            alert('No Top Shares were returned');
        }
    }
    else {
        alert('Error :' + response.errorMessage);
    }
}


var params ={
age:4,
callback:printResponse
};


gigya.socialize.getTopShares(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 socialize.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.
  • In some cases it is necessary to connect/login the user to a provider? prior to calling the API method. You can learn more in the Social Login guide.

Was this article helpful?
Page statistics
2191 view(s) and 1 edit(s)
Social share
Share this page?

Tags

This page has no custom tags set.

Comments

You must to post a comment.

Attachments