curl --request GET \
--url https://api.highseat.com/v1/sites/{site}/filter-values/{dimension} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"value": "<string>",
"visitors": 0
}
],
"nextCursor": "<string>",
"meta": {
"timezone": "<string>",
"currency": "<string>",
"range": {
"from": "<string>",
"to": "<string>"
},
"compare": {
"from": "<string>",
"to": "<string>"
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}Get a dimension's values
The values a filter dimension takes in the range, most visitors first, as the dashboard’s filter picker offers them. Each value goes straight into a filter parameter. Every other filter still narrows the list; one on the listed dimension is ignored. dimension=property lists the property keys, or one key’s values with key. A list: { data, nextCursor, meta }. Walk it by passing nextCursor as cursor; the last page answers nextCursor: null. Reuse a cursor only with the same parameters.
curl --request GET \
--url https://api.highseat.com/v1/sites/{site}/filter-values/{dimension} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highseat.com/v1/sites/{site}/filter-values/{dimension}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"value": "<string>",
"visitors": 0
}
],
"nextCursor": "<string>",
"meta": {
"timezone": "<string>",
"currency": "<string>",
"range": {
"from": "<string>",
"to": "<string>"
},
"compare": {
"from": "<string>",
"to": "<string>"
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The site: its domain as registered (example.com), or its site id.
The filter dimension to list. A goal's values are the goals report's.
page_path, entry_page, exit_page, hostname, country, region, city, browser, os, device_type, referrer_source, referrer_domain, referrer_channel, utm_source, utm_medium, utm_campaign, utm_content, utm_term, event_name, property Query Parameters
The range: a calendar unit (day, week, month, year) positioned by date; a window ending now as a count and unit, m h d w mo (30m, 24h, 7d, 2w, 3mo); all; or custom, which reads from and to. Defaults to 7d.
day, week, month, year, all, custom Which day/week/month/year a unit preset refers to, YYYY-MM-DD in the site's timezone. Omitted means the current one.
^\d{4}-\d{2}-\d{2}$First day of a custom range, YYYY-MM-DD, inclusive.
^\d{4}-\d{2}-\d{2}$Last day of a custom range, YYYY-MM-DD, inclusive.
^\d{4}-\d{2}-\d{2}$Repeatable filter, written dimension[.key]:operator:value. Only the first two colons separate, so values may contain them. Dimensions: page_path, entry_page, exit_page, hostname, country, region, city, browser, os, device_type, referrer_source, referrer_domain, referrer_channel, utm_source, utm_medium, utm_campaign, utm_content, utm_term, event_name, goal, property (property and goal take a key). Operators: is, is_not, contains; country, region, goal take is and is_not only. A region takes the name the locations report gives it, an ISO 3166-2 code (region:is:DE-BY). Examples: filter=country:is:DE, filter=property.plan:is:pro. Repeat the parameter to combine filters; they all have to match.
1200Page size, largest first. 1–500, default 20. Not a cap on the whole list.
1 <= x <= 500Opaque cursor from the previous page's nextCursor. Omit for the first page (largest rows). Reuse it only with the same site, range, filters and tab/dimension. The last page answers nextCursor: null.
1 - 8192A property key, for dimension=property: list its values.
1 - 200Keep the values containing this text, any case.
1 - 200