Skip to main content
POST
/
v1
/
data
/
pixels
Create a pixel for a domain
curl --request POST \
  --url https://api.aws53.cloud/v1/data/pixels \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "domain": "www.example.com",
  "name": "Example Pixel",
  "excludedPaths": [
    "/blog",
    "/careers"
  ],
  "includedPaths": [
    "/pricing",
    "/demo"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain": "<string>",
    "name": "<string>",
    "status": "<string>",
    "excludedPaths": [
      "<string>"
    ],
    "includedPaths": [
      "<string>"
    ],
    "code": "<string>",
    "createdAt": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.

Body

application/json
​
domain
string
required
Required string length: 1 - 255
Example:

"www.example.com"

​
name
string
Required string length: 1 - 255
Example:

"Example Pixel"

​
excludedPaths
string[] | null

Denylist: URL path prefixes where tracking is skipped. Mutually exclusive with includedPaths.

Maximum array length: 50
Required string length: 2 - 500
Pattern: ^\/
Example:
["/blog", "/careers"]
​
includedPaths
string[] | null

Allowlist: if set, tracking fires ONLY on matching path prefixes. Mutually exclusive with excludedPaths.

Maximum array length: 50
Required string length: 2 - 500
Pattern: ^\/
Example:
["/pricing", "/demo"]

Response

Pixel created

​
data
object
required