Sledovací klíče

Spravujte veřejné klíče, kterými sledovací skript odesílá události z vašeho webu.

Základní URLhttps://api.emailit.com/v2Autentizace Chyby Limity rychlosti

POST/tracking-keys
GET/tracking-keys/{id}
POST/tracking-keys/{id}
GET/tracking-keys
DEL/tracking-keys/{id}

Vytvoření sledovacího klíče

Vytvoří sledovací klíč pro sledovací skript. Odpověď obsahuje veřejný key, který patří do URL skriptu. Vyžaduje API klíč s oprávněním full.

Sledovací klíče jsou veřejné, takže si je kdokoli může zkopírovat z vaší stránky. Mohou jen odesílat události workspace a vlastní události, nikdy nečtou data a přes allowed_origins je můžete omezit na své vlastní weby. Workspace může mít až 25 sledovacích klíčů.

Sledování událostí na webu je součástí tarifů Pro, Business a Custom. Po přechodu na tarif Pay as you go klíče zůstanou, ale požadavky sledovacího skriptu s nimi vracejí 403.

POST/tracking-keys

Parametry v těle požadavku

namestringvýchozí: Website

Název, ze kterého je poznat, kde se klíč používá, například Online shop, nejvýše 100 znaků.

allowed_originsstring[]

Weby, které smějí s klíčem odesílat události, nejvýše 50. Prázdná hodnota nebo vynechání znamená jakýkoli web. Každá položka je jedna z těchto možností:

původ (origin), například https://shop.example.com: jen toto schéma, název hostitele a port;
název hostitele, například shop.example.com: tento název hostitele s jakýmkoli schématem nebo portem;
vzor se zástupným znakem, například *.example.com: example.com a všechny jeho subdomény.

Položky se ukládají malými písmeny a bez koncového lomítka. Přijímá se i řetězec s položkami oddělenými mezerami nebo čárkami.

enabledbooleanvýchozí: true

false vytvoří klíč vypnutý.

Odpověď

Vrací 201 Created s objektem sledovacího klíče.

Stavový kód	Kdy
`403`	API klíč nemá oprávnění `full`, nebo je workspace v tarifu Pay as you go: `error` má hodnotu `plan_required` a `required_plan` hodnotu `pro`.
`422`	Některé pole je neplatné, například položka v `allowed_origins`, která není původem, názvem hostitele ani vzorem se zástupným znakem. Klíči v `errors` jsou pole a `message` opakuje první problém. Vrací se také s `code: "tracking_keys_limit"`, když workspace už má 25 sledovacích klíčů.

POST/tracking-keys

Terminal

curl -X POST https://api.emailit.com/v2/tracking-keys \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Online shop",
    "allowed_origins": ["https://shop.example.com", "*.example.com"]
  }'

JavaScript

const res = await fetch('https://api.emailit.com/v2/tracking-keys', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.EMAILIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Online shop',
    allowed_origins: ['https://shop.example.com', '*.example.com'],
  }),
});
const trackingKey = await res.json();

Python

import os, requests

r = requests.post(
    "https://api.emailit.com/v2/tracking-keys",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
    json={
        "name": "Online shop",
        "allowed_origins": ["https://shop.example.com", "*.example.com"],
    },
)
tracking_key = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->post('tracking-keys', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
    'json' => [
        'name' => 'Online shop',
        'allowed_origins' => ['https://shop.example.com', '*.example.com'],
    ],
]);
$trackingKey = json_decode($response->getBody(), true);

JSON

{
  "object": "tracking_key",
  "id": "trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
  "name": "Online shop",
  "key": "pub_8fK2mQ9xLr4TzW7nB1cV5yH3dJ6sA0pE",
  "allowed_origins": ["https://shop.example.com", "*.example.com"],
  "enabled": true,
  "last_used_at": null,
  "created_at": "2026-10-19T08:05:00.000000+00:00",
  "updated_at": "2026-10-19T08:05:00.000000+00:00"
}

JSON

{
  "error": "plan_required",
  "required_plan": "pro",
  "message": "Website tracking is included with Pro and Business."
}

JSON

