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

The Live! API lets you access complete visit level information about your visitors. Combined with the power of Segmentation, you will be able to request visits filtered by any criteria. The method "getLastVisitsDetails" will return extensive RAW data 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 '&segment=' 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 Real time widget and visitor level reports in Matomo. You may also be interested in steps to export your RAW data to a data warehouse.

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

Tagged areas include Live. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

6 operations 6 paths 2 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Matomo Live 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 6

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

Live 6

The Live! API lets you access complete visit level information about your visitors. Combined with the power of Segmentation , you will be able to request visits filtered by any cr…

GET
/index.php?module=API&method=Live.getCounters
Returns simple live counters for visits over the last N minutes.
Live.getCounters 6 params → 200400401403404500default
GET
/index.php?module=API&method=Live.isVisitorProfileEnabled
Returns whether the visitor profile is enabled for the given site selection.
Live.isVisitorProfileEnabled 2 params → 200400401403404500default
GET
/index.php?module=API&method=Live.getLastVisitsDetails
Returns the most recent visit details for one or more websites.
Live.getLastVisitsDetails 10 params → 200400401403404500default
GET
/index.php?module=API&method=Live.getVisitorProfile
Returns a visitor profile built from the visitor's recent visits.
Live.getVisitorProfile 5 params → 200400401403404500default
GET
/index.php?module=API&method=Live.getMostRecentVisitorId
Returns the visitor ID of the most recent visit.
Live.getMostRecentVisitorId 3 params → 200400401403404500default
GET
/index.php?module=API&method=Live.getMostRecentVisitsDateTime
Returns the most recent UTC datetime when an action was performed for the given website or websites.
Live.getMostRecentVisitsDateTime 4 params → 200400401403404500default

Schemas 2

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

matomo-live-api-openapi.yml Raw ↑

Other APIs Matomo publishes across the network.

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

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