Matomo

Matomo Referrers API

The Referrers API lets you access reports about websites, search engines, keywords, social networks, AI assistants, and campaigns used to access your website. For example, "getKeywords" returns all search engine keywords (with general analytics metrics for each keyword), "getWebsites" returns referrer websites (along with the full Referrer URL if the parameter &expanded=1 is set). "getReferrerType" returns the Referrer overview report. "getCampaigns" returns the list of all campaigns (and all campaign keywords if the parameter &expanded=1 is set). "getSocials" returns social network referrers, and "getAIAssistants" returns AI assistant referrers.

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 23

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /index.php?module=API&method=Referrers.get Get the referrer overview report · Referrers get #
Ask an LLM
“How many distinct referrers sent traffic to my site last month?”
“Is there a single overview of all referrer counts and percentages for a period?”
Tell an agent
Get the referrer overview for site {idSite} for {period} {date}.
Show the acquisition summary with distinct referrer counts for site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getReferrerType Report visits by referrer channel type · Referrers get referrer type #
Ask an LLM
“How much of my traffic comes from search versus direct entry versus websites?”
“Can I break visits down by channel type like campaigns and social networks?”
Tell an agent
Break down visits by channel type for site {idSite} for {period} {date}.
Show only {typeReferrer} channel visits for site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getAll Get all referrers merged in one flat table · Referrers get all #
Ask an LLM
“Can I get every referrer, across search, sites, social and campaigns, in one flat list?”
“Is there a flattened table of all my referrer sources for a date range?”
Tell an agent
Get one flattened table of all referrers for site {idSite} for {period} {date}.
Merge every referrer subtable into a single list for site {idSite}.
GET /index.php?module=API&method=Referrers.getKeywords Report search keywords that brought visits · Referrers get keywords #
Ask an LLM
“Which search keywords are people using to find my website?”
“What were my top organic search terms last week?”
Tell an agent
List the search keywords that brought visitors to site {idSite} for {period} {date}.
Show a flat keyword report for site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getSearchEnginesFromKeywordId Get search engines for one keyword · Referrers get search engines from keyword id #
Ask an LLM
“Which search engines sent visits for one particular keyword?”
“Can I drill into a keyword row to see the engines behind it?”
Tell an agent
Show the search engines behind keyword subtable {idSubtable} for site {idSite} on {date}.
Drill into keyword row {idSubtable} for {period} {date} to list its search engines.
GET /index.php?module=API&method=Referrers.getSearchEngines Report search engines that referred visits · Referrers get search engines #
Ask an LLM
“Which search engines send me the most visitors?”
“Can I compare traffic from different search engines over a month?”
Tell an agent
List the search engines that referred visits to site {idSite} for {period} {date}.
Rank search engine traffic for site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getKeywordsFromSearchEngineId Get keywords for one search engine · Referrers get keywords from search engine id #
Ask an LLM
“What keywords did visitors from one specific search engine type?”
“Can I drill into a search engine row to see its keywords?”
Tell an agent
List the keywords for search engine subtable {idSubtable} on site {idSite} for {date}.
Drill into search engine row {idSubtable} for {period} {date} and show its keywords.
GET /index.php?module=API&method=Referrers.getCampaigns Report marketing campaigns that drove visits · Referrers get campaigns #
Ask an LLM
“Which marketing campaigns drove traffic to my site?”
“How did my campaigns perform in terms of visits last quarter?”
Tell an agent
List the campaigns that referred visits to site {idSite} for {period} {date}.
Show campaign traffic for site {idSite} on {date} with keyword rows expanded.
GET /index.php?module=API&method=Referrers.getKeywordsFromCampaignId Get keywords for one campaign · Referrers get keywords from campaign id #
Ask an LLM
“What campaign keywords were used within one specific campaign?”
“Can I drill into a campaign row to see its keyword values?”
Tell an agent
List campaign keywords for campaign subtable {idSubtable} on site {idSite} for {date}.
Drill into campaign row {idSubtable} for {period} {date}.
GET /index.php?module=API&method=Referrers.getWebsites Report referring websites · Referrers get websites #
Ask an LLM
“Which other websites link to mine and send visitors?”
“What were my top referring domains this month?”
Tell an agent
List the referring websites for site {idSite} for {period} {date}.
Rank the external domains sending traffic to site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getUrlsFromWebsiteId Get referring page URLs for one website · Referrers get urls from website id #
Ask an LLM
“Which exact pages on a referring website linked to me?”
“Can I drill into a referring domain to see the individual URLs?”
Tell an agent
List the referrer URLs inside website subtable {idSubtable} for site {idSite} on {date}.
Drill into referring domain row {idSubtable} for {period} {date} to see its linking pages.
GET /index.php?module=API&method=Referrers.getSocials Report social network referrers · Referrers get socials #
Ask an LLM
“Which social networks send me the most visits?”
“How does traffic from social media compare across networks?”
Tell an agent
List the social networks that referred visits to site {idSite} for {period} {date}.
Compare social media traffic for site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getAIAssistants Report AI assistant referrers · Referrers get AI assistants #
Ask an LLM
“Are AI assistants and chatbots sending visitors to my website?”
“Which AI assistants referred the most visits last month?”
Tell an agent
List the AI assistants that referred visits to site {idSite} for {period} {date}.
Show AI assistant referrals for site {idSite} on {date} split by {secondaryDimension}.
GET /index.php?module=API&method=Referrers.getUrlsForSocial Get referrer URLs for one social network · Referrers get urls for social #
Ask an LLM
“Which specific posts or pages on a social network linked to my site?”
“Can I drill into one social network to see individual referring URLs?”
Tell an agent
List the referrer URLs for social network subtable {idSubtable} on site {idSite} for {date}.
Show the individual social links that sent visits to site {idSite} for {period} {date}.
GET /index.php?module=API&method=Referrers.getEntryPageUrlsForAIAssistant Get entry page URLs for one AI assistant · Referrers get entry page urls for AI assistant #
Ask an LLM
“Which page URLs did visitors land on when an AI assistant referred them?”
“Can I see the landing URLs for traffic from one specific AI assistant?”
Tell an agent
List entry page URLs for AI assistant subtable {idSubtable} on site {idSite} for {date}.
Show the landing URLs reached from AI assistants on site {idSite} for {period} {date}.
GET /index.php?module=API&method=Referrers.getEntryPageTitlesForAIAssistant Get entry page titles for one AI assistant · Referrers get entry page titles for AI assistant #
Ask an LLM
“What are the titles of the pages AI assistant visitors entered on?”
“Can I see landing page names, rather than URLs, for one AI assistant?”
Tell an agent
List entry page titles for AI assistant subtable {idSubtable} on site {idSite} for {date}.
Show the page names AI-referred visitors landed on for site {idSite} in {period} {date}.
GET /index.php?module=API&method=Referrers.getNumberOfDistinctSearchEngines Count distinct search engines in a period · Referrers get number of distinct search engines #
Ask an LLM
“How many different search engines sent me traffic this month?”
“Can I get just the count of search engines, not the full report?”
Tell an agent
Count the distinct search engines for site {idSite} for {period} {date}.
Tell me the number of unique search engines referring site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getNumberOfDistinctSocialNetworks Count distinct social networks in a period · Referrers get number of distinct social networks #
Ask an LLM
“How many different social networks referred visitors last week?”
“Is there a quick number for unique social referrers in a period?”
Tell an agent
Count the distinct social networks for site {idSite} for {period} {date}.
Tell me how many unique social platforms sent traffic to site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getNumberOfDistinctKeywords Count distinct search keywords in a period · Referrers get number of distinct keywords #
Ask an LLM
“How many unique search keywords brought visitors this month?”
“What's the total count of distinct search terms for a date range?”
Tell an agent
Count the distinct search keywords for site {idSite} for {period} {date}.
Give me the number of unique search terms for site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getNumberOfDistinctCampaigns Count distinct campaigns in a period · Referrers get number of distinct campaigns #
Ask an LLM
“How many different campaigns drove traffic during a period?”
“Can I get only the number of active campaigns that sent visits?”
Tell an agent
Count the distinct campaigns for site {idSite} for {period} {date}.
Tell me how many unique campaigns referred site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getNumberOfDistinctWebsites Count distinct referring websites in a period · Referrers get number of distinct websites #
Ask an LLM
“How many different websites linked to me and sent visits?”
“What's the count of unique referring domains for last month?”
Tell an agent
Count the distinct referring websites for site {idSite} for {period} {date}.
Tell me the number of unique referring domains for site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getNumberOfDistinctAIAssistants Count distinct AI assistants in a period · Referrers get number of distinct AI assistants #
Ask an LLM
“How many different AI assistants referred visitors this week?”
“Can I get a single count of unique AI chatbot referrers?”
Tell an agent
Count the distinct AI assistants for site {idSite} for {period} {date}.
Tell me how many unique AI assistants sent traffic to site {idSite} on {date}.
GET /index.php?module=API&method=Referrers.getNumberOfDistinctWebsitesUrls Count distinct referrer URLs in a period · Referrers get number of distinct websites urls #
Ask an LLM
“How many individual referring page URLs sent traffic, not just domains?”
“What's the count of unique referrer URLs for a period?”
Tell an agent
Count the distinct referrer URLs for site {idSite} for {period} {date}.
Tell me the number of unique linking page URLs for site {idSite} on {date}.

Documentation

📖
Documentation
https://developer.matomo.org/api-reference/reporting-api
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api#Live
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api#Goals
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api-segmentation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-referrers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/matomo:matomo-referrers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

matomo-referrers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Matomo Reporting API for plugin Referrers API
  version: 1.0.0
  description: The Referrers API lets you access reports about websites, search engines, keywords, social networks, AI assistants, and campaigns used to access your website.
servers:
- url: https://demo-proxy.innocraft.cloud/
  description: Current Matomo instance
security:
- MatomoToken: []
tags:


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-referrers-api-openapi.yml