{
  "error": "allowed_origins \"https://shop.example.com/checkout\" is not an origin (https://example.com), a host (example.com) or a wildcard (*.example.com)",
  "message": "allowed_origins \"https://shop.example.com/checkout\" is not an origin (https://example.com), a host (example.com) or a wildcard (*.example.com)",
  "errors": {
    "allowed_origins": ["\"https://shop.example.com/checkout\" is not an origin (https://example.com), a host (example.com) or a wildcard (*.example.com)"]
  }
}

Načtení sledovacího klíče

Načte sledovací klíč. Sledovací klíče jsou veřejné klíče pro sledovací skript: vkládají se do vašich webových stránek a mohou jen odesílat události workspace a vlastní události. Vyžaduje API klíč s oprávněním full.

GET/tracking-keys/{id}

Parametry v cestě

idstringpovinné

ID sledovacího klíče (trk_…), nebo samotný klíč (pub_…).

Odpověď

Vrací objekt sledovacího klíče.

objectstring

Vždy tracking_key.

idstring

ID sledovacího klíče s předponou trk_.

namestring

Název, ze kterého je poznat, kde se klíč používá.

keystring

Veřejný klíč: pub_ a za ním 32 písmen a číslic. Je součástí URL skriptu, proto se vrací při každém načtení.

allowed_originsstring[]

Weby, které smějí s tímto klíčem odesílat události. Prázdný seznam znamená jakýkoli web. Viz Povolené weby.

enabledboolean

false, když je klíč vypnutý. Události odeslané s vypnutým klíčem se odmítnou.

last_used_atstring | null

Kdy klíč naposledy odeslal události, aktualizuje se nejvýše jednou za 10 minut. null, pokud ještě nebyl použit.

created_at, updated_atstring

Časová razítka v UTC.

Pokud žádný klíč neodpovídá, vrací 404 s error: "Tracking key not found".

GET/tracking-keys/{id}

Terminal

curl https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JavaScript

const res = await fetch('https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6', {
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}` },
});
const trackingKey = await res.json();

Python

import os, requests

r = requests.get(
    "https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
)
tracking_key = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->get('tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
]);
$trackingKey = json_decode($response->getBody(), true);

JSON

{
  "object": "tracking_key",
  "id": "trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
  "name": "Online shop",
  "key": "pub_8fK2mQ9xLr4TzW7nB1cV5yH3dJ6sA0pE",
  "allowed_origins": ["https://shop.example.com", "*.example.com"],
  "enabled": true,
  "last_used_at": "2026-10-19T09:40:00.000000+00:00",
  "created_at": "2026-10-19T08:05:00.000000+00:00",
  "updated_at": "2026-10-19T08:05:00.000000+00:00"
}

JSON

{
  "error": "Tracking key not found"
}

Úprava sledovacího klíče

Upraví pole, která předáte, a ostatní ponechá beze změny. Veřejný key se nikdy nemění; pokud chcete klíč vyměnit, vytvořte nový, upravte své stránky a starý smažte. Vyžaduje API klíč s oprávněním full.

Než se změny projeví všude, může to trvat až minutu.

POST/tracking-keys/{id}

Parametry v cestě

idstringpovinné

ID sledovacího klíče (trk_…), nebo samotný klíč (pub_…).

Parametry v těle požadavku

namestring

Nový název, nejvýše 100 znaků. Nesmí být prázdný.

allowed_originsstring[]

Nahradí seznam povolených webů, se stejnými pravidly jako při vytvoření. [] povolí jakýkoli web.

enabledboolean

false klíč vypne: sledovací skript se dál načítá, ale jeho události se odmítají s 403. true klíč znovu zapne.

Odpověď

Vrací upravený objekt sledovacího klíče.

Stavový kód	Kdy
`404`	Žádný sledovací klíč neodpovídá `id`.
`422`	Některé pole je neplatné. Klíči v `errors` jsou pole a `message` opakuje první problém.

POST/tracking-keys/{id}

Terminal

curl -X POST https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6 \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "allowed_origins": ["https://shop.example.com", "https://www.example.com"] }'

JavaScript

const res = await fetch('https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.EMAILIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ allowed_origins: ['https://shop.example.com', 'https://www.example.com'] }),
});
const trackingKey = await res.json();

Python

import os, requests

r = requests.post(
    "https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
    json={"allowed_origins": ["https://shop.example.com", "https://www.example.com"]},
)
tracking_key = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->post('tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
    'json' => ['allowed_origins' => ['https://shop.example.com', 'https://www.example.com']],
]);
$trackingKey = json_decode($response->getBody(), true);

JSON

{
  "object": "tracking_key",
  "id": "trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
  "name": "Online shop",
  "key": "pub_8fK2mQ9xLr4TzW7nB1cV5yH3dJ6sA0pE",
  "allowed_origins": ["https://shop.example.com", "https://www.example.com"],
  "enabled": true,
  "last_used_at": "2026-10-19T09:40:00.000000+00:00",
  "created_at": "2026-10-19T08:05:00.000000+00:00",
  "updated_at": "2026-10-19T10:20:00.000000+00:00"
}

Výpis sledovacích klíčů

Vrací všechny sledovací klíče workspace od nejnovějšího. Workspace jich má nejvýše 25, proto se výpis nestránkuje. Vyžaduje API klíč s oprávněním full.

GET/tracking-keys

Parametry dotazu

searchstring

Hledá část názvu bez ohledu na velikost písmen.

matchstring

Hodnota all (výchozí) vyžaduje shodu se všemi filtry. S hodnotou or stačí shoda s kterýmkoli filtrem. Viz Filtrování.

orderstring

Klíč řazení pro tento výpis. Viz klíče řazení níže.

directionstring

asc, nebo desc.

Klíče filtrů

Filtry se zadávají parametry dotazu ve tvaru key.condition=value, například enabled.exact=true. Podmínky pro jednotlivé typy najdete na stránce Filtrování.

Klíč	Typ	Poznámky
`name`	string
`enabled`	boolean
`created_at`	date
`last_used_at`	date

Klíče řazení pro order: name, enabled, created_at, last_used_at. Ve výchozím stavu se řadí podle created_at od nejnovějšího.

Odpověď

dataobject[]

Objekty sledovacích klíčů včetně veřejného key každého z nich.

GET/tracking-keys

Terminal

curl https://api.emailit.com/v2/tracking-keys \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JavaScript

const res = await fetch('https://api.emailit.com/v2/tracking-keys', {
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}` },
});
const { data } = await res.json();

