v1

latestOpenAPI 3.1.02026-07-2419603.1 MB
Tag Manager

List of variables

JSON API compatibility divergence

Filters

In JSON API standard (https://jsonapi.org/recommendations/#filtering) one can request elements with multiple filter values by simply providing them separated by coma:

variables?filter[variable_type]=url,constant

This notation will not work here. You can achieve this functionality by providing multiple filters for the same parameter:

variables?filter[variable_type][]=url&filter[variable_type][]=constant

get/api/tag/v1/{app_id}/variables

Query parameters

page[limit]integer

Limits the number of returned items

page[offset]integer

Sets offset for list of items

filter[name]string

Filter variable name attribute

filter[variable_type]'custom_javascript' | 'constant' | 'cookie' | 'data_layer' | 'dom_element' | 'document' | 'random' | 'url' | 'lookup_table' | 'piwik_anonymization' | 'cdp_audience' | 'abandoned'

Variable type

Filter variable with type

filter[builtin]boolean

Filter variable with builtin attribute

filter[has_any_unrecognized_variables]boolean

Filter variables that have (or don't have) unrecognized variables in their value

filter[is_not_used]boolean

Filter variables that are not used anywhere (in tags, triggers, or other variables)

sortstring[]

Comma-separated sort list with given attributes: name, variable_type, created_at, updated_at

Response

List of variables