Matomo
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 61 APIs on the APIs.io network, including Reporting API (index.php entrypoint), Tracking API (matomo.php entrypoint), Ab Testing API, and 58 more. Tagged areas include Analytics, Web Analytics, Open-Source, Privacy, and Data Ownership.
Matomo’s developer surface includes authentication, changelog, CLI, sandbox, documentation, API reference, getting-started guide, and 103 more developer resources.
61 APIs
1 MCP Servers
Individual APIs this provider publishes, each with its own machine-readable definition.
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...
Exposes the AbTesting API for managing experiments, embedding experiment scripts, and reading experiment reports.
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 Activity Log API endpoints for listing activity entries, counting matches, and resolving the permitted date range for the current caller.
Exposes API endpoints for managing advertising conversion export configurations. These methods let users list, inspect, create, update, and delete configured exports and access ...
Provides API methods to create, update, delete, and query annotations.
This API is the Metadata API: it gives information about all other available APIs ...
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 reporting API endpoints for aggregated bandwidth metrics.
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...
The Contents API exposes content tracking reports grouped by content name and content piece.
Provides administrative API methods for scheduling, archiving, tracking failures, and opt-out code generation.
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 Custom Dimensions API lets you manage and access reports for your configured Custom Dimensions.
Provides API methods for custom JavaScript tracker configuration.
Exposes Custom Reports configuration and reporting endpoints. Use it to create, duplicate, manage, and query custom report definitions and their archived data.
The Dashboard API lets you manage user dashboards and retrieve their widget configurations.
The DevicePlugins API lets you access reports about device plugins such as browser plugins.
The DevicesDetection API lets you access reports about your visitors' device types, brands, models, operating systems, and browsers.
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](...
Provides API methods for submitting product feedback and managing feedback reminders.
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 ...
Provides API methods for insight and mover/shaker comparisons between report periods.
The LanguagesManager API lets you access existing Matomo translations, and change Users languages preferences. "getTranslationsForLanguage" will return all translation strings f...
The Live! API lets you access complete visit level information about your visitors. Combined with the power of
Provides API methods for login-related administration tasks.
Exposes reporting API endpoints for marketing campaign dimensions and drill-down reports. Includes campaign IDs, names, keywords, source and medium dimensions, and hierarchical ...
The MobileMessaging API lets you manage SMS credentials, phone number verification, and SMS account settings.
The MultiSites API lets you request the key metrics (visits, page views, revenue) for all Websites in Matomo.
Exposes super-user OAuth2 client management endpoints for Matomo. This API lists configured scopes and lets administrators create, inspect, update, rotate, activate, and delete ...
The Overlay API exposes translation data and overlay-specific page transition reports.
Provides reporting API methods for aggregated page performance metrics.
The PrivacyManager API lets you manage GDPR workflows, anonymization settings, and privacy compliance controls.
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 methods for screen resolution and device configuration reports.
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...
The ScheduledReports API lets you manage Scheduled Email reports, as well as generate, download or email any existing report. "generateReport" will generate the requested report...
Provides SearchEngineKeywordsPerformance API endpoints for imported keyword and crawl-performance reports. Exposes combined and provider-specific reports for Google, Bing, and Y...
The SegmentEditor API lets you add, update, delete custom Segments, and list saved segments.
The SEO API lets you access a list of SEO metrics for the specified URL: Bing indexed pages and age of the Domain name.
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...
Exposes the Tag Manager API for managing containers, versions, tags, triggers, and variables. The endpoints also provide installation metadata, publishing workflows, preview con...
Provides API methods for Tour challenges and engagement levels.
Provides API methods for transition reports around a specific page action.
Provides API methods for managing two-factor authentication.
The UserCountry API lets you access reports about your visitors' Countries and Continents.
Provides API methods for User ID reports.
The UserLanguage API lets you access reports about your Visitors language setting
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...
VisitFrequency API lets you access a list of metrics related to Returning Visitors.
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 ...
VisitTime API lets you access reports by Hour (Server time), and by Hour Local Time of your visitors.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Model Context Protocol servers that expose these APIs to AI agents.
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
Recommended x-agentic-access execution contracts for AI agents.
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: saas
open_source: false
commercial: true
callable_host: false
label: Hosted service · you call their endpoint
confidence: medium
source:
- openapi
- pricing
generated: '2026-08-28'
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
- Data Ownership
- 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
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-abtesting-api
name: Matomo Ab Testing API
description: Exposes the AbTesting API for managing experiments, embedding experiment scripts, and reading experiment reports.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- A/B Testing
tags_raw:
- AbTesting
properties:
- type: OpenAPI
url: openapi/matomo-abtesting-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-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-activitylog-api
name: Matomo Activity Log API
description: Exposes Activity Log API endpoints for listing activity entries, counting matches, and resolving the permitted
date range for the current caller.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Activity Log
tags_raw:
- ActivityLog
properties:
- type: OpenAPI
url: openapi/matomo-activitylog-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:
- 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-api-api
name: Matomo API
description: '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>'
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags: []
tags_raw:
- API
properties:
- type: OpenAPI
url: openapi/matomo-api-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-apireference-api
name: Matomo API Reference API
description: Provides Reporting API endpoints for reading OpenAPI plugin configuration and specifications. Exposes endpoints
to return the effective plugin list for spec generation, read pre-generated spec files, or generate plugin OpenAPI specifications
on demand.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- API Reference
tags_raw:
- ApiReference
properties:
- type: OpenAPI
url: openapi/matomo-apireference-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-customreports-api
name: Matomo Custom Reports API
description: Exposes Custom Reports configuration and reporting endpoints. Use it to create, duplicate, manage, and query
custom report definitions and their archived data.
humanURL: https://developer.matomo.org/api-reference/reporting-api
baseURL: https://{matomo_host}/index.php
tags:
- Custom Reports
tags_raw:
- CustomReports
properties:
- type: OpenAPI
url: openapi/matomo-customreports-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:
- 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-refer
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/apis.yml
Every provider here is available over the APIs.io API and to AI agents over MCP.
Kin Score
How this is scored →