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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Matomo

Matomo Funnels API

The Matomo Funnels API exposes 19 operations of the Matomo Reporting API (module `Funnels`). Conversion funnel definition and analysis — flow, entries, exits and step-level drop-off. Every operation is dispatched through the single `/index.php?module=API&method=Funnels.` 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.

Documentation Provider Profile APIs.io OpenAPI GitHub

Matomo Funnels 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, Funnels, Conversion, and Drop-Off. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

19 operations 19 paths 4 schemas 19 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 Funnels 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 19

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

Funnels 19

Exposes the Funnels reporting and management API for funnel analytics configuration. Includes endpoints for funnel reports, funnel definitions, and pattern validation helpers.

GET
/index.php?module=API&method=Funnels.getMetrics
Returns summary metrics for a funnel for the requested period.
Funnels.getMetrics 7 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnelsSummary
Returns an overview table containing one row per activated funnel for the site.
Funnels.getFunnelsSummary 5 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnelsSummaryTotals
Returns overview totals across all activated funnels for the site.
Funnels.getFunnelsSummaryTotals 5 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnelFlow
Returns per-step funnel flow metrics for the requested funnel.
Funnels.getFunnelFlow 7 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnelFlowTable
Returns the funnel flow report formatted for the standard data table view.
Funnels.getFunnelFlowTable 7 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnelStepSubtable
Returns the subtable rows for a single funnel step.
Funnels.getFunnelStepSubtable 8 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnelEntries
Returns entry actions for a funnel or a specific funnel step.
Funnels.getFunnelEntries 10 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnelExits
Returns exit actions for a funnel or a specific funnel step.
Funnels.getFunnelExits 7 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getGoalFunnel
Returns the configured funnel for a goal.
Funnels.getGoalFunnel 3 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getSalesFunnelForSite
Returns the configured sales funnel for a site.
Funnels.getSalesFunnelForSite 2 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getFunnel
Returns a funnel definition by funnel ID.
Funnels.getFunnel 3 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getAllActivatedFunnelsForSite
Returns all activated funnels for a site.
Funnels.getAllActivatedFunnelsForSite 2 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.hasAnyActivatedFunnelForSite
Returns whether the site has at least one activated funnel.
Funnels.hasAnyActivatedFunnelForSite 2 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.deleteGoalFunnel
Deletes the funnel configured for a goal.
Funnels.deleteGoalFunnel 3 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.deleteNonGoalFunnel
Deletes a non-goal funnel by funnel ID.
Funnels.deleteNonGoalFunnel 3 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.setGoalFunnel
Creates or updates the funnel configuration for a goal.
Funnels.setGoalFunnel 5 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.saveNonGoalFunnel
Creates or updates a funnel that is not tied to a goal.
Funnels.saveNonGoalFunnel 6 params → 200400401403404500default
GET
/index.php?module=API&method=Funnels.getAvailablePatternMatches
Returns the available pattern match types for funnel steps.
Funnels.getAvailablePatternMatches 1 param → 200400401403404500default
GET
/index.php?module=API&method=Funnels.testUrlMatchesSteps
Tests a value against the provided funnel step patterns.
Funnels.testUrlMatchesSteps 3 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-funnels-openapi.json Raw ↑

Other APIs Matomo publishes across the network.

Matomo Live API
AE Profile APIs.io
Matomo Goals API
AE Profile APIs.io
Matomo Segments API
AE Profile APIs.io
Matomo Reporting API (index.php entrypoint)
AE Profile APIs.io
Matomo Tracking API (matomo.php entrypoint)
AE Profile APIs.io
Matomo SitesManager API
AE Profile APIs.io
Matomo TagManager API
AE Profile APIs.io
Matomo UsersManager API
AE Profile APIs.io
Matomo CrashAnalytics API
AE Profile APIs.io
Matomo HeatmapSessionRecording API
AE Profile APIs.io
Matomo FormAnalytics API
AE Profile APIs.io
Matomo Referrers API
AE Profile APIs.io
#Analytics#Funnels#Conversion#Drop-Off
← Back to M APIs
API Details
ID
matomo:funnels-api
Base URL
https://{matomo_host}/index.php
Docs
https://developer.matomo.org/api-reference/reporting-api
Provider
Matomo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=funnels-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/funnels-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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