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

The Matomo AbTesting API exposes 17 operations of the Matomo Reporting API (module `AbTesting`). A/B test experiment management and results reporting. Every operation is dispatched through the single `/index.php?module=API&method=AbTesting.` 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 AbTesting 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, A/B Testing, and Experiments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

17 operations 17 paths 4 schemas 17 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 AbTesting 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 17

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

AbTesting 17

Exposes the AbTesting API for managing experiments, embedding experiment scripts, and reading experiment reports.

GET
/index.php?module=API&method=AbTesting.getMetricsOverview
Returns overview metrics for each variation in an experiment.
AbTesting.getMetricsOverview 6 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getMetricDetails
Returns detailed report metrics for one success metric in an experiment.
AbTesting.getMetricDetails 7 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.addExperiment
Creates a new experiment with variations, targeting rules, and success metrics.
AbTesting.addExperiment 8 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.updateExperiment
Updates an existing experiment and its reporting configuration.
AbTesting.updateExperiment 17 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.startExperiment
Starts an experiment immediately.
AbTesting.startExperiment 3 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.finishExperiment
Finishes an experiment and stops it from accepting new tracking requests.
AbTesting.finishExperiment 3 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.archiveExperiment
Archives an experiment so it is no longer available in reports, segments, or updates.
AbTesting.archiveExperiment 3 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getJsIncludeTemplate
Returns the script tag needed to include the A/B testing JavaScript tracker.
AbTesting.getJsIncludeTemplate 1 param → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getJsExperimentTemplate
Returns the JavaScript snippet needed to run an experiment on a site.
AbTesting.getJsExperimentTemplate 3 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getAllExperiments
Returns all experiments configured for a site.
AbTesting.getAllExperiments 2 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getActiveExperiments
Returns the active experiments for a site.
AbTesting.getActiveExperiments 2 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getExperimentsByStatuses
Returns experiments for a site filtered by one or more statuses.
AbTesting.getExperimentsByStatuses 3 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getExperiment
Returns a single experiment definition.
AbTesting.getExperiment 3 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.deleteExperiment
Permanently deletes an experiment.
AbTesting.deleteExperiment 3 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getAvailableStatuses
Returns the valid experiment status values.
AbTesting.getAvailableStatuses 2 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getAvailableSuccessMetrics
Returns the success metrics that can be assigned to experiments for a site.
AbTesting.getAvailableSuccessMetrics 2 params → 200400401403404500default
GET
/index.php?module=API&method=AbTesting.getAvailableTargetAttributes
Returns the available target attributes and target rule types for experiment targeting.
AbTesting.getAvailableTargetAttributes 1 param → 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-ab-testing-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 AbTesting 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.