Update a site
curl --request PATCH \
--url https://api.highseat.com/v1/sites/{site} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"domain": "<string>",
"timezone": "<string>",
"thankYouPaths": [
"<string>"
],
"keptQueryParams": [
"<string>"
],
"excludedIps": [
"<string>"
],
"excludedPaths": [
"<string>"
],
"extraHostnames": [
"<string>"
]
}
'import requests
url = "https://api.highseat.com/v1/sites/{site}"
payload = {
"name": "<string>",
"domain": "<string>",
"timezone": "<string>",
"thankYouPaths": ["<string>"],
"keptQueryParams": ["<string>"],
"excludedIps": ["<string>"],
"excludedPaths": ["<string>"],
"extraHostnames": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
domain: '<string>',
timezone: '<string>',
thankYouPaths: ['<string>'],
keptQueryParams: ['<string>'],
excludedIps: ['<string>'],
excludedPaths: ['<string>'],
extraHostnames: ['<string>']
})
};
fetch('https://api.highseat.com/v1/sites/{site}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'domain' => '<string>',
'timezone' => '<string>',
'thankYouPaths' => [
'<string>'
],
'keptQueryParams' => [
'<string>'
],
'excludedIps' => [
'<string>'
],
'excludedPaths' => [
'<string>'
],
'extraHostnames' => [
'<string>'
]
]),
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}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"timezone\": \"<string>\",\n \"thankYouPaths\": [\n \"<string>\"\n ],\n \"keptQueryParams\": [\n \"<string>\"\n ],\n \"excludedIps\": [\n \"<string>\"\n ],\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"extraHostnames\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.highseat.com/v1/sites/{site}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"timezone\": \"<string>\",\n \"thankYouPaths\": [\n \"<string>\"\n ],\n \"keptQueryParams\": [\n \"<string>\"\n ],\n \"excludedIps\": [\n \"<string>\"\n ],\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"extraHostnames\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highseat.com/v1/sites/{site}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"timezone\": \"<string>\",\n \"thankYouPaths\": [\n \"<string>\"\n ],\n \"keptQueryParams\": [\n \"<string>\"\n ],\n \"excludedIps\": [\n \"<string>\"\n ],\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"extraHostnames\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"timezone": "<string>",
"reportingCurrency": "<string>",
"revenueMode": "traffic",
"attributionModel": "last",
"attributionLookback": 0,
"thankYouPaths": [
"<string>"
],
"keptQueryParams": [
"<string>"
],
"excludedPaths": [
"<string>"
],
"extraHostnames": [
"<string>"
],
"proxyPath": "<string>",
"secretHint": "<string>",
"firstEventAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"excludedIps": [
"<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>"
}
]
}
}Sites
Update a site
Changes the settings sent and leaves the rest, as the dashboard does. A list sent replaces the whole list, and each setting says when it takes effect.
PATCH
/
sites
/
{site}
Update a site
curl --request PATCH \
--url https://api.highseat.com/v1/sites/{site} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"domain": "<string>",
"timezone": "<string>",
"thankYouPaths": [
"<string>"
],
"keptQueryParams": [
"<string>"
],
"excludedIps": [
"<string>"
],
"excludedPaths": [
"<string>"
],
"extraHostnames": [
"<string>"
]
}
'import requests
url = "https://api.highseat.com/v1/sites/{site}"
payload = {
"name": "<string>",
"domain": "<string>",
"timezone": "<string>",
"thankYouPaths": ["<string>"],
"keptQueryParams": ["<string>"],
"excludedIps": ["<string>"],
"excludedPaths": ["<string>"],
"extraHostnames": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
domain: '<string>',
timezone: '<string>',
thankYouPaths: ['<string>'],
keptQueryParams: ['<string>'],
excludedIps: ['<string>'],
excludedPaths: ['<string>'],
extraHostnames: ['<string>']
})
};
fetch('https://api.highseat.com/v1/sites/{site}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'domain' => '<string>',
'timezone' => '<string>',
'thankYouPaths' => [
'<string>'
],
'keptQueryParams' => [
'<string>'
],
'excludedIps' => [
'<string>'
],
'excludedPaths' => [
'<string>'
],
'extraHostnames' => [
'<string>'
]
]),
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}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"timezone\": \"<string>\",\n \"thankYouPaths\": [\n \"<string>\"\n ],\n \"keptQueryParams\": [\n \"<string>\"\n ],\n \"excludedIps\": [\n \"<string>\"\n ],\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"extraHostnames\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.highseat.com/v1/sites/{site}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"timezone\": \"<string>\",\n \"thankYouPaths\": [\n \"<string>\"\n ],\n \"keptQueryParams\": [\n \"<string>\"\n ],\n \"excludedIps\": [\n \"<string>\"\n ],\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"extraHostnames\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.highseat.com/v1/sites/{site}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"timezone\": \"<string>\",\n \"thankYouPaths\": [\n \"<string>\"\n ],\n \"keptQueryParams\": [\n \"<string>\"\n ],\n \"excludedIps\": [\n \"<string>\"\n ],\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"extraHostnames\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"timezone": "<string>",
"reportingCurrency": "<string>",
"revenueMode": "traffic",
"attributionModel": "last",
"attributionLookback": 0,
"thankYouPaths": [
"<string>"
],
"keptQueryParams": [
"<string>"
],
"excludedPaths": [
"<string>"
],
"extraHostnames": [
"<string>"
],
"proxyPath": "<string>",
"secretHint": "<string>",
"firstEventAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"excludedIps": [
"<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.
Path Parameters
The site: its domain as registered (example.com), or its site id.
Body
application/json
The site's name, as the dashboard shows it.
Required string length:
1 - 100The site's hostname, subdomains included. A domain another site of the workspace holds answers 409 DOMAIN_TAKEN.
Required string length:
3 - 253Pattern:
^((\*\.)|((?!-)[a-z0-9-]{0,63}[a-z0-9]\.))+[a-z]{2,63}$IANA timezone every day boundary falls in, such as Europe/Warsaw.
What the site's dashboard leads with: traffic, balanced or revenue. Display only: nothing stored and no figure of the API changes.
Available options:
traffic, balanced, revenue Which pageview before a sale takes its credit in revenue split by page, source or campaign: the last, the first, or every one equally (linear). Applied when a report runs, so a change re-credits every past sale.
Available options:
last, first, linear Days before a sale a pageview may lie and still earn credit: 7, 14, 30 or 90. Applied when a report runs, so a change re-credits every past sale.
Available options:
7, 14, 30, 90 Paths attribution never credits as a touch, * wildcards allowed: the page a checkout returns to. Applied when a report runs, so a change re-credits every past sale.
Maximum array length:
100Required string length:
1 - 500Pattern:
^\/.*Query parameter names ingest keeps on a page's URL, stripping every other one. A change reaches new events only.
Maximum array length:
50Required string length:
1 - 64Pattern:
^[A-Za-z0-9._~-]+$IP addresses and CIDR ranges whose events ingest drops. No visitor IP is stored, so a change reaches new events only.
Maximum array length:
100Required string length:
1 - 64Paths whose events ingest drops, * wildcards allowed. A change reaches new events only.
Maximum array length:
100Required string length:
1 - 500Pattern:
^\/.*Hostnames ingest counts besides the domain and its subdomains: an exact name, or *.example.com for that domain and its subdomains. A change reaches new events only.
Maximum array length:
20Required string length:
1 - 253Pattern:
^(?:\*\.)?(?:(?!-)[a-z0-9-]{0,62}[a-z0-9]\.)+[a-z]{2,63}$Response
OK
Show child attributes
Show child attributes