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

The Matomo VisitsSummary API exposes 10 operations of the Matomo Reporting API (module `VisitsSummary`). The core traffic overview — visits, unique visitors, users, actions, bounces and time on site for any period. Every operation is dispatched through the single `/index.php?module=API&method=VisitsSummary.` 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 VisitsSummary 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, Traffic, Visits, and Metrics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 10 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/.

10 operations 10 paths 4 schemas 10 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 VisitsSummary 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 10

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

VisitsSummary 10

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

GET
/index.php?module=API&method=VisitsSummary.get
Returns the VisitsSummary overview report for the requested period.
VisitsSummary.get 6 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getVisits
Returns the number of visits in the requested period.
VisitsSummary.getVisits 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getUniqueVisitors
Returns the number of unique visitors in the requested period.
VisitsSummary.getUniqueVisitors 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getUsers
Returns the number of users in the requested period.
VisitsSummary.getUsers 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getActions
Returns the number of actions in the requested period.
VisitsSummary.getActions 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getMaxActions
Returns the maximum number of actions in a single visit for the requested period.
VisitsSummary.getMaxActions 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getBounceCount
Returns the number of bounces in the requested period.
VisitsSummary.getBounceCount 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getVisitsConverted
Returns the number of converted visits in the requested period.
VisitsSummary.getVisitsConverted 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getSumVisitsLength
Returns the total visit duration in seconds for the requested period.
VisitsSummary.getSumVisitsLength 5 params → 200400401403404500default
GET
/index.php?module=API&method=VisitsSummary.getSumVisitsLengthPretty
Returns the total visit duration formatted as human-readable text.
VisitsSummary.getSumVisitsLengthPretty 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-visits-summary-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 VisitsSummary 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.