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 API

This API is the Metadata API: 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: the dynamically generated list of all API methods via "getReportMetadata" the list of metrics that will be returned by each method, along with their human readable name, via "getDefaultMetrics" and "getDefaultProcessedMetrics" the list of segments metadata supported by all functions that have a 'segment' parameter 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. 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. 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 Metadata API documentation page

Matomo API is one of 61 APIs that Matomo publishes on the 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 exposes 17 operations across 17 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

17 operations 17 paths 2 schemas 17 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Matomo 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 17

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

API 17

This API is the Metadata API : it gives information about all other available APIs methods, as well as providing human readable and more complete outputs than normal API methods.…

GET
/index.php?module=API&method=API.getMatomoVersion
Returns the current Matomo version.
API.getMatomoVersion 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getPhpVersion
Returns information about the PHP runtime version.
API.getPhpVersion 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getIpFromHeader
Returns the most accurate IP address available for the current user, in IPv4 format. This could be the proxy client's IP address.
API.getIpFromHeader 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getSegmentsMetadata
Returns metadata for all available segments.
API.getSegmentsMetadata 4 params → 200400401403404500default
GET
/index.php?module=API&method=API.getMetadata
Returns metadata for a specific API method.
API.getMetadata 10 params → 200400401403404500default
GET
/index.php?module=API&method=API.getReportMetadata
Returns metadata for all available reports.
API.getReportMetadata 7 params → 200400401403404500default
GET
/index.php?module=API&method=API.getProcessedReport
Returns a processed report with metadata, formatting, and processed metrics applied.
API.getProcessedReport 16 params → 200400401403404500default
GET
/index.php?module=API&method=API.getReportPagesMetadata
Returns page metadata for the Matomo UI, including the widgets shown on each page.
API.getReportPagesMetadata 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.getWidgetMetadata
Returns metadata for all widgets that can be displayed in the UI.
API.getWidgetMetadata 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.get
Returns a combined report built from the .get API methods of other plugins.
API.get 6 params → 200400401403404500default
GET
/index.php?module=API&method=API.getRowEvolution
Returns an evolution series for a specific report row or metric label.
API.getRowEvolution 16 params → 200400401403404500default
GET
/index.php?module=API&method=API.getBulkRequest
Performs multiple API requests at once and returns every result.
API.getBulkRequest 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.isPluginActivated
Returns whether a plugin is currently activated.
API.isPluginActivated 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.getSuggestedValuesForSegment
Returns suggested values for a segment based on recent data or a segment-specific callback.
API.getSuggestedValuesForSegment 3 params → 200400401403404500default
GET
/index.php?module=API&method=API.getPagesComparisonsDisabledFor
Returns category/subcategory pairs as "CategoryId.SubcategoryId" for whom comparison features should be disabled.
API.getPagesComparisonsDisabledFor 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getGlossaryReports
Returns glossary entries for all reports.
API.getGlossaryReports 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.getGlossaryMetrics
Returns glossary entries for all metrics.
API.getGlossaryMetrics 2 params → 200400401403404500default

Schemas 2

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

matomo-api-api-openapi.yml Raw ↑

Other APIs Matomo publishes across the network.

Matomo Reporting API (index.php entrypoint)
Matomo Tracking API (matomo.php entrypoint)
Matomo Ab Testing API
Matomo Actions API
Matomo Activity Log API
Matomo Advertising Conversion Export API
Matomo Annotations API
Matomo API Reference API
Matomo Bandwidth API
Matomo Cohorts API
Matomo Contents API
Matomo Core Admin Home API
Where this information came from

This is an independent, third-party profile of Matomo 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.