Get referrers with the WordPress.com API

Returns the sites and search engines that sent visits to a site over the last num periods up to date: per day in days, or added up in summary when summarize is true.

Identifier
wordpress_com_get_referrers

The request

POST https://connect.reportei.com/api/tools/wordpress_com_get_referrers/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "site": "<site>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
sitestringYesID of the site, from List sites, or its domain, like example.wordpress.com.
periodstringNoUnit of the window. The default is day.Values: day, week, month, year
numintegerNoHow many periods the window has, ending at date. The default is 1.
datestringNoLast day of the window, as YYYY-MM-DD. The default is today.
maxintegerNoHow many referrers to return. The default is 10.
summarizebooleanNotrue adds up the whole window in summary instead of returning each day.

Supported connections

Your customer connects their WordPress.com account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/wordpress_com, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/wordpress_com_get_referrers. It becomes your agent's tool definition with no conversion.

Other WordPress.com tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.