This method tracks and counts referral traffic. Referral traffic is the site visits that are a result of linkbacks, this refers to any traffic that comes to your site via a link that was distributed to a social network or an email. Links can be distributed through shares, status updates, emails, sharing reactions, commenting and chatting.
The accumulation of the referral tracking is presented in the 'Referred Traffic' report on Gigya's website.
Gigya automatically tracks referral traffic when the page loads, so calling this method is recommended when you wish to filter the 'Referred Traffic' report according to its 'cid', which is the context ID. Read more in the Referred Traffic guide.
The following providers currently support this operation: Facebook, Twitter, Delicious, Stumbleupon, Technorati, Mixx.
The following table lists the params object members:
|Optional||callback||function||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.
|cid||string||A string of maximum 100 characters length. This string is associated with each transaction and will later appear on reports generated by Gigya in the "Context ID" combo box. The cid allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. The "Context ID" combo box lets you filter the report data by site/application context. |
Note: the value of this parameter overrides the value of the identical parameter in the global configuration object.
|context||object||A developer-created object that is passed back unchanged to the application as one of the fields in the response object.|
Response Object Data Members
|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.|
- 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.