Matomo TagManager API

{"openapi":"3.1.0","info":{"title":"Matomo Reporting API for TagManager plugin","version":"1.0.0"},"servers":[{"url":"https:\/\/demo-proxy.innocraft.cloud\/","description":"Current Matomo instance"}],"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\".\n\nExample 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\".\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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.\n\nExample 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":"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 triggers in the requested container version.\n\nExample 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.addContainerTrigger":{"get":{"tags":["TagManager"],"description":"Creates a trigger in the requested container version.","operationId":"TagManager.addContainerTrigger","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 trigger template ID to create, for example \"AllElements\".","required":true,"schema":{"type":"string","example":"html"}},{"name":"name","in":"query","description":"The display name for the trigger.","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":"conditions","in":"query","description":"Trigger conditions that determine when the trigger matches. Use {@link TagManager.getAvailableComparisons} to list supported comparison operators.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]}},{"name":"description","in":"query","description":"Optional trigger description.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"The ID of the created trigger.\n\nExample 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.updateContainerTrigger":{"get":{"tags":["TagManager"],"description":"Updates a trigger in the requested container version.","operationId":"TagManager.updateContainerTrigger","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":"idTrigger","in":"query","description":"The trigger ID to update.","required":true,"schema":{"type":"integer","example":3}},{"name":"name","in":"query","description":"The updated display name for the trigger.","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":"conditions","in":"query","description":"Trigger conditions that determine when the trigger matches. Use {@link TagManager.getAvailableComparisons} to list supported comparison operators.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]}},{"name":"description","in":"query","description":"Optional trigger 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.deleteContainerTrigger":{"get":{"tags":["TagManager"],"description":"Deletes a trigger from a container version.","operationId":"TagManager.deleteContainerTrigger","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":"idTrigger","in":"query","description":"The trigger ID to delete.","required":true,"schema":{"type":"integer","example":3}}],"responses":{"200":{"$ref":"#\/components\/responses\/GenericSuccess"},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forb

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-tag-manager-openapi.json