List of variables

get https://{account}.piwik.pro/api/tag/v1/{app_id}/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

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

OAuth2

URL


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


xxxxxxxxxx
26
}
1
{
2
  "data": [
3
    {
4
      "id": "677423b3-e529-4e03-88fd-d3b9dcacf2cf",
5
      "type": "variable",
6
      "attributes": {
7
        "name": "New variable",
8
        "variable_type": "custom_javascript",
9
        "builtin": false,
10
        "is_published": false,
11
        "created_at": "2020-01-29T13:43:57+00:00",
12
        "updated_at": "2020-01-29T13:43:57+00:00"
13
      }
14
    }
15
  ],
16
  "meta": {
17
    "total": 25
18
  },
19
  "links": {
20
    "self": "/api/tag/v1/1f74dda5-b598-41d6-a9e4-f501ef4379e1/variables?page[offset]=0&page[limit]=10",
21
    "first": "/api/tag/v1/1f74dda5-b598-41d6-a9e4-f501ef4379e1/variables?page[offset]=10&page[limit]=10",
22
    "last": "/api/tag/v1/1f74dda5-b598-41d6-a9e4-f501ef4379e1/variables?page[offset]=20&page[limit]=10",
23
    "prev": null,
24
    "next": null
25
  }

200List of variables

400Bad request parameter

401Unauthorized

404Not found

500Internal server error