Matomo is an open source web analytics platform — self-hosted (Matomo On-Premise) or vendor-hosted (Matomo Cloud) — that gives an organisation complete ownership of its analytics data. Formerly Piwik, it is the leading privacy-first alternative to Google Analytics, with GDPR tooling, data residency in Frankfurt for Cloud, and no data sampling. Its API surface is substantial and unusual: 556 documented operations across 59 plugin modules, every one dispatched through a single /index.php RPC entrypoint on the customer's own deployment rather than a vendor host, plus a separate tracking entrypoint at /matomo.php. Matomo generates its own OpenAPI 3.1.0 documents through a first-party ApiReference plugin, and ships a first-party Model Context Protocol server exposing 19 agent tools over an authenticated HTTP endpoint.
Matomo publishes 60 API contracts indexed on the APIs.io network, including Reporting API (index.php entrypoint), Tracking API (matomo.php entrypoint), Actions API, and 57 more. Tagged areas include Analytics, Web Analytics, Open Source, Privacy, and DataOwnership.
The Matomo catalog on APIs.io includes 1 Spectral governance ruleset.
Matomo’s developer surface includes authentication, changelog, CLI, sandbox, documentation, API reference, getting-started guide, and 107 more developer resources.
70.7/100exemplar▬ flatAgent37/100agent readyFront door AI5/6
prominent
Heartbeat100/100
alive
open core · GPL-3.0
Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →
The questions people put to an LLM, and the jobs they hand an agent, that Matomo's APIs answer — each one linked to the operation that does it.
Generated by API Evangelist
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/matomo/"><img src="https://apis.io/badge/matomo/card.svg" alt="Matomo on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
Idempotency+9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented) Ask about this →
Typed Event Surface+6 pts — AsyncAPI document, OR webhooks/callbacks objects in the as-published OpenAPI, OR common[].type includes Webhooks Ask about this →
Pagination+5 pts — share of collection GETs (an array, or one wrapped in data/items/results ...) that declare a page/limit/offset/cursor parameter, a Link header or a next/cursor field; na with no collection GETs Ask about this →
5 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.
Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →
The Kin Score Market layer reads a provider inside its market:
its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted:
not part of the Kin Score or agent readiness.
Registered MCP server and declares compatibility are report only — not weighted.
Undeclared means we found nothing we can read, so there is no number: we never infer integrations.
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
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 ...
The Matomo Tracking API — the server-side ingest entrypoint at /matomo.php that records pageviews, events, goals, ecommerce orders, site searches and content interactions. It is...
The Actions API lets you request reports for all your Visitor Actions: Page URLs, Page titles, Events, Content Tracking, File Downloads and Clicks on external websites. For exam...
Exposes API endpoints for managing advertising conversion export configurations. These methods let users list, inspect, create, update, and delete configured exports and access ...
Exposes cohort reports grouped by the period of a visitor's first visit. These endpoints transform archived first-visit cohort data into table and chart responses for the Cohort...
Exposes Crash Analytics endpoints for managing tracked crashes and querying crash reports. Includes summary, drill-down, historical, and realtime reporting APIs for a single site.
Exposes Custom Alerts API endpoints for managing alert definitions and reading triggered alert data. These methods let callers create, update, fetch, delete, and evaluate alerts...
The Events API lets you request reports about your users' Custom Events. Events are tracked using the Javascript Tracker trackEvent() function, or using the [Tracking HTTP API](...
Exposes the Form Analytics API for managing tracked forms and retrieving form performance reports. Use these endpoints to create, update, archive, and delete configured forms, i...
Exposes the Funnels reporting and management API for funnel analytics configuration. Includes endpoints for funnel reports, funnel definitions, and pattern validation helpers.
Goals API lets you Manage existing goals, via "updateGoal" and "deleteGoal", create new Goals via "addGoal", or list existing Goals for one or several websites via "getGoals" If...
Exposes the Heatmap & Session Recording API endpoints for managing configurations and retrieving recorded activity. Heatmap coordinates use relative values: X and Y positions ra...
The ImageGraph.get API call lets you generate beautiful static PNG Graphs for any existing Matomo report. Supported graph types are: line plot, 2D/3D pie chart and vertical bar ...
The LanguagesManager API lets you access existing Matomo translations, and change Users languages preferences. "getTranslationsForLanguage" will return all translation strings f...
Exposes reporting API endpoints for marketing campaign dimensions and drill-down reports. Includes campaign IDs, names, keywords, source and medium dimensions, and hierarchical ...
Exposes Media Analytics reports for video and audio plays, engagement, resources, and player usage. Includes real-time endpoints for recent activity and archive-backed endpoints...
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, "getK...
Provides API endpoints for managing roll-up websites and their source site assignments. Use these methods to create roll-ups, update their configuration, and list the configured...
Provides SearchEngineKeywordsPerformance API endpoints for imported keyword and crawl-performance reports. Exposes combined and provider-specific reports for Google, Bing, and Y...
The SitesManager API gives you full control on Websites in Matomo (create, update and delete), and many methods to retrieve websites based on various attributes. This API lets y...
The UsersManager API lets you Manage Users and their permissions to access specific websites. You can create users via "addUser", update existing users via "updateUser" and dele...
VisitorInterest API lets you access visitor engagement distribution reports, including visits by pages viewed, visit duration, days since last visit, and visit count.
VisitsSummary API lets you access the core web analytics metrics (visits, unique visitors, count of actions (page views & downloads & clicks on outlinks), time on site, bounces ...
Exposes super-user OAuth2 client management endpoints for Matomo. This API lists configured scopes and lets administrators create, inspect, update, rotate, activate, and delete ...
Provides Reporting API endpoints for reading OpenAPI plugin configuration and specifications. Exposes endpoints to return the effective plugin list for spec generation, read pre...
Exposes Custom Reports configuration and reporting endpoints. Use it to create, duplicate, manage, and query custom report definitions and their archived data.
Exposes the Tag Manager API for managing containers, versions, tags, triggers, and variables. The endpoints also provide installation metadata, publishing workflows, preview con...
Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.
aid: matomo
name: Matomo
description: 'Matomo is an open source web analytics platform — self-hosted (Matomo On-Premise) or vendor-hosted (Matomo Cloud)
— that gives an organisation complete ownership of its analytics data. Formerly Piwik, it is the leading privacy-first alternative
to Google Analytics, with GDPR tooling, data residency in Frankfurt for Cloud, and no data sampling. Its API surface is
substantial and unusual: 556 documented operations across 59 plugin modules, every one dispatched through a single /index.php
RPC entrypoint on the customer''s own deployment rather than a vendor host, plus a separate tracking entrypoint at /matomo.php.
Matomo generates its own OpenAPI 3.1.0 documents through a first-party ApiReference plugin, and ships a first-party Model
Context Protocol server exposing 19 agent tools over an authenticated HTTP endpoint.'
type: Index
deliveryModel:
model: open-core
license: GPL-3.0
license_evidence:
repo: matomo-org/matomo
spdx: GPL-3.0
stars: 21896
open_source: true
commercial: true
callable_host: true
label: Open core · an OSS project plus a commercial hosted product
confidence: medium
source:
- openapi
- pricing
- repository-license
generated: '2026-09-25'
method: derived
accessModel:
pricing: freemium
onboarding: self-serve
trial: true
try_now: true
public: true
label: Open source · Free On-Premise · Paid Cloud · Public demo instance
confidence: high
source:
- plans
- authentication
- sandbox
generated: '2026-08-13'
method: searched
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/matomo.png
tags:
- Analytics
- Web Analytics
- Open Source
- Privacy
- DataOwnership
- Self-Hosted
- GDPR
- Tag Management
- Conversion Optimization
- MCP
tags_raw:
- Analytics
- Web Analytics
- Open Source
- Privacy
- Data Ownership
- Self-Hosted
- GDPR
- Tag Management
- Conversion Optimization
- Model Context Protocol
- Open-Source
url: https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/apis.yml
created: '2026-03-26'
modified: '2026-08-13'
specificationVersion: '0.23'
apis:
- aid: matomo:matomo-index-php-api
name: Matomo Reporting API (index.php entrypoint)
description: 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.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Analytics
- Reporting
- RPC
- Entry Point
tags_raw:
- Analytics
- Reporting
- RPC
- Entrypoint
properties:
- type: OpenAPI
url: openapi/matomo-index-php-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: GettingStarted
url: https://developer.matomo.org/api-reference/reporting-api-introduction
- type: APIReference
url: https://developer.matomo.org/api-reference/api
- aid: matomo:matomo-matomo-php-api
name: Matomo Tracking API (matomo.php entrypoint)
description: 'The Matomo Tracking API — the server-side ingest entrypoint at /matomo.php that records pageviews, events,
goals, ecommerce orders, site searches and content interactions. It is the counterpart to the JavaScript tracking client
and the target of every first-party tracking SDK. On Matomo Cloud the tracking endpoints are explicitly exempt from the
API rate limits that apply to reporting. There is no MCP tool for tracking: agents can read Matomo analytics but cannot
write tracking events.'
humanURL: https://developer.matomo.org/api-reference/tracking-api
baseURL: https://{matomo_host}/matomo.php
tags:
- Analytics
- Tracking
- Event
- Ingest
- Server-Side
tags_raw:
- Analytics
- Tracking
- Events
- Ingest
- Server-Side
properties:
- type: OpenAPI
url: openapi/matomo-matomo-php-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/tracking-api
- type: SDKs
url: https://developer.matomo.org/api-reference/tracking-api-clients
- type: GettingStarted
url: https://developer.matomo.org/guides/tracking-javascript-guide
- aid: matomo:matomo-actions-api
name: Matomo Actions API
description: 'The Actions API lets you request reports for all your Visitor Actions: Page URLs, Page titles, Events, Content
Tracking, File Downloads and Clicks on external websites. For example, "getPageTitles" will return all your page titles
along with standard <a href=''https://matomo.org/docs/analytics-api/reference/#toc-metric-definitions'' rel=''noreferrer''
target=''_blank''>Actions metrics</a> for each row. It is also possible to request data for a specific Page Title with
"getPageTitle" and setting the parameter pageName to the page title you wish to request. Similarly, you can request metrics
for a given Page URL via "getPageUrl", a Download file via "getDownload" and an outlink via "getOutlink". Note: pageName,
pageUrl, outlinkUrl, downloadUrl parameters must be URL encoded before you call the API.'
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Actions
properties:
- type: OpenAPI
url: openapi/matomo-actions-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-advertisingconversionexport-api
name: Matomo Advertising Conversion Export API
description: Exposes API endpoints for managing advertising conversion export configurations. These methods let users list,
inspect, create, update, and delete configured exports and access tokens.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- AdvertisingConversionExport
properties:
- type: OpenAPI
url: openapi/matomo-advertisingconversionexport-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-annotations-api
name: Matomo Annotations API
description: Provides API methods to create, update, delete, and query annotations.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Annotation
tags_raw:
- Annotations
properties:
- type: OpenAPI
url: openapi/matomo-annotations-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-bandwidth-api
name: Matomo Bandwidth API
description: Exposes reporting API endpoints for aggregated bandwidth metrics.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Bandwidth
properties:
- type: OpenAPI
url: openapi/matomo-bandwidth-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-cohorts-api
name: Matomo Cohorts API
description: Exposes cohort reports grouped by the period of a visitor's first visit. These endpoints transform archived
first-visit cohort data into table and chart responses for the Cohorts plugin.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Cohorts
properties:
- type: OpenAPI
url: openapi/matomo-cohorts-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-contents-api
name: Matomo Contents API
description: The Contents API exposes content tracking reports grouped by content name and content piece.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Contents
properties:
- type: OpenAPI
url: openapi/matomo-contents-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-coreadminhome-api
name: Matomo Core Admin Home API
description: Provides administrative API methods for scheduling, archiving, tracking failures, and opt-out code generation.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- CoreAdminHome
properties:
- type: OpenAPI
url: openapi/matomo-coreadminhome-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-crashanalytics-api
name: Matomo Crash Analytics API
description: Exposes Crash Analytics endpoints for managing tracked crashes and querying crash reports. Includes summary,
drill-down, historical, and realtime reporting APIs for a single site.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- CrashAnalytics
properties:
- type: OpenAPI
url: openapi/matomo-crashanalytics-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-customalerts-api
name: Matomo Custom Alerts API
description: Exposes Custom Alerts API endpoints for managing alert definitions and reading triggered alert data. These
methods let callers create, update, fetch, delete, and evaluate alerts for one or more sites.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- CustomAlerts
properties:
- type: OpenAPI
url: openapi/matomo-customalerts-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-customdimensions-api
name: Matomo Custom Dimensions API
description: The Custom Dimensions API lets you manage and access reports for your configured Custom Dimensions.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- CustomDimensions
properties:
- type: OpenAPI
url: openapi/matomo-customdimensions-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-customjstracker-api
name: Matomo Custom Js Tracker API
description: Provides API methods for custom JavaScript tracker configuration.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- CustomJsTracker
properties:
- type: OpenAPI
url: openapi/matomo-customjstracker-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-dashboard-api
name: Matomo Dashboard API
description: The Dashboard API lets you manage user dashboards and retrieve their widget configurations.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Dashboards
tags_raw:
- Dashboard
properties:
- type: OpenAPI
url: openapi/matomo-dashboard-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-deviceplugins-api
name: Matomo Device Plugins API
description: The DevicePlugins API lets you access reports about device plugins such as browser plugins.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- DevicePlugins
properties:
- type: OpenAPI
url: openapi/matomo-deviceplugins-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-devicesdetection-api
name: Matomo Devices Detection API
description: The DevicesDetection API lets you access reports about your visitors' device types, brands, models, operating
systems, and browsers.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- DevicesDetection
properties:
- type: OpenAPI
url: openapi/matomo-devicesdetection-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-events-api
name: Matomo Events API
description: 'The Events API lets you request reports about your users'' Custom Events. Events are tracked using the Javascript
Tracker trackEvent() function, or using the [Tracking HTTP API](https://developer.matomo.org/api-reference/tracking-api). <br/>An
event is defined by an event category (Videos, Music, Games...), an event action (Play, Pause, Duration, Add Playlist,
Downloaded, Clicked...), and an optional event name (a movie name, a song title, etc.) and an optional numeric value. <br/>This
API exposes the following Custom Events reports: <code>getCategory</code> lists the top Event Categories, <code>getAction</code>
lists the top Event Actions, <code>getName</code> lists the top Event Names. <br/>These Events report define the following
metrics: nb_uniq_visitors, nb_visits, nb_events. If you define values for your events, you can expect to see the following
metrics: nb_events_with_value, sum_event_value, min_event_value, max_event_value, avg_event_value <br/>The Events.get*
reports can be used with an optional <code>&secondaryDimension</code> parameter. Secondary dimension is the dimension
used in the sub-table of the Event report you are requesting. <br/>Here are the possible values of <code>secondaryDimension</code>:
<ul> <li>For <code>Events.getCategory</code> you can set <code>secondaryDimension</code> to <code>eventAction</code> or
<code>eventName</code>.</li> <li>For <code>Events.getAction</code> you can set <code>secondaryDimension</code> to <code>eventName</code>
or <code>eventCategory</code>.</li> <li>For <code>Events.getName</code> you can set <code>secondaryDimension</code> to
<code>eventAction</code> or <code>eventCategory</code>.</li> </ul> <br/>For example, to request all Custom Events Categories,
and for each, the top Event actions, you would request: <code>method=Events.getCategory&secondaryDimension=eventAction&flat=1</code>.
You may also omit <code>&flat=1</code> in which case, to get top Event actions for one Event category, use <code>method=Events.getActionFromCategoryId</code>
passing it the <code>&idSubtable=</code> of this Event category.'
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Event
tags_raw:
- Events
properties:
- type: OpenAPI
url: openapi/matomo-events-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-feedback-api
name: Matomo Feedback API
description: Provides API methods for submitting product feedback and managing feedback reminders.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Feedback
properties:
- type: OpenAPI
url: openapi/matomo-feedback-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-formanalytics-api
name: Matomo Form Analytics API
description: Exposes the Form Analytics API for managing tracked forms and retrieving form performance reports. Use these
endpoints to create, update, archive, and delete configured forms, inspect form metadata, and query aggregated reports
about form usage, field interactions, conversions, and real-time activity.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- FormAnalytics
properties:
- type: OpenAPI
url: openapi/matomo-formanalytics-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-funnels-api
name: Matomo Funnels API
description: Exposes the Funnels reporting and management API for funnel analytics configuration. Includes endpoints for
funnel reports, funnel definitions, and pattern validation helpers.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Funnels
properties:
- type: OpenAPI
url: openapi/matomo-funnels-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-goals-api
name: Matomo Goals API
description: 'Goals API lets you Manage existing goals, via "updateGoal" and "deleteGoal", create new Goals via "addGoal",
or list existing Goals for one or several websites via "getGoals" If you are <a href=''https://matomo.org/docs/ecommerce-analytics/''
target=''_blank''>tracking Ecommerce orders and products</a> on your site, the functions "getItemsSku", "getItemsName"
and "getItemsCategory" will return the list of products purchased on your site, either grouped by Product SKU, Product
Name or Product Category. For each name, SKU or category, the following metrics are returned: Total revenue, Total quantity,
average price, average quantity, number of orders (or abandoned carts) containing this product, number of visits on the
Product page, Conversion rate. By default, these functions return the ''Products purchased''. These functions also accept
an optional parameter &abandonedCarts=1. If the parameter is set, it will instead return the metrics for products that
were left in an abandoned cart therefore not purchased. The API also lets you request overall Goal metrics via the method
"get": Conversions, Visits with at least one conversion, Conversion rate and Revenue. If you wish to request specific
metrics about Ecommerce goals, you can set the parameter &idGoal=ecommerceAbandonedCart to get metrics about abandoned
carts (including Lost revenue, and number of items left in the cart) or &idGoal=ecommerceOrder to get metrics about Ecommerce
orders (number of orders, visits with an order, subtotal, tax, shipping, discount, revenue, items ordered) See also the
documentation about <a href=''https://matomo.org/docs/tracking-goals-web-analytics/'' rel=''noreferrer'' target=''_blank''>Tracking
Goals</a> in Matomo.'
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Goals
properties:
- type: OpenAPI
url: openapi/matomo-goals-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-heatmapsessionrecording-api
name: Matomo Heatmap Session Recording API
description: 'Exposes the Heatmap & Session Recording API endpoints for managing configurations and retrieving recorded
activity. Heatmap coordinates use relative values: X and Y positions range from 0 to 2000, where 1000 represents 50%
of the matched element. Scroll reach and above-the-fold positions range from 0 to 1000, where 100 represents 10% of the
page height. <code>idSiteHsr</code> identifies a heatmap or session recording configuration, while <code>idLogHsr</code>
identifies an individual recorded activity entry.'
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- HeatmapSessionRecording
properties:
- type: OpenAPI
url: openapi/matomo-heatmapsessionrecording-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-imagegraph-api
name: Matomo Image Graph API
description: 'The ImageGraph.get API call lets you generate beautiful static PNG Graphs for any existing Matomo report.
Supported graph types are: line plot, 2D/3D pie chart and vertical bar chart. A few notes about some of the parameters
available:<br/> - $graphType defines the type of graph plotted, accepted values are: ''evolution'', ''verticalBar'', ''pie''
and ''3dPie''<br/> - $colors accepts a comma delimited list of colors that will overwrite the default Matomo colors <br/>
- you can also customize the width, height, font size, metric being plotted (in case the data contains multiple columns/metrics). See
also <a href=''https://developer.matomo.org/api-reference/reporting-api-metadata#static-image-graphs''>How to embed static
Image Graphs?</a> for more information.'
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- ImageGraph
properties:
- type: OpenAPI
url: openapi/matomo-imagegraph-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-insights-api
name: Matomo Insights API
description: Provides API methods for insight and mover/shaker comparisons between report periods.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Insights
properties:
- type: OpenAPI
url: openapi/matomo-insights-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-languagesmanager-api
name: Matomo Languages Manager API
description: The LanguagesManager API lets you access existing Matomo translations, and change Users languages preferences. "getTranslationsForLanguage"
will return all translation strings for a given language, so you can leverage Matomo translations in your application
(and automatically benefit from the <a href='https://matomo.org/translations/' rel='noreferrer' target='_blank'>40+ translations</a>!).
This is mostly useful to developers who integrate Matomo API results in their own application. You can also request the
default language to load for a user via "getLanguageForUser", or update it via "setLanguageForUser".
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- LanguagesManager
properties:
- type: OpenAPI
url: openapi/matomo-languagesmanager-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-live-api
name: Matomo Live API
description: 'The Live! API lets you access complete visit level information about your visitors. Combined with the power
of <a href=''https://matomo.org/docs/analytics-api/segmentation/'' target=''_blank''>Segmentation</a>, you will be able
to request visits filtered by any criteria. The method "getLastVisitsDetails" will return extensive <a href=''https://matomo.org/guide/apis/raw-data/''>RAW
data</a> for each visit, which includes: server time, visitId, visitorId, visitorType (new or returning), number of pages,
list of all pages (and events, file downloaded and outlinks clicked), custom variables names and values set to this visit,
number of goal conversions (and list of all Goal conversions for this visit, with time of conversion, revenue, URL, etc.),
but also other attributes such as: days since last visit, days since first visit, country, continent, visitor IP, provider,
referrer used (referrer name, keyword if it was a search engine, full URL), campaign name and keyword, operating system,
browser, type of screen, resolution, supported browser plugins (flash, java, silverlight, pdf, etc.), various dates &
times format to make it easier for API users... and more! With the parameter <a href=''https://matomo.org/docs/analytics-api/segmentation/''
rel=''noreferrer'' target=''_blank''>''&segment=''</a> you can filter the returned visits by any criteria (visitor IP,
visitor ID, country, keyword used, time of day, etc.). The method "getCounters" is used to return a simple counter: visits,
number of actions, number of converted visits, in the last N minutes. See also the documentation about <a href=''https://matomo.org/docs/real-time/''
rel=''noreferrer'' target=''_blank''>Real time widget and visitor level reports</a> in Matomo. You may also be interested
in steps to <a href=''https://matomo.org/faq/how-to/faq_24536/''>export your RAW data to a data warehouse</a>.'
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Live
properties:
- type: OpenAPI
url: openapi/matomo-live-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api-segmentation
- aid: matomo:matomo-login-api
name: Matomo Login API
description: Provides API methods for login-related administration tasks.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Login
properties:
- type: OpenAPI
url: openapi/matomo-login-api-openapi.yml
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Live
- type: Documentation
url: https://developer.matomo.org/api-reference/reporting-api#Goals
# --- truncated at 32 KB (68 KB total) ---
# Full source: https://artifacts.apis.io/matomo/apis.yml
Matomo API — frequently asked questions
Does Matomo have an API?
Yes. APIs.io lists 60 APIs from Matomo, including Matomo Reporting API (index.php entrypoint), Matomo Tracking API (matomo.php entrypoint) and Matomo Actions API, and 57 more.
Is there an OpenAPI specification for the Matomo API?
Yes. APIs.io indexes 60 OpenAPI specifications for Matomo, each linked for download from this page.
How do I authenticate with the Matomo API?
Matomo documents its authentication (apiKey/http/oauth2 · 4 schemes). The details are profiled on APIs.io as Matomo Authentication.
How much does the Matomo API cost?
Matomo publishes its prices; its Cloud Business plan is 29 per month (excl. tax) as of 2026-10-28. APIs.io lists 10 pricing plans for Matomo, with each plan's price, limits and inclusions under Pricing on this page.
Does Matomo have an MCP server?
Yes. APIs.io lists 1 MCP server for Matomo: Remote MCP server at {matomo_host} over HTTP requiring OAuth; 19 tools listed.
Is the Matomo API ready for AI agents?
Matomo has a Kin Score of 70.7 out of 100 (exemplar) and an Agent Readiness score of 37.4 (agent-ready), scored by API Evangelist on 2026-11-13.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
Kin Score
How this is scored →
It updates itself when the score changes. Paste this where you link to your API docs: