Tech docs
API Docs
Referrers

Referrers

#GET /referrers/(referrer_type)

Return a list of the top referrers for a referrer type. This can be either an overall number, or a number restricted to a specific domain.

#Path Arguments

referrer_typeOne of social, search, other, internal

#Optional Parameters

sectionSection to restrict this query to.
tagTag to restrict this query to.
domaindomain to restrict this query to.
period_startStart of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to 3 days ago, limited to most recent 90 days.
period_endEnd of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to current date and time if not specified.
pub_date_startPublication filter start date; see Date/Time Handling for formatting details.
pub_date_endPublication filter end date; see Date/Time Handling for formatting details. Defaults to current date and time if not specified.
limitNumber of records to retrieve; defaults to "10".
pagePage number to retrieve if multiple pages are available; defaults to 1. Retrieving a page that is unavailable returns an empty record list.
callbackJSON-P callback, a JavaScript function name that will be used to wrap the JSON response. The API also supports Cross-Origin Response Sharing.

#GET /referrers/(referrer_type)/(meta_type)

Return a list of the top posts, authors or sections referrered to.

#Path Arguments

referrer_typeOne of social, search, other, internal
meta_typeOne of posts, authors, sections, tags

#Optional Parameters

sectionSection to restrict this query to.
domaindomain to restrict this query to.
period_startStart of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to 3 days ago, limited to most recent 90 days.
period_endEnd of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to current date and time if not specified.
pub_date_startPublication filter start date; see Date/Time Handling for formatting details.
pub_date_endPublication filter end date; see Date/Time Handling for formatting details. Defaults to current date and time if not specified.
limitNumber of records to retrieve; defaults to "10".
pagePage number to retrieve if multiple pages are available; defaults to 1. Retrieving a page that is unavailable returns an empty record list.
callbackJSON-P callback, a JavaScript function name that will be used to wrap the JSON response. The API also supports Cross-Origin Response Sharing.

#GET /referrers/(referrer_type)/(meta_type)/(meta_value)/detail

Returns a list of posts falling under the specified author or section.

#Path Arguments

referrer_typeOne of social, search, other, internal
meta_typeOne of author, section, tag
meta_valuethe value for this meta type

#Optional Parameters

domaindomain to restrict this query to.
period_startStart of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to 3 days ago, limited to most recent 90 days.
period_endEnd of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to current date and time if not specified.
pub_date_startPublication filter start date; see Date/Time Handling for formatting details.
pub_date_endPublication filter end date; see Date/Time Handling for formatting details. Defaults to current date and time if not specified.
limitNumber of records to retrieve; defaults to "10".
pagePage number to retrieve if multiple pages are available; defaults to 1. Retrieving a page that is unavailable returns an empty record list.
callbackJSON-P callback, a JavaScript function name that will be used to wrap the JSON response.

#GET /referrers/post/detail

Return a list of the top referrers for a given url.

#Query Parameters

urlthe url to get referrer details for

#Optional Parameters

period_startStart of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to 3 days ago, limited to most recent 90 days.
period_endEnd of date range to consider traffic from; see Date/Time Handling for formatting details. Defaults to current date and time if not specified.
callbackJSON-P callback, a JavaScript function name that will be used to wrap the JSON response.
rocket emoji