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 Actions API

The Matomo Actions API exposes 18 operations of the Matomo Reporting API (module `Actions`). Page, entry page, exit page, page title, download, outlink and site-search reporting — what visitors actually did on the site. Every operation is dispatched through the single `/index.php?module=API&method=Actions.` entrypoint on the customer's own Matomo instance, self-hosted or on Matomo Cloud. The OpenAPI 3.1.0 document is Matomo's own, generated by its first-party ApiReference plugin.

Matomo Actions API is one of 61 APIs that Matomo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics, Pages, Downloads, and Site Search. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 18 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

18 operations 18 paths 4 schemas 18 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Matomo Actions 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 18

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

Actions 18

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 exampl…

GET
/index.php?module=API&method=Actions.get
Returns aggregated action metrics for the requested site and period.
Actions.get 6 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getPageUrls
Returns page URL metrics for the requested site and period.
Actions.getPageUrls 9 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getPageUrlsFollowingSiteSearch
Returns page URL metrics for pages viewed immediately after an internal site search.
Actions.getPageUrlsFollowingSiteSearch 7 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getPageTitlesFollowingSiteSearch
Returns page title metrics for pages viewed immediately after an internal site search.
Actions.getPageTitlesFollowingSiteSearch 7 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getEntryPageUrls
Returns a DataTable with analytics information for every unique entry page URL, for the specified site, period & segment.
Actions.getEntryPageUrls 8 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getExitPageUrls
Returns a DataTable with analytics information for every unique exit page URL, for the specified site, period & segment.
Actions.getExitPageUrls 8 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getPageUrl
Returns metrics for a specific page URL.
Actions.getPageUrl 6 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getPageTitles
Returns page title metrics for the requested site and period.
Actions.getPageTitles 8 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getEntryPageTitles
Returns a DataTable with analytics information for every unique entry page title for the given site, time period & segment.
Actions.getEntryPageTitles 8 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getExitPageTitles
Returns a DataTable with analytics information for every unique exit page title for the given site, time period & segment.
Actions.getExitPageTitles 8 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getPageTitle
Returns metrics for a specific page title.
Actions.getPageTitle 6 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getDownloads
Returns download metrics for the requested site and period.
Actions.getDownloads 8 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getDownload
Returns metrics for a specific download URL.
Actions.getDownload 6 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getOutlinks
Returns outlink metrics for the requested site and period.
Actions.getOutlinks 8 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getOutlink
Returns metrics for a specific outlink URL.
Actions.getOutlink 6 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getSiteSearchKeywords
Returns internal search keywords that produced search results.
Actions.getSiteSearchKeywords 5 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getSiteSearchNoResultKeywords
Returns internal search keywords that produced no results.
Actions.getSiteSearchNoResultKeywords 5 params → 200400401403404500default
GET
/index.php?module=API&method=Actions.getSiteSearchCategories
Returns internal search categories used by visitors on the site.
Actions.getSiteSearchCategories 5 params → 200400401403404500default

Schemas 4

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

matomo-actions-openapi.json Raw ↑

Other APIs Matomo publishes across the network.

Matomo Live API
Matomo Goals API
Matomo Segments API
Matomo Reporting API (index.php entrypoint)
Matomo Tracking API (matomo.php entrypoint)
Matomo SitesManager API
Matomo TagManager API
Matomo UsersManager API
Matomo CrashAnalytics API
Matomo HeatmapSessionRecording API
Matomo FormAnalytics API
Matomo Referrers API
Where this information came from

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