How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Matomo Referrers API

The Matomo Referrers API exposes 23 operations of the Matomo Reporting API (module `Referrers`). Where traffic came from: referrer type, search engines, keywords, campaigns, websites, social networks and AI assistants. Every operation is dispatched through the single `/index.php?module=API&method=Referrers.` entrypoint on the customer's own Matomo instance, self-hosted or on Matomo Cloud. The OpenAPI 3.1.0 document is Matomo's own, generated by its first-party ApiReference plugin.

Matomo Referrers API is one of 61 APIs that Matomo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics, Referrers, Campaigns, Search Engines, and Social. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 23 operations across 23 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://demo-proxy.innocraft.cloud/.

23 operations 23 paths 4 schemas 23 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://{matomo_host}/index.php
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Matomo Referrers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (MatomoToken). By default, every request must be authenticated.

  • MatomoToken — Paste your token generated from Personal Security. Swagger will send it as a Bearer token.

Paths & Operations 23

Across 23 paths, the API surfaces 23 operations — 23 GET. Each is listed below with its method, path, parameters, and response codes.

Referrers 23

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, "getKey…

GET
/index.php?module=API&method=Referrers.get
Returns the referrer overview report with distinct referrer counts and percentage metrics.
Referrers.get 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getReferrerType
Returns a report describing visit information for each possible referrer type. The result is a datatable whose subtables are the reports for each parent row's referrer type.
Referrers.getReferrerType 9 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getAll
Returns a flattened report containing all referrer subtables merged into one table.
Referrers.getAll 5 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getKeywords
Returns search keywords that brought visits to the requested website.
Referrers.getKeywords 7 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getSearchEnginesFromKeywordId
Returns the search engines associated with a specific keyword subtable.
Referrers.getSearchEnginesFromKeywordId 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getSearchEngines
Returns search engines that referred visits to the requested website.
Referrers.getSearchEngines 7 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getKeywordsFromSearchEngineId
Returns keywords for a specific search engine subtable.
Referrers.getKeywordsFromSearchEngineId 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getCampaigns
Returns campaigns that referred visits to the requested website.
Referrers.getCampaigns 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getKeywordsFromCampaignId
Returns campaign keywords for a specific campaign subtable.
Referrers.getKeywordsFromCampaignId 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getWebsites
Returns referring websites for the requested website.
Referrers.getWebsites 7 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getUrlsFromWebsiteId
Returns individual referrer URLs for a specific website subtable.
Referrers.getUrlsFromWebsiteId 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getSocials
Returns report comparing the number of visits and related metrics for social network referrers.
Referrers.getSocials 7 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getAIAssistants
Returns report comparing the number of visits and related metrics for AI assistant referrers.
Referrers.getAIAssistants 8 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getUrlsForSocial
Returns report containing individual referrer URLs for a specific social networking site.
Referrers.getUrlsForSocial 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getEntryPageUrlsForAIAssistant
Returns report containing individual entry page URLs for a specific AI assistant.
Referrers.getEntryPageUrlsForAIAssistant 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getEntryPageTitlesForAIAssistant
Returns report containing individual entry page names for a specific AI assistant.
Referrers.getEntryPageTitlesForAIAssistant 6 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getNumberOfDistinctSearchEngines
Returns the number of distinct search engines in the requested period.
Referrers.getNumberOfDistinctSearchEngines 5 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getNumberOfDistinctSocialNetworks
Returns the number of distinct social networks in the requested period.
Referrers.getNumberOfDistinctSocialNetworks 5 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getNumberOfDistinctKeywords
Returns the number of distinct search keywords in the requested period.
Referrers.getNumberOfDistinctKeywords 5 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getNumberOfDistinctCampaigns
Returns the number of distinct campaigns in the requested period.
Referrers.getNumberOfDistinctCampaigns 5 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getNumberOfDistinctWebsites
Returns the number of distinct referring websites in the requested period.
Referrers.getNumberOfDistinctWebsites 5 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getNumberOfDistinctAIAssistants
Returns the number of distinct AI assistants in the requested period.
Referrers.getNumberOfDistinctAIAssistants 5 params → 200400401403404500default
GET
/index.php?module=API&method=Referrers.getNumberOfDistinctWebsitesUrls
Returns the number of distinct referrer URLs in the requested period.
Referrers.getNumberOfDistinctWebsitesUrls 5 params → 200400401403404500default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), GenericSuccess (3 properties), ErrorXml (1 property), GenericSuccessXml (1 property). Each schema is shown below with its type and property counts.

GenericSuccess
object
Generic Matomo success payload.
3 properties 2 required
GenericSuccessXml
object
Generic Matomo success payload in XML.
1 property 1 required
Error
object
Generic Matomo error payload.
3 properties 2 required
ErrorXml
object
Generic Matomo error payload in XML.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

matomo-referrers-openapi.json Raw ↑

Other APIs Matomo publishes across the network.

Matomo Live API
Matomo Goals API
Matomo Segments API
Matomo Reporting API (index.php entrypoint)
Matomo Tracking API (matomo.php entrypoint)
Matomo SitesManager API
Matomo TagManager API
Matomo UsersManager API
Matomo CrashAnalytics API
Matomo HeatmapSessionRecording API
Matomo FormAnalytics API
Matomo Funnels API
Where this information came from

This is an independent, third-party profile of Matomo Referrers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.