# Matomo Referrers API

**Canonical:** https://apis.io/apis/matomo/matomo-referrers-api/  
**Provider:** Matomo — https://apis.io/providers/matomo/  
**Base URL:** https://{matomo_host}/index.php  
**Documentation:** https://developer.matomo.org/api-reference/reporting-api

Matomo Referrers API is one of 61 APIs that [Matomo](https://apis.io/providers/matomo/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Referrers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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 <a href='https://developer.matomo.org/api-reference/reporting-api#api-response-metric-definitions' rel='noreferrer' target='_blank'>general analytics metrics</a> 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.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/index.php?module=API&method=Referrers.get` | — |
| GET | `/index.php?module=API&method=Referrers.getReferrerType` | — |
| GET | `/index.php?module=API&method=Referrers.getAll` | — |
| GET | `/index.php?module=API&method=Referrers.getKeywords` | — |
| GET | `/index.php?module=API&method=Referrers.getSearchEnginesFromKeywordId` | — |
| GET | `/index.php?module=API&method=Referrers.getSearchEngines` | — |
| GET | `/index.php?module=API&method=Referrers.getKeywordsFromSearchEngineId` | — |
| GET | `/index.php?module=API&method=Referrers.getCampaigns` | — |
| GET | `/index.php?module=API&method=Referrers.getKeywordsFromCampaignId` | — |
| GET | `/index.php?module=API&method=Referrers.getWebsites` | — |
| GET | `/index.php?module=API&method=Referrers.getUrlsFromWebsiteId` | — |
| GET | `/index.php?module=API&method=Referrers.getSocials` | — |
| GET | `/index.php?module=API&method=Referrers.getAIAssistants` | — |
| GET | `/index.php?module=API&method=Referrers.getUrlsForSocial` | — |
| GET | `/index.php?module=API&method=Referrers.getEntryPageUrlsForAIAssistant` | — |
| GET | `/index.php?module=API&method=Referrers.getEntryPageTitlesForAIAssistant` | — |
| GET | `/index.php?module=API&method=Referrers.getNumberOfDistinctSearchEngines` | — |
| GET | `/index.php?module=API&method=Referrers.getNumberOfDistinctSocialNetworks` | — |
| GET | `/index.php?module=API&method=Referrers.getNumberOfDistinctKeywords` | — |
| GET | `/index.php?module=API&method=Referrers.getNumberOfDistinctCampaigns` | — |
| GET | `/index.php?module=API&method=Referrers.getNumberOfDistinctWebsites` | — |
| GET | `/index.php?module=API&method=Referrers.getNumberOfDistinctAIAssistants` | — |
| GET | `/index.php?module=API&method=Referrers.getNumberOfDistinctWebsitesUrls` | — |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-referrers-api-openapi.yml
- **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

## Other Matomo APIs (12)

- [Matomo Reporting API (index.php entrypoint)](https://apis.io/apis/matomo/matomo-index-php-api/)
- [Matomo Tracking API (matomo.php entrypoint)](https://apis.io/apis/matomo/matomo-matomo-php-api/)
- [Matomo Ab Testing API](https://apis.io/apis/matomo/matomo-abtesting-api/)
- [Matomo Actions API](https://apis.io/apis/matomo/matomo-actions-api/)
- [Matomo Activity Log API](https://apis.io/apis/matomo/matomo-activitylog-api/)
- [Matomo Advertising Conversion Export API](https://apis.io/apis/matomo/matomo-advertisingconversionexport-api/)
- [Matomo Annotations API](https://apis.io/apis/matomo/matomo-annotations-api/)
- [Matomo API](https://apis.io/apis/matomo/matomo-api-api/)
- [Matomo API Reference API](https://apis.io/apis/matomo/matomo-apireference-api/)
- [Matomo Bandwidth API](https://apis.io/apis/matomo/matomo-bandwidth-api/)
- [Matomo Cohorts API](https://apis.io/apis/matomo/matomo-cohorts-api/)
- [Matomo Contents API](https://apis.io/apis/matomo/matomo-contents-api/)

## Tags

Referrers

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/matomo/matomo-referrers-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/matomo/.