Authentication Required

API Key

Parameters

Required

site_token Site Token

Optional

referrersLimit Start and end positions for the portion of referrers to send back. Values can be:

A single integer n - fetch the n topreferrers

Comma-delimited string x , n - fetch the top n referrers stating at position x

Returns

JSON ONLY. Object of information about referrers to this site. Referrers are ordered descending by the number of concurrents referred.

Key Type Description
cardinality Integer The total number of unique organic referrers that are referring concurrents
direct Object Object containing key visitors, an integer representing total visitors from direct referrers
[DOMAIN NAME] Object Object encapsulating referrers from a specific domain, containing the following keys:
total Total number of distinct referring urls from this domain
visitors Total number of visitors referred from this domain
[URL] Integer representing number of visitors referred from a specific URL

Complexity Cost

1 unit.

Example Request

http://api.gosquared.com/referrers?api_key=API_KEY&site_token=GSN-1234567-X

Example Response

{
    "referrers": {
        "cardinality": 72,
        "direct": {
            "visitors": 252
        },
        "bbc.co.uk": {
            "http://www.bbc.co.uk/technology": 182,
            "total": 1,
            "visitors": 182
        },
        "twitter.com": {
            "http://twitter.com/gosquared": 32,
            "http://twitter.com/gosquaredstatus": 30,
            "http://twitter.com/jamesjgill": 23,
            "http://twitter.com/floopily": 22,
            "http://twitter.com/thedeveloper": 21,
            "total": 5,
            "visitors": 128
        },
        "techcrunch.com": {
            "http://www.techcrunch.com/": 60,
            "http://www.techcrunch.com/page/2/": 47,
            "total": 2,
            "visitors": 107
        },
        "smashingmagazine.com": {
            "http://www.smashingmagazine.com": 37,
            "total": 1,
            "visitors": 37
        }
    }
}
Last modified: 3 April 2012 12:15