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

The Matomo MediaAnalytics API exposes 14 operations of the Matomo Reporting API (module `MediaAnalytics`). Video and audio engagement analytics: plays, finishes, play time and audience watch curves. Every operation is dispatched through the single `/index.php?module=API&method=MediaAnalytics.` 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 MediaAnalytics 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, Video, Audio, and Media. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

14 operations 14 paths 4 schemas 14 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 MediaAnalytics 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 14

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

MediaAnalytics 14

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

GET
/index.php?module=API&method=MediaAnalytics.get
Return the aggregated media analytics overview for the given site, period, and date.
MediaAnalytics.get 6 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getCurrentNumPlays
Return the number of media plays within the last N minutes.
MediaAnalytics.getCurrentNumPlays 4 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getCurrentSumTimeSpent
Return the total watched time in seconds within the last N minutes.
MediaAnalytics.getCurrentSumTimeSpent 4 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getCurrentMostPlays
Return the most played media items within the last N minutes.
MediaAnalytics.getCurrentMostPlays 5 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getVideoResources
Return media resource URLs for video items.
MediaAnalytics.getVideoResources 10 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getAudioResources
Return media resource URLs for audio items.
MediaAnalytics.getAudioResources 10 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getVideoTitles
Return video titles with their aggregated metrics.
MediaAnalytics.getVideoTitles 7 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getAudioTitles
Return audio titles with their aggregated metrics.
MediaAnalytics.getAudioTitles 7 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getGroupedVideoResources
Return grouped video resource URLs with their aggregated metrics.
MediaAnalytics.getGroupedVideoResources 7 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getGroupedAudioResources
Return grouped audio resource URLs with their aggregated metrics.
MediaAnalytics.getGroupedAudioResources 7 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getVideoHours
Return video plays grouped by hour for the requested period.
MediaAnalytics.getVideoHours 5 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getAudioHours
Return audio plays grouped by hour for the requested period.
MediaAnalytics.getAudioHours 5 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getVideoResolutions
Return video plays grouped by player resolution.
MediaAnalytics.getVideoResolutions 5 params → 200400401403404500default
GET
/index.php?module=API&method=MediaAnalytics.getPlayers
Return media plays grouped by player name.
MediaAnalytics.getPlayers 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-media-analytics-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 MediaAnalytics 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.