Create a saved report
curl --request POST \
--url https://api.highseat.com/v1/sites/{site}/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"series": [
{
"label": "",
"filters": []
}
],
"metric": "visitors",
"propertyKey": "<string>",
"period": "<unknown>",
"showRevenue": true
}
'import requests
url = "https://api.highseat.com/v1/sites/{site}/reports"
payload = {
"name": "<string>",
"series": [
{
"label": "",
"filters": []
}
],
"metric": "visitors",
"propertyKey": "<string>",
"period": "<unknown>",
"showRevenue": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
series: [{label: '', filters: []}],
metric: 'visitors',
propertyKey: '<string>',
period: '<unknown>',
showRevenue: true
})
};
fetch('https://api.highseat.com/v1/sites/{site}/reports', 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}/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'series' => [
[
'label' => '',
'filters' => [
]
]
],
'metric' => 'visitors',
'propertyKey' => '<string>',
'period' => '<unknown>',
'showRevenue' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.highseat.com/v1/sites/{site}/reports"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"series\": [\n {\n \"label\": \"\",\n \"filters\": []\n }\n ],\n \"metric\": \"visitors\",\n \"propertyKey\": \"<string>\",\n \"period\": \"<unknown>\",\n \"showRevenue\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.highseat.com/v1/sites/{site}/reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"series\": [\n {\n \"label\": \"\",\n \"filters\": []\n }\n ],\n \"metric\": \"visitors\",\n \"propertyKey\": \"<string>\",\n \"period\": \"<unknown>\",\n \"showRevenue\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highseat.com/v1/sites/{site}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"series\": [\n {\n \"label\": \"\",\n \"filters\": []\n }\n ],\n \"metric\": \"visitors\",\n \"propertyKey\": \"<string>\",\n \"period\": \"<unknown>\",\n \"showRevenue\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"type": "trend",
"metric": "visitors",
"dimension": "<string>",
"propertyKey": "<string>",
"series": [
{
"label": "<string>",
"filters": [
"<string>"
]
}
],
"period": "<string>",
"granularity": "hour",
"showRevenue": true,
"position": 0,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<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>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"id": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}
}Reports
Create a saved report
Adds a report to the end of the site’s Reports page, checked as the dashboard’s builder checks it. The API key is recorded as its author.
POST
/
sites
/
{site}
/
reports
Create a saved report
curl --request POST \
--url https://api.highseat.com/v1/sites/{site}/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"series": [
{
"label": "",
"filters": []
}
],
"metric": "visitors",
"propertyKey": "<string>",
"period": "<unknown>",
"showRevenue": true
}
'import requests
url = "https://api.highseat.com/v1/sites/{site}/reports"
payload = {
"name": "<string>",
"series": [
{
"label": "",
"filters": []
}
],
"metric": "visitors",
"propertyKey": "<string>",
"period": "<unknown>",
"showRevenue": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
series: [{label: '', filters: []}],
metric: 'visitors',
propertyKey: '<string>',
period: '<unknown>',
showRevenue: true
})
};
fetch('https://api.highseat.com/v1/sites/{site}/reports', 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}/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'series' => [
[
'label' => '',
'filters' => [
]
]
],
'metric' => 'visitors',
'propertyKey' => '<string>',
'period' => '<unknown>',
'showRevenue' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.highseat.com/v1/sites/{site}/reports"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"series\": [\n {\n \"label\": \"\",\n \"filters\": []\n }\n ],\n \"metric\": \"visitors\",\n \"propertyKey\": \"<string>\",\n \"period\": \"<unknown>\",\n \"showRevenue\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.highseat.com/v1/sites/{site}/reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"series\": [\n {\n \"label\": \"\",\n \"filters\": []\n }\n ],\n \"metric\": \"visitors\",\n \"propertyKey\": \"<string>\",\n \"period\": \"<unknown>\",\n \"showRevenue\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highseat.com/v1/sites/{site}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"series\": [\n {\n \"label\": \"\",\n \"filters\": []\n }\n ],\n \"metric\": \"visitors\",\n \"propertyKey\": \"<string>\",\n \"period\": \"<unknown>\",\n \"showRevenue\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"type": "trend",
"metric": "visitors",
"dimension": "<string>",
"propertyKey": "<string>",
"series": [
{
"label": "<string>",
"filters": [
"<string>"
]
}
],
"period": "<string>",
"granularity": "hour",
"showRevenue": true,
"position": 0,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": {
"name": "<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>"
}
]
}
}{
"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.
Headers
Any unique string up to 255 characters, such as a UUID. A retry with the same key and body within 24 hours answers what the first call did, without writing again.
Required string length:
1 - 255Path Parameters
The site: its domain as registered (example.com), or its site id.
Body
application/json
The tile's title.
Required string length:
1 - 100trend charts the metric over time; list ranks the rows of one dimension.
Available options:
trend, list One to 3 series for a trend, each drawn as its own line of the same metric; exactly one for a list, whose filters narrow its rows. An events trend names its event on every series with event_name:is:<name> or goal.event:is:<name>.
Required array length:
1 - 3 elementsShow child attributes
Show child attributes
What a trend charts per bucket. events counts the event each series names. A list ranks by its dimension's own count, as its dashboard card does.
Available options:
visitors, sessions, pageviews, events, bounceRate, avgDuration, revenue A list's rows: a filter dimension a dashboard card lists (page_path, entry_page, exit_page, hostname, country, region, city, browser, os, device_type, referrer_source, referrer_channel, utm_*, event_name), or property. Null for a trend.
Available options:
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 The event property a list by property ranks the values of. Null otherwise.
Required string length:
1 - 200The range the tile always reads: a calendar period (day, week, month, year), all, or a window of an hour or more (24h, 30d, 3mo). Null follows the Reports page's picker.
A trend's bucket size. Null follows the range's length, as the dashboard's chart does.
Available options:
hour, day, week, month Whether a list's tile shows its revenue column, once the site has sold. A display choice: the report's results carry each row's revenue either way.
Response
OK
Show child attributes
Show child attributes