The Live API functions allow some lists to be segmented, or "filtered" by certain constraints, such as showing the page and visitor lists for a specific referrer, or visitors and referrers for a specific page. This filtering is done by means of a filter parameter in the request.
To filter results by a specific page, use the query parameter page, containing an MD5 hash of the page's complete URL, as passed in the href key in any of the page functions.
Page filtering affects the output of aggregateStats, organics, referrers, visitor (when using direction) and visitors.
To show visitors filtered by the page http://www.gosquared.com/ (MD5 hash 10a138b43c143f17c7ac9a0422238cd5), use the request:
http://api.gosquared.com/visitors?site_token=GSN-1234567-X&api_key=API_KEY&page=10a138b43c143f17c7ac9a0422238cd5
To filter results by a specific referrer, use the query parameter referrer. This should contain a comma-separated list of MD5 hashes of referring URLS to filter by. To filter by the "Direct" referrer, set this parameter to the value direct
Referrer filtering affects the output of aggregateStats, pages, visitor (when using direction) and visitors.
To show pages for the referrer http://www.bbc.co.uk/ (MD5 a78359efac162eed0807e0d85761441f), use the request:
http://api.gosquared.com/pages?site_token=GSN-1234567-X&api_key=API_KEY&referrer=a78359efac162eed0807e0d85761441f
To filter results by a specific organic referrer, use the query parameter organic. This can be a comma-separated list of MD5 hashes or single MD5 hash of (search engine + query) to filter by.
Referrer filtering affects the output of aggregateStats, pages, visitor (when using direction) and visitors.
To show aggregateStats for the search engine/query pair "google" / "GoSquared" (MD5 of "googleGoSquared" = a78359efac162eed0807e0d85761441f) use the query:
http://api.gosquared.com/aggregateStats?site_token=GSN-1234567-X&api_key=API_KEY&organic=a78359efac162eed0807e0d85761441f