Python

import os, requests

r = requests.get(
    "https://api.emailit.com/v2/tracking-keys",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
)
tracking_keys = r.json()["data"]

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->get('tracking-keys', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
]);
$trackingKeys = json_decode($response->getBody(), true)['data'];

JSON

{
  "data": [
    {
      "object": "tracking_key",
      "id": "trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
      "name": "Online shop",
      "key": "pub_8fK2mQ9xLr4TzW7nB1cV5yH3dJ6sA0pE",
      "allowed_origins": ["https://shop.example.com", "*.example.com"],
      "enabled": true,
      "last_used_at": "2026-10-19T09:40:00.000000+00:00",
      "created_at": "2026-10-19T08:05:00.000000+00:00",
      "updated_at": "2026-10-19T08:05:00.000000+00:00"
    }
  ]
}

Smazání sledovacího klíče

Smaže sledovací klíč. Vyžaduje API klíč s oprávněním full.

Stránky, které skript s tímto klíčem stále načítají, dál fungují, ale jejich události se odmítnou a nezaznamenají. Události, které se s klíčem už zaznamenaly, zůstanou. Pokud chcete události na čas zastavit bez úprav stránek, vypněte místo toho klíč endpointem Úprava sledovacího klíče.

DELETE/tracking-keys/{id}

Parametry v cestě

idstringpovinné

ID sledovacího klíče (trk_…), nebo samotný klíč (pub_…).

Odpověď

objectstring

Vždy tracking_key.

idstring

ID smazaného klíče.

deletedboolean

Vždy true.

Pokud žádný sledovací klíč neodpovídá, vrací 404.

DELETE/tracking-keys/{id}

Terminal

curl -X DELETE https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6 \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JavaScript

const res = await fetch('https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6', {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}` },
});
const result = await res.json();

Python

import os, requests

r = requests.delete(
    "https://api.emailit.com/v2/tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
)
result = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->delete('tracking-keys/trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
]);
$result = json_decode($response->getBody(), true);

JSON

{
  "object": "tracking_key",
  "id": "trk_2yHn5Pq2WcR7tY4uNs8KdV1bXj6",
  "deleted": true
}