Update a pixel (pause, activate, or set path filters)
curl --request PATCH \
--url https://api.aws53.cloud/v1/data/pixels/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "paused",
"excludedPaths": [
"/blog",
"/careers"
],
"includedPaths": [
"/pricing",
"/demo"
]
}
'import requests
url = "https://api.aws53.cloud/v1/data/pixels/{id}"
payload = {
"status": "paused",
"excludedPaths": ["/blog", "/careers"],
"includedPaths": ["/pricing", "/demo"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'paused',
excludedPaths: ['/blog', '/careers'],
includedPaths: ['/pricing', '/demo']
})
};
fetch('https://api.aws53.cloud/v1/data/pixels/{id}', 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.aws53.cloud/v1/data/pixels/{id}",
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([
'status' => 'paused',
'excludedPaths' => [
'/blog',
'/careers'
],
'includedPaths' => [
'/pricing',
'/demo'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.aws53.cloud/v1/data/pixels/{id}"
payload := strings.NewReader("{\n \"status\": \"paused\",\n \"excludedPaths\": [\n \"/blog\",\n \"/careers\"\n ],\n \"includedPaths\": [\n \"/pricing\",\n \"/demo\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.aws53.cloud/v1/data/pixels/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"paused\",\n \"excludedPaths\": [\n \"/blog\",\n \"/careers\"\n ],\n \"includedPaths\": [\n \"/pricing\",\n \"/demo\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/data/pixels/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"paused\",\n \"excludedPaths\": [\n \"/blog\",\n \"/careers\"\n ],\n \"includedPaths\": [\n \"/pricing\",\n \"/demo\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"status": "<string>",
"excludedPaths": [
"<string>"
],
"includedPaths": [
"<string>"
],
"updatedAt": "<string>"
}
}Pixels
Update a pixel (pause, activate, or set path filters)
Updates a pixel. Accepts status, excludedPaths, includedPaths, or any combination. Set paths to null to clear. Mutually exclusive: cannot have both includedPaths and excludedPaths set. Authenticates via X-API-Key header.
PATCH
/
v1
/
data
/
pixels
/
{id}
Update a pixel (pause, activate, or set path filters)
curl --request PATCH \
--url https://api.aws53.cloud/v1/data/pixels/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "paused",
"excludedPaths": [
"/blog",
"/careers"
],
"includedPaths": [
"/pricing",
"/demo"
]
}
'import requests
url = "https://api.aws53.cloud/v1/data/pixels/{id}"
payload = {
"status": "paused",
"excludedPaths": ["/blog", "/careers"],
"includedPaths": ["/pricing", "/demo"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'paused',
excludedPaths: ['/blog', '/careers'],
includedPaths: ['/pricing', '/demo']
})
};
fetch('https://api.aws53.cloud/v1/data/pixels/{id}', 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.aws53.cloud/v1/data/pixels/{id}",
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([
'status' => 'paused',
'excludedPaths' => [
'/blog',
'/careers'
],
'includedPaths' => [
'/pricing',
'/demo'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.aws53.cloud/v1/data/pixels/{id}"
payload := strings.NewReader("{\n \"status\": \"paused\",\n \"excludedPaths\": [\n \"/blog\",\n \"/careers\"\n ],\n \"includedPaths\": [\n \"/pricing\",\n \"/demo\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.aws53.cloud/v1/data/pixels/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"paused\",\n \"excludedPaths\": [\n \"/blog\",\n \"/careers\"\n ],\n \"includedPaths\": [\n \"/pricing\",\n \"/demo\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/data/pixels/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"paused\",\n \"excludedPaths\": [\n \"/blog\",\n \"/careers\"\n ],\n \"includedPaths\": [\n \"/pricing\",\n \"/demo\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"status": "<string>",
"excludedPaths": [
"<string>"
],
"includedPaths": [
"<string>"
],
"updatedAt": "<string>"
}
}Authorizations
Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.
Path Parameters
Body
application/json
Available options:
active, paused Example:
"paused"
Denylist: URL path prefixes where tracking is skipped. Mutually exclusive with includedPaths.
Maximum array length:
50Required string length:
2 - 500Pattern:
^\/Example:
["/blog", "/careers"]
Allowlist: if set, tracking fires ONLY on matching path prefixes. Mutually exclusive with excludedPaths.
Maximum array length:
50Required string length:
2 - 500Pattern:
^\/Example:
["/pricing", "/demo"]
Response
Pixel updated
Show child attributes
Show child attributes
Was this page helpful?
⌘I