List of tags

get https://{account}.piwik.pro/api/tag/v1/{app_id}/tags

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:

tags?filter[template]=piwik,adroll

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

tags?filter[template][]=piwik&filter[template][]=adroll

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

app_id

uuid

required

Application identifier

Query Params

page[limit]

integer

≥ 1

Limits the number of returned items

page[offset]

integer

≥ 0

Sets offset for list of items

filter[name]

string

length between 1 and 255

Filter tags by name

filter[is_active]

boolean

Filter tags by active status

filter[consent_type]

string

Filter tags by consent type

filter[template]

string

Filter tags by template

filter[is_prioritized]

boolean

Filter tags by being prioritized or not

sort

array of strings

length ≥ 1

Comma-separated sort list with given attributes: name, is_active, tag_type, consent_type, priority, created_at, updated_at.

Sorting by priority (and -priority) sorts also by primary key to keep stable order of tags with same priority.

sort

Show Deprecated

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.piwik.pro/api/tag/v1/app_id/tags?sort=name' \
3
     --header 'accept: application/vnd.api+json'


xxxxxxxxxx
44
}
1
{
2
  "meta": {
3
    "total": 2
4
  },
5
  "links": {
6
    "self": "/api/tag/v1/tags/?sort=name&page[offset]=0&page[limit]=10",
7
    "first": "/api/tag/v1/tags/?sort=name&page[offset]=0&page[limit]=10",
8
    "last": "/api/tag/v1/tags/?sort=name&page[offset]=0&page[limit]=10",
9
    "prev": null,
10
    "next": null
11
  },
12
  "data": [
13
    {
14
      "type": "tag",
15
      "id": "7533cd95-537a-495f-9b10-450b413a3a75",
16
      "attributes": {
17
        "is_active": false,
18
        "is_published": true,
19
        "priority": 15,
20
        "tag_type": "async",
21
        "name": "Piwik PRO",
22
        "consent_type": "analytics",
23
        "template": "piwik",
24
        "created_at": "2020-05-27T10:23:01+00:00",
25
        "updated_at": "2020-05-27T20:09:24+00:00"

200List of tags

400Bad request parameter

401Unauthorized

404Not found

500Internal server error