Claves de seguimiento

Gestiona las claves públicas que usa el script de seguimiento para enviar eventos desde tu sitio web.

URL basehttps://api.emailit.com/v2Autenticación Errores Límites de velocidad

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

Crear una clave de seguimiento

Crea una clave de seguimiento para el script de seguimiento. La respuesta incluye la key pública que va en la URL del script. Requiere una clave de API con el permiso full.

Las claves de seguimiento son públicas, así que cualquiera puede copiar una de tu página. Solo pueden enviar eventos de espacio de trabajo y personalizados, nunca leer datos, y puedes limitarlas a tus propios sitios con allowed_origins. Un espacio de trabajo puede tener hasta 25 claves de seguimiento.

El seguimiento de tu web está incluido en los planes Pro, Business y Custom. Las claves se conservan después de cambiar a Pay as you go, pero las peticiones del script de seguimiento con ellas devuelven 403.

POST/tracking-keys

Parámetros del cuerpo

namestringpor defecto: Website

Un nombre que indique dónde se usa la clave, como Online shop, de hasta 100 caracteres.

allowed_originsstring[]

Los sitios que pueden enviar eventos con la clave, hasta 50. Si está vacío o se omite, se admite cualquier sitio. Cada entrada es una de estas:

un origen, como https://shop.example.com: solo ese esquema, ese host y ese puerto;
un host, como shop.example.com: ese host con cualquier esquema o puerto;
un comodín, como *.example.com: example.com y todos sus subdominios.

Las entradas se guardan en minúsculas, sin barra final. También se acepta una cadena con las entradas separadas por espacios o comas.

enabledbooleanpor defecto: true

false crea la clave desactivada.

Devuelve

Devuelve 201 Created con el objeto de clave de seguimiento.

Código	Cuándo
`403`	La clave de API no tiene el permiso `full`, o el espacio de trabajo está en Pay as you go: `error` es `plan_required` y `required_plan` es `pro`.
`422`	Un campo no es válido, por ejemplo una entrada de `allowed_origins` que no es un origen, un host ni un comodín. `errors` usa el campo como clave y `message` repite el primer problema. También se devuelve con `code: "tracking_keys_limit"` cuando el espacio de trabajo ya tiene 25 claves de seguimiento.

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)"]
  }
}

Obtener una clave de seguimiento

Obtiene una clave de seguimiento. Las claves de seguimiento son claves públicas para el script de seguimiento: van en tus páginas web y solo pueden enviar eventos de espacio de trabajo y personalizados. Requiere una clave de API con el permiso full.

GET/tracking-keys/{id}

Parámetros de ruta

idstringobligatorio

El ID de la clave de seguimiento (trk_…) o la propia clave (pub_…).

Devuelve

Devuelve el objeto de clave de seguimiento.

objectstring

Siempre tracking_key.

idstring

El ID de la clave de seguimiento, con el prefijo trk_.

namestring

El nombre que indica dónde se usa la clave.

keystring

La clave pública: pub_ seguido de 32 letras y dígitos. Forma parte de la URL del script, así que se devuelve en cada lectura.

allowed_originsstring[]

Los sitios que pueden enviar eventos con esta clave. Si está vacío, se admite cualquier sitio. Consulta Sitios permitidos.

enabledboolean

false cuando la clave está desactivada. Los eventos enviados con una clave desactivada se rechazan.

last_used_atstring | null

Cuándo envió eventos la clave por última vez; se actualiza como máximo cada 10 minutos. null si no se ha usado nunca.

created_at, updated_atstring

Las marcas de tiempo en UTC.

Devuelve 404 con error: "Tracking key not found" si ninguna clave coincide.

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"
}

Actualizar una clave de seguimiento

Actualiza los campos que pasas y deja los demás sin cambios. La key pública no cambia nunca; para sustituir una clave, crea una nueva, actualiza tus páginas y elimina la anterior. Requiere una clave de API con el permiso full.

Los cambios pueden tardar hasta un minuto en aplicarse en todas partes.

POST/tracking-keys/{id}

Parámetros de ruta

idstringobligatorio

El ID de la clave de seguimiento (trk_…) o la propia clave (pub_…).

Parámetros del cuerpo

namestring

El nombre nuevo, de hasta 100 caracteres. No puede estar vacío.

allowed_originsstring[]

Sustituye la lista de sitios permitidos, con las mismas reglas que al crearla. [] admite cualquier sitio.

enabledboolean

false desactiva la clave: el script de seguimiento se sigue cargando, pero sus eventos se rechazan con 403. true vuelve a activarla.

Devuelve

Devuelve el objeto de clave de seguimiento actualizado.

Código	Cuándo
`404`	Ninguna clave de seguimiento coincide con `id`.
`422`	Un campo no es válido. `errors` usa el campo como clave y `message` repite el primer problema.

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"
}

Listar claves de seguimiento

Devuelve todas las claves de seguimiento del espacio de trabajo, de la más reciente a la más antigua. Un espacio de trabajo tiene como máximo 25, así que la lista no está paginada. Requiere una clave de API con el permiso full.

GET/tracking-keys

Parámetros de consulta

searchstring

Una búsqueda sin distinguir mayúsculas y minúsculas en una parte del nombre.

matchstring

all (por defecto) exige que se cumplan todos los filtros. or coincide con cualquier filtro. Consulta Filtrado.

orderstring

Clave de ordenación de esta lista. Consulta las claves de ordenación más abajo.

directionstring

asc o desc.

Claves de filtro

Los filtros usan parámetros de consulta key.condition=value, por ejemplo enabled.exact=true. Para las condiciones de cada tipo, consulta Filtrado y ordenación.

Clave	Tipo	Notas
`name`	string
`enabled`	boolean
`created_at`	date
`last_used_at`	date

Claves de orden para order: name, enabled, created_at, last_used_at. Por defecto, created_at, de la más reciente a la más antigua.

Devuelve

dataobject[]

Los objetos de clave de seguimiento, incluida la key pública de cada clave.

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"
    }
  ]
}

Eliminar una clave de seguimiento

Elimina una clave de seguimiento. Requiere una clave de API con el permiso full.

Las páginas que todavía cargan el script con esta clave siguen funcionando, pero sus eventos se rechazan y no se registran. Los eventos ya registrados con la clave se conservan. Si quieres detener los eventos durante un tiempo sin cambiar tus páginas, desactiva la clave con Actualizar una clave de seguimiento en lugar de eliminarla.

DELETE/tracking-keys/{id}

Parámetros de ruta

idstringobligatorio

El ID de la clave de seguimiento (trk_…) o la propia clave (pub_…).

Devuelve

objectstring

Siempre tracking_key.

idstring

El ID de la clave eliminada.

deletedboolean

Siempre true.

Devuelve 404 si ninguna clave de seguimiento coincide.

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
}