Matomo

Matomo Funnels API

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

GitHub OpenAPI

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /index.php?module=API&method=Funnels.getMetrics Get summary metrics for a funnel · Funnels get metrics #
Ask an LLM
“What was the overall conversion rate of my checkout funnel last month?”
“How many visits entered and completed a funnel in a given period?”
Tell an agent
Get the summary metrics for funnel {idFunnel} on site {idSite} for {period} {date}.
Show the conversion summary of the funnel for goal {idGoal} on site {idSite}, {period} of {date}.
GET /index.php?module=API&method=Funnels.getFunnelsSummary Compare all activated funnels on a site · Funnels get funnels summary #
Ask an LLM
“Which of my funnels converts best on this site?”
“Can I see one row per active funnel side by side for a date range?”
Tell an agent
Show the overview table of all active funnels on site {idSite} for {period} {date}.
Compare every funnel on site {idSite} row by row for {date} ({period}) within segment {segment}.
GET /index.php?module=API&method=Funnels.getFunnelsSummaryTotals Get combined totals across all funnels · Funnels get funnels summary totals #
Ask an LLM
“What are the total funnel conversions across all my funnels combined?”
“Can I get aggregate funnel totals for a site rather than per-funnel rows?”
Tell an agent
Get the combined totals across all activated funnels on site {idSite} for {period} {date}.
Sum up all funnel activity on site {idSite} in {date} by {period}.
GET /index.php?module=API&method=Funnels.getFunnelFlow Get step-by-step flow metrics for a funnel · Funnels get funnel flow #
Ask an LLM
“At which step of my signup funnel do most visitors drop off?”
“How many visitors proceed from each funnel step to the next?”
Tell an agent
Show per-step flow metrics for funnel {idFunnel} on site {idSite} for {period} {date}.
Break down the step drop-off of the funnel for goal {idGoal} on site {idSite} in {date} ({period}).
GET /index.php?module=API&method=Funnels.getFunnelFlowTable Get the funnel flow as a data table · Funnels get funnel flow table #
Ask an LLM
“Can I get the funnel flow report in the standard table layout used by other reports?”
“Is there a tabular version of the funnel step flow I can export?”
Tell an agent
Export the funnel flow table for funnel {idFunnel} on site {idSite}, {period} {date}.
Give me the data-table formatted flow for goal {idGoal}'s funnel on site {idSite} for {date} by {period}.
GET /index.php?module=API&method=Funnels.getFunnelStepSubtable Drill into the rows of one funnel step · Funnels get funnel step subtable #
Ask an LLM
“What detail rows sit underneath a single step of my funnel?”
“Can I drill into just the third step of a funnel?”
Tell an agent
Show the subtable for step {stepPosition} of funnel {idFunnel} on site {idSite}, {period} {date}.
Drill into funnel step {stepPosition} on site {idSite} for {date} ({period}).
GET /index.php?module=API&method=Funnels.getFunnelEntries See where visitors entered a funnel · Funnels get funnel entries #
Ask an LLM
“Which pages do visitors come from when they enter my funnel?”
“Can I see entry actions for one specific funnel step only?”
Tell an agent
List entry actions into funnel {idFunnel} on site {idSite} for {period} {date}.
Show how visitors entered step {step} of funnel {idFunnel} on site {idSite} in {date} ({period}).
GET /index.php?module=API&method=Funnels.getFunnelExits See where visitors left a funnel · Funnels get funnel exits #
Ask an LLM
“Where do people go after abandoning my funnel?”
“What exit actions follow a particular funnel step?”
Tell an agent
List exit actions from funnel {idFunnel} on site {idSite} for {period} {date}.
Show where visitors went after leaving step {step} of funnel {idFunnel} on site {idSite}, {date} ({period}).
GET /index.php?module=API&method=Funnels.getGoalFunnel Get the funnel configured for a goal · Funnels get goal funnel #
Ask an LLM
“What steps are defined in the funnel attached to a goal?”
“Does a particular goal have a funnel configured?”
Tell an agent
Show the funnel configured for goal {idGoal} on site {idSite}.
Get the step definition of goal {idGoal}'s funnel on site {idSite}.
GET /index.php?module=API&method=Funnels.getSalesFunnelForSite Get a site's ecommerce sales funnel · Funnels get sales funnel for site #
Ask an LLM
“What does the sales funnel configured for my shop look like?”
“Is there a configured ecommerce sales funnel on this site?”
Tell an agent
Show the configured sales funnel for site {idSite}.
Get the ecommerce sales funnel definition of site {idSite}.
GET /index.php?module=API&method=Funnels.getFunnel Get a funnel definition by ID · Funnels get funnel #
Ask an LLM
“What steps and patterns make up a funnel I already created?”
“Can I look up a funnel's definition using its funnel ID?”
Tell an agent
Get the definition of funnel {idFunnel} on site {idSite}.
Show the configured steps of funnel ID {idFunnel} for site {idSite}.
GET /index.php?module=API&method=Funnels.getAllActivatedFunnelsForSite List all activated funnels on a site · Funnels get all activated funnels for site #
Ask an LLM
“Which funnels are currently active on my website?”
“What funnel definitions are switched on for a site?”
Tell an agent
List all activated funnels on site {idSite}.
Show the definitions of every active funnel for site {idSite}.
GET /index.php?module=API&method=Funnels.hasAnyActivatedFunnelForSite Check whether a site has any active funnel · Funnels has any activated funnel for site #
Ask an LLM
“Does this site have at least one funnel turned on?”
“Is funnel tracking active anywhere on a given website?”
Tell an agent
Check whether site {idSite} has any activated funnel.
Confirm whether any funnel is switched on for site {idSite}.
GET /index.php?module=API&method=Funnels.deleteGoalFunnel Delete the funnel attached to a goal · Funnels delete goal funnel #
Ask an LLM
“How do I remove the funnel from a goal without deleting the goal itself?”
“Can I delete a goal's funnel configuration?”
Tell an agent destructive · confirm first
Delete the funnel configured for goal {idGoal} on site {idSite}.
Remove goal {idGoal}'s funnel from site {idSite}.
GET /index.php?module=API&method=Funnels.deleteNonGoalFunnel Delete a standalone funnel · Funnels delete non goal funnel #
Ask an LLM
“How do I delete a funnel that isn't linked to any goal?”
“Can I remove a standalone funnel by its ID?”
Tell an agent destructive · confirm first
Delete the standalone funnel {idFunnel} on site {idSite}.
Remove non-goal funnel ID {idFunnel} from site {idSite}.
GET /index.php?module=API&method=Funnels.setGoalFunnel Create or update a goal's funnel · Funnels set goal funnel #
Ask an LLM
“How do I add funnel steps to an existing goal?”
“Can I deactivate a goal's funnel without deleting its steps?”
Tell an agent
Set the funnel for goal {idGoal} on site {idSite} with steps {steps} and activation {isActivated}.
Turn the goal {idGoal} funnel on site {idSite} to activated={isActivated}.
GET /index.php?module=API&method=Funnels.saveNonGoalFunnel Create or update a standalone funnel · Funnels save non goal funnel #
Ask an LLM
“Can I build a funnel that isn't tied to a goal?”
“How do I rename or change the steps of a standalone funnel?”
Tell an agent
Save standalone funnel {idFunnel} named {funnelName} on site {idSite} with steps {steps}.
Create a non-goal funnel {funnelName} (ID {idFunnel}) on site {idSite} using steps {steps}, described as {description}.
GET /index.php?module=API&method=Funnels.getAvailablePatternMatches List pattern match types for funnel steps · Funnels get available pattern matches #
Ask an LLM
“What kinds of URL matching can a funnel step use, like contains or regex?”
“Which pattern types are available when defining funnel steps?”
Tell an agent
List the pattern match types available for funnel steps.
Show the matching options I can use in a funnel step definition.
GET /index.php?module=API&method=Funnels.testUrlMatchesSteps Test a URL against funnel step patterns · Funnels test url matches steps #
Ask an LLM
“Will a particular page URL match the funnel steps I've defined?”
“Can I check my funnel step patterns before saving the funnel?”
Tell an agent
Test whether {url} matches the funnel steps {steps}.
Check which of the step patterns {steps} the URL {url} satisfies.

Documentation

📖
Documentation
https://developer.matomo.org/api-reference/reporting-api
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api#Live
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api#Goals
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api-segmentation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-funnels-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/matomo:matomo-funnels-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

matomo-funnels-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Matomo Reporting API for plugin Funnels API
  version: 1.0.0
  description: Exposes the Funnels reporting and management API for funnel analytics configuration. Includes endpoints for funnel reports, funnel definitions, and pattern validation helpers.
servers:
- url: https://demo-proxy.innocraft.cloud/
  description: Current Matomo instance
security:
- MatomoToken: []
tags:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-funnels-api-openapi.yml