# Matomo API

**Canonical:** https://apis.io/apis/matomo/matomo-api-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 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. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API is the <a href='https://matomo.org/docs/analytics-api/metadata/' rel='noreferrer' target='_blank'>Metadata API</a>: it gives information about all other available APIs methods, as well as providing human readable and more complete outputs than normal API methods. Some of the information that is returned by the Metadata API: <ul> <li>the dynamically generated list of all API methods via "getReportMetadata"</li> <li>the list of metrics that will be returned by each method, along with their human readable name, via "getDefaultMetrics" and "getDefaultProcessedMetrics"</li> <li>the list of segments metadata supported by all functions that have a 'segment' parameter</li> <li>the (truly magic) method "getProcessedReport" will return a human readable version of any other report, and include the processed metrics such as conversion rate, time on site, etc. which are not directly available in other methods.</li> <li>the method "getSuggestedValuesForSegment" returns top suggested values for a particular segment. It uses the Live.getLastVisitsDetails API to fetch the most recently used values, and will return the most often used values first.</li> </ul> The Metadata API is for example used by the Matomo Mobile App to automatically display all Matomo reports, with translated report & columns names and nicely formatted values. More information on the <a href='https://matomo.org/docs/analytics-api/metadata/' rel='noreferrer' target='_blank'>Metadata API documentation page</a>

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/index.php?module=API&method=API.getMatomoVersion` | — |
| GET | `/index.php?module=API&method=API.getPhpVersion` | — |
| GET | `/index.php?module=API&method=API.getIpFromHeader` | — |
| GET | `/index.php?module=API&method=API.getSegmentsMetadata` | — |
| GET | `/index.php?module=API&method=API.getMetadata` | — |
| GET | `/index.php?module=API&method=API.getReportMetadata` | — |
| GET | `/index.php?module=API&method=API.getProcessedReport` | — |
| GET | `/index.php?module=API&method=API.getReportPagesMetadata` | — |
| GET | `/index.php?module=API&method=API.getWidgetMetadata` | — |
| GET | `/index.php?module=API&method=API.get` | — |
| GET | `/index.php?module=API&method=API.getRowEvolution` | — |
| GET | `/index.php?module=API&method=API.getBulkRequest` | — |
| GET | `/index.php?module=API&method=API.isPluginActivated` | — |
| GET | `/index.php?module=API&method=API.getSuggestedValuesForSegment` | — |
| GET | `/index.php?module=API&method=API.getPagesComparisonsDisabledFor` | — |
| GET | `/index.php?module=API&method=API.getGlossaryReports` | — |
| GET | `/index.php?module=API&method=API.getGlossaryMetrics` | — |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-api-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 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/)
- [Matomo Core Admin Home API](https://apis.io/apis/matomo/matomo-coreadminhome-api/)

---

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