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 Reporting API (index.php entrypoint)

The single /index.php dispatch entrypoint through which every Matomo Reporting API method is invoked, by supplying module=API and method=Module.Action. This entry documents the entrypoint contract itself — the shared parameters (idSite, period, date, segment, format, token_auth) and the bulk-request form — rather than any one module. The per-module contracts are the 59 OpenAPI documents generated by Matomo's own ApiReference plugin.

Matomo Reporting API (index.php entrypoint) is one of 60 APIs that Matomo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics, Reporting, RPC, and Entry Point. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 19 operations across 18 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://demo-proxy.innocraft.cloud/, https://{matomo_host}.

19 operations 18 paths 2 schemas 18 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Matomo Reporting API (index.php entrypoint) declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (MatomoToken). An API key is passed in the query as token_auth (TokenAuth).

  • MatomoToken — Paste your token generated from Personal Security. Swagger will send it as a Bearer token.
  • TokenAuth — Matomo auth token created in Administration Personal Security Auth tokens. May be passed as a query parameter or, preferably, in the POST body.

Paths & Operations 19

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

Index.php 19
GET
/index.php?module=API&method=API.getMatomoVersion
API get matomo version
API.getMatomoVersion 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getPhpVersion
API get php version
API.getPhpVersion 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getIpFromHeader
API get ip from header
API.getIpFromHeader 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getSegmentsMetadata
API get segments metadata
API.getSegmentsMetadata 4 params → 200400401403404500default
GET
/index.php?module=API&method=API.getMetadata
API get metadata
API.getMetadata 10 params → 200400401403404500default
GET
/index.php?module=API&method=API.getReportMetadata
API get report metadata
API.getReportMetadata 7 params → 200400401403404500default
GET
/index.php?module=API&method=API.getProcessedReport
API get processed report
API.getProcessedReport 16 params → 200400401403404500default
GET
/index.php?module=API&method=API.getReportPagesMetadata
API get report pages metadata
API.getReportPagesMetadata 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.getWidgetMetadata
API get widget metadata
API.getWidgetMetadata 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.get
API get
API.get 6 params → 200400401403404500default
GET
/index.php?module=API&method=API.getRowEvolution
API get row evolution
API.getRowEvolution 16 params → 200400401403404500default
GET
/index.php?module=API&method=API.getBulkRequest
API get bulk request
API.getBulkRequest 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.isPluginActivated
API is plugin activated
API.isPluginActivated 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.getSuggestedValuesForSegment
API get suggested values for segment
API.getSuggestedValuesForSegment 3 params → 200400401403404500default
GET
/index.php?module=API&method=API.getPagesComparisonsDisabledFor
API get pages comparisons disabled for
API.getPagesComparisonsDisabledFor 1 param → 200400401403404500default
GET
/index.php?module=API&method=API.getGlossaryReports
API get glossary reports
API.getGlossaryReports 2 params → 200400401403404500default
GET
/index.php?module=API&method=API.getGlossaryMetrics
API get glossary metrics
API.getGlossaryMetrics 2 params → 200400401403404500default
GET
/index.php
Invoke a Matomo Reporting API method
callReportingApi 8 params → 200
POST
/index.php
Invoke a Matomo Reporting API method (POST, recommended for token in body)
callReportingApiPost 2 params body → 200

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-index-php-api-openapi.yml Raw ↑

Other APIs Matomo publishes across the network.

Matomo Tracking API (matomo.php entrypoint)
Matomo Actions API
Matomo Advertising Conversion Export API
Matomo Annotations API
Matomo Bandwidth API
Matomo Cohorts API
Matomo Contents API
Matomo Core Admin Home API
Matomo Crash Analytics API
Matomo Custom Alerts API
Matomo Custom Dimensions API
Matomo Custom Js Tracker API
Where this information came from

This is an independent, third-party profile of Matomo Reporting API (index.php entrypoint), 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.