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

The Matomo FormAnalytics API exposes 26 operations of the Matomo Reporting API (module `FormAnalytics`). Form performance analytics — entry and drop-off fields, field timings, corrections and conversion rules. Every operation is dispatched through the single `/index.php?module=API&method=FormAnalytics.` 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 FormAnalytics 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, Forms, and Conversion Optimization. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

26 operations 26 paths 4 schemas 26 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 FormAnalytics 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 26

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

FormAnalytics 26

Exposes the Form Analytics API for managing tracked forms and retrieving form performance reports. Use these endpoints to create, update, archive, and delete configured forms, ins…

GET
/index.php?module=API&method=FormAnalytics.addForm
Adds a new form to the specified website.
FormAnalytics.addForm 9 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.updateForm
Updates an existing form.
FormAnalytics.updateForm 10 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getForm
Get a specific form by its ID.
FormAnalytics.getForm 3 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getForms
Get all forms for a specific website or app.
FormAnalytics.getForms 2 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getFormsByStatuses
Get a list of forms by status(es). To get a list of available statuses call "FormAnalytics.getAvailableStatuses".
FormAnalytics.getFormsByStatuses 3 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.deleteForm
Deletes the given form.
FormAnalytics.deleteForm 3 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.archiveForm
Archives the given form.
FormAnalytics.archiveForm 3 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.get
Get a form overview report.
FormAnalytics.get 7 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getSummary
Get a per-form summary report for the selected period.
FormAnalytics.getSummary 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getEntryFields
Get the entry fields report.
FormAnalytics.getEntryFields 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getDropOffFields
Get the drop off fields report.
FormAnalytics.getDropOffFields 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getPageUrls
Get form overview metrics for each page. This is useful when your form is embedded on several pages and you want to see how each form performs on the different pages.
FormAnalytics.getPageUrls 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getFieldTimings
Get the field timings report to see how long visitors spent on each field or to see for how long they waited before they filled out a form field.
FormAnalytics.getFieldTimings 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getFieldSize
Get the field size report to see how many characters visitors typed into your text fields.
FormAnalytics.getFieldSize 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getUneededFields
Get the unneeded fields report to see which fields were often left blank when your visitors submitted your forms.
FormAnalytics.getUneededFields 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getMostUsedFields
Get the most used fields to see which fields were most interacted and changed.
FormAnalytics.getMostUsedFields 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getFieldCorrections
Get the field corrections report to see which fields were corrected the most. For example backspaces, amendmends, refocuses, usage of cursors keys, etc.
FormAnalytics.getFieldCorrections 6 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.updateFormFieldDisplayName
Lets you update known form fields to set a display name.
FormAnalytics.updateFormFieldDisplayName 4 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getCounters
This method returns simple counters, for a given website ID, for visits over the last N minutes to see how your forms were doing in real time.
FormAnalytics.getCounters 4 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getCurrentMostPopularForms
This methods returns the currently most popular forms, for a given website ID, for visits over the last N minutes to see which forms are performing best in real time.
FormAnalytics.getCurrentMostPopularForms 5 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getAutoCreationSettings
Returns settings about the auto creation of forms.
FormAnalytics.getAutoCreationSettings 2 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getAvailableStatuses
Get a list of valid form statuses.
FormAnalytics.getAvailableStatuses 1 param → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getAllGoals
Get all goals configured for a site.
FormAnalytics.getAllGoals 2 params → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getAvailableFormRules
Get a list of available form rule patterns that can be used to configure a form.
FormAnalytics.getAvailableFormRules 1 param → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getAvailablePageRules
Get a list of available conversion rule patterns that can be used to configure a form.
FormAnalytics.getAvailablePageRules 1 param → 200400401403404500default
GET
/index.php?module=API&method=FormAnalytics.getAvailableConversionRuleOptions
Get a list of available conversion rule options that can be used to configure a form.
FormAnalytics.getAvailableConversionRuleOptions 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-form-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 Referrers API
Matomo Funnels API
Where this information came from

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