Matomo Tag Manager API
Exposes the Tag Manager API for managing containers, versions, tags, triggers, and variables. The endpoints also provide installation metadata, publishing workflows, preview controls, and import/export operations. A container may have several versions, and the current editable version is exposed as the "draft" version by {@link TagManager.getContainer}.
GET
/index.php?module=API&method=TagManager.getAvailableContexts
#
GET
/index.php?module=API&method=TagManager.getAvailableEnvironments
#
GET
/index.php?module=API&method=TagManager.getAvailableEnvironmentsWithPublishCapability
#
GET
/index.php?module=API&method=TagManager.getAvailableTagFireLimits
#
GET
/index.php?module=API&method=TagManager.getAvailableComparisons
#
GET
/index.php?module=API&method=TagManager.getAvailableTagTypesInContext
#
GET
/index.php?module=API&method=TagManager.getAvailableTriggerTypesInContext
#
GET
/index.php?module=API&method=TagManager.getAvailableVariableTypesInContext
#
GET
/index.php?module=API&method=TagManager.getContainerEmbedCode
#
GET
/index.php?module=API&method=TagManager.getContainerInstallInstructions
#
GET
/index.php?module=API&method=TagManager.createDefaultContainerForSite
#
GET
/index.php?module=API&method=TagManager.addContainerTag
#
GET
/index.php?module=API&method=TagManager.updateContainerTag
#
GET
/index.php?module=API&method=TagManager.deleteContainerTag
#
GET
/index.php?module=API&method=TagManager.pauseContainerTag
#
GET
/index.php?module=API&method=TagManager.resumeContainerTag
#
GET
/index.php?module=API&method=TagManager.getContainerTag
#
GET
/index.php?module=API&method=TagManager.getContainerTriggerReferences
#
GET
/index.php?module=API&method=TagManager.getContainerTriggers
#
GET
/index.php?module=API&method=TagManager.addContainerTrigger
#
GET
/index.php?module=API&method=TagManager.updateContainerTrigger
#
GET
/index.php?module=API&method=TagManager.deleteContainerTrigger
#
GET
/index.php?module=API&method=TagManager.getContainerTrigger
#
GET
/index.php?module=API&method=TagManager.getContainerVariableReferences
#
GET
/index.php?module=API&method=TagManager.getContainerVariables
#
GET
/index.php?module=API&method=TagManager.getAvailableContainerVariables
#
GET
/index.php?module=API&method=TagManager.addContainerVariable
#
GET
/index.php?module=API&method=TagManager.updateContainerVariable
#
GET
/index.php?module=API&method=TagManager.deleteContainerVariable
#
GET
/index.php?module=API&method=TagManager.getContainerVariable
#
GET
/index.php?module=API&method=TagManager.getContainers
#
GET
/index.php?module=API&method=TagManager.addContainer
#
GET
/index.php?module=API&method=TagManager.updateContainer
#
GET
/index.php?module=API&method=TagManager.createContainerVersion
#
GET
/index.php?module=API&method=TagManager.updateContainerVersion
#
GET
/index.php?module=API&method=TagManager.getContainerVersions
#
GET
/index.php?module=API&method=TagManager.getContainerVersion
#
GET
/index.php?module=API&method=TagManager.deleteContainerVersion
#
GET
/index.php?module=API&method=TagManager.publishContainerVersion
#
GET
/index.php?module=API&method=TagManager.deleteContainer
#
GET
/index.php?module=API&method=TagManager.getContainer
#
GET
/index.php?module=API&method=TagManager.enablePreviewMode
#
GET
/index.php?module=API&method=TagManager.disablePreviewMode
#
GET
/index.php?module=API&method=TagManager.changeDebugUrl
#
GET
/index.php?module=API&method=TagManager.exportContainerVersion
#
GET
/index.php?module=API&method=TagManager.importContainerVersion
#
Documentation
Specifications
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-tagmanager-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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Matomo Reporting API for plugin Tag Manager API
version: 1.0.0
description: Exposes the Tag Manager API for managing containers, versions, tags, triggers, and variables. The endpoints also provide installation metadata, publishing workflows, preview controls, and import/export operations. A container may have several versions, and the current editable version is exposed as the "draft" version by {@link TagManager.getContainer}.
servers:
- url: https://demo-proxy.innocraft.cloud/
description: Current Matomo instance
security:
- MatomoToken: []
tags:
- name: TagManager
description: Exposes the Tag Manager API for managing containers, versions, tags, triggers, and variables. The endpoints also provide installation metadata, publishing workflows, preview controls, and import/export operations. A container may have several versions, and the current editable version is exposed as the "draft" version by {@link TagManager.getContainer}.
paths:
/index.php?module=API&method=TagManager.getAvailableContexts:
get:
tags:
- TagManager
description: Returns the contexts that currently expose at least one tag type.
operationId: TagManager.getAvailableContexts
parameters:
- $ref: '#/components/parameters/formatOptional'
responses:
'200':
description: 'The available context definitions, such as "web", "android", or "ios".
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
application/vnd.ms-excel: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getAvailableEnvironments:
get:
tags:
- TagManager
description: Returns the environments that can receive container releases.
operationId: TagManager.getAvailableEnvironments
parameters:
- $ref: '#/components/parameters/formatOptional'
responses:
'200':
description: 'The configured environments, such as "live", "dev", and "staging".
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
application/vnd.ms-excel: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getAvailableEnvironmentsWithPublishCapability:
get:
tags:
- TagManager
description: Returns the environments the current user can publish to for a site.
operationId: TagManager.getAvailableEnvironmentsWithPublishCapability
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
responses:
'200':
description: 'The publishable environments for the site, excluding "live" when the user lacks that capability.
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
application/vnd.ms-excel: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getAvailableTagFireLimits:
get:
tags:
- TagManager
description: Returns the supported fire limit options for tags.
operationId: TagManager.getAvailableTagFireLimits
parameters:
- $ref: '#/components/parameters/formatOptional'
responses:
'200':
description: 'The available fire limit IDs and translated labels.
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
application/vnd.ms-excel: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getAvailableComparisons:
get:
tags:
- TagManager
description: Returns the comparison operators available for trigger conditions and variable lookup tables.
operationId: TagManager.getAvailableComparisons
parameters:
- $ref: '#/components/parameters/formatOptional'
responses:
'200':
description: 'The supported comparison definitions.
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
application/vnd.ms-excel: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getAvailableTagTypesInContext:
get:
tags:
- TagManager
description: Returns the tag templates that support the requested context.
operationId: TagManager.getAvailableTagTypesInContext
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idContext
in: query
description: The context ID to query, for example "web", "android", or "ios".
required: true
schema:
type: string
example: web
responses:
'200':
description: 'The tag template metadata available in the context.
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getAvailableTriggerTypesInContext:
get:
tags:
- TagManager
description: Returns the trigger templates that support the requested context.
operationId: TagManager.getAvailableTriggerTypesInContext
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idContext
in: query
description: The context ID to query, for example "web", "android", or "ios".
required: true
schema:
type: string
example: web
responses:
'200':
description: 'The trigger template metadata available in the context.
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getAvailableVariableTypesInContext:
get:
tags:
- TagManager
description: Returns the manually creatable variable templates that support the requested context.
operationId: TagManager.getAvailableVariableTypesInContext
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idContext
in: query
description: The context ID to query, for example "web", "android", or "ios".
required: true
schema:
type: string
example: web
responses:
'200':
description: 'The variable template metadata available in the context, excluding preconfigured variables.
Example responses require Super User access. Use Try it out to see a live response.'
content:
text/xml: []
application/json: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getContainerEmbedCode:
get:
tags:
- TagManager
description: Returns the embed code for loading a container release on a website.
operationId: TagManager.getContainerEmbedCode
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: environment
in: query
description: The environment ID to load, for example "live".
required: true
schema:
type: string
example: live
responses:
'200':
description: 'The HTML and JavaScript embed snippet for the requested container release.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getContainerInstallInstructions:
get:
tags:
- TagManager
description: Returns installation instructions for embedding a container release.
operationId: TagManager.getContainerInstallInstructions
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: environment
in: query
description: The environment ID to load, for example "live".
required: true
schema:
type: string
example: live
- name: jsFramework
in: query
description: The JavaScript framework variant to return, for example "react".
required: false
schema:
type: string
default: ''
responses:
'200':
description: 'The install instruction steps and metadata for the requested container release.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getContainerTags:
get:
tags:
- TagManager
description: Returns all configured tags in a container version.
operationId: TagManager.getContainerTags
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to inspect.
required: true
schema:
type: integer
example: 3
responses:
'200':
description: 'The configured tags in the requested container version.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.createDefaultContainerForSite:
get:
tags:
- TagManager
description: Creates a default web container for a site with the standard Matomo tracking setup.
operationId: TagManager.createDefaultContainerForSite
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
responses:
'200':
description: 'The ID of the created container.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.addContainerTag:
get:
tags:
- TagManager
description: Creates a tag in the requested container version.
operationId: TagManager.addContainerTag
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to modify.
required: true
schema:
type: integer
example: 3
- name: type
in: query
description: The tag template ID to create, for example "Matomo".
required: true
schema:
type: string
example: html
- name: name
in: query
description: The display name for the tag.
required: true
schema:
type: string
example: Pricing
- name: parameters
in: query
description: Parameter values keyed by template parameter name.
required: false
schema:
type: array
items:
type: string
default: []
- name: fireTriggerIds
in: query
description: Trigger IDs that cause the tag to fire. At least one trigger must be provided.
required: false
schema:
type: array
items:
type: integer
default: []
- name: blockTriggerIds
in: query
description: Trigger IDs that prevent the tag from firing after they match.
required: false
schema:
type: array
items:
type: integer
default: []
- name: fireLimit
in: query
description: Fire limit ID to apply to the tag. Use {@link TagManager.getAvailableTagFireLimits} to list supported values.
required: false
schema:
type: string
default: unlimited
- name: fireDelay
in: query
description: Delay in milliseconds before the tag executes after a fire trigger matches.
required: false
schema:
type: integer
default: 0
- name: priority
in: query
description: Execution priority for the tag. Lower values run earlier when multiple tags fire together.
required: false
schema:
type: integer
default: 999
- name: startDate
in: query
description: UTC datetime after which the tag may execute.
required: false
schema:
type: string
- name: endDate
in: query
description: UTC datetime after which the tag must no longer execute.
required: false
schema:
type: string
- name: description
in: query
description: Optional tag description.
required: false
schema:
type: string
default: ''
- name: status
in: query
description: Optional initial status for the created tag.
required: false
schema:
type: string
default: ''
responses:
'200':
description: 'The ID of the created tag.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.updateContainerTag:
get:
tags:
- TagManager
description: Updates a tag in the requested container version.
operationId: TagManager.updateContainerTag
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to modify.
required: true
schema:
type: integer
example: 3
- name: idTag
in: query
description: The tag ID to update.
required: true
schema:
type: integer
example: 2
- name: name
in: query
description: The updated display name for the tag.
required: true
schema:
type: string
example: Pricing
- name: parameters
in: query
description: Parameter values keyed by template parameter name.
required: false
schema:
type: array
items:
type: string
default: []
- name: fireTriggerIds
in: query
description: Trigger IDs that cause the tag to fire. At least one trigger must be provided.
required: false
schema:
type: array
items:
type: integer
default: []
- name: blockTriggerIds
in: query
description: Trigger IDs that prevent the tag from firing after they match.
required: false
schema:
type: array
items:
type: integer
default: []
- name: fireLimit
in: query
description: Fire limit ID to apply to the tag. Use {@link TagManager.getAvailableTagFireLimits} to list supported values.
required: false
schema:
type: string
default: unlimited
- name: fireDelay
in: query
description: Delay in milliseconds before the tag executes after a fire trigger matches.
required: false
schema:
type: integer
default: 0
- name: priority
in: query
description: Execution priority for the tag. Lower values run earlier when multiple tags fire together.
required: false
schema:
type: integer
default: 999
- name: startDate
in: query
description: UTC datetime after which the tag may execute.
required: false
schema:
type: string
- name: endDate
in: query
description: UTC datetime after which the tag must no longer execute.
required: false
schema:
type: string
- name: description
in: query
description: Optional tag description.
required: false
schema:
type: string
default: ''
responses:
'200':
$ref: '#/components/responses/GenericSuccess'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.deleteContainerTag:
get:
tags:
- TagManager
description: Deletes a tag from a container version.
operationId: TagManager.deleteContainerTag
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to modify.
required: true
schema:
type: integer
example: 3
- name: idTag
in: query
description: The tag ID to delete.
required: true
schema:
type: integer
example: 2
responses:
'200':
$ref: '#/components/responses/GenericSuccess'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.pauseContainerTag:
get:
tags:
- TagManager
description: Pauses a tag in a container version.
operationId: TagManager.pauseContainerTag
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to modify.
required: true
schema:
type: integer
example: 3
- name: idTag
in: query
description: The tag ID to pause.
required: true
schema:
type: integer
example: 2
responses:
'200':
description: 'Returns `true` when the tag was found and paused, or `false` when no matching tag exists.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.resumeContainerTag:
get:
tags:
- TagManager
description: Resumes a paused tag in a container version.
operationId: TagManager.resumeContainerTag
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to modify.
required: true
schema:
type: integer
example: 3
- name: idTag
in: query
description: The tag ID to resume.
required: true
schema:
type: integer
example: 2
responses:
'200':
description: 'Returns `true` when the tag was found and resumed, or `false` when no matching tag exists.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getContainerTag:
get:
tags:
- TagManager
description: Returns the configuration for a specific tag.
operationId: TagManager.getContainerTag
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to inspect.
required: true
schema:
type: integer
example: 3
- name: idTag
in: query
description: The tag ID to fetch.
required: true
schema:
type: integer
example: 2
responses:
'200':
description: 'The tag configuration, or `false` when the tag does not exist in the version.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getContainerTriggerReferences:
get:
tags:
- TagManager
description: Returns the places where a trigger is referenced in a container version.
operationId: TagManager.getContainerTriggerReferences
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in: query
description: The container ID, for example "6OMh6taM".
required: true
schema:
type: string
example: GTMNZ123
- name: idContainerVersion
in: query
description: The container version ID to inspect.
required: true
schema:
type: integer
example: 3
- name: idTrigger
in: query
description: The trigger ID to inspect.
required: true
schema:
type: integer
example: 3
responses:
'200':
description: 'The tag references that currently use the trigger.
Example responses require Super User access. Use Try it out to see a live response.'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/DefaultError'
/index.php?module=API&method=TagManager.getContainerTriggers:
get:
tags:
- TagManager
description: Returns all configured triggers in a container version.
operationId: TagManager.getContainerTriggers
parameters:
- $ref: '#/components/parameters/formatOptional'
- name: idSite
in: query
description: The numeric ID of the website to query.
required: true
schema:
type: integer
example: 1
- name: idContainer
in
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-tagmanager-api-openapi.yml