API REST
Construye sobre tus enlaces.

Identidad, espacio de trabajo, plan y todos los derechos que incluye ese plan. La forma más económica de verificar un token y descubrir qué puede hacer la cuenta antes de intentarlo.

curl -H "X-API-KEY: YOUR_TOKEN" \
  https://letl.ink/api/v1/me

{
  "data": {
    "user": { "id": 1, "email": "[email protected]", "name": "You" },
    "workspace": { "id": 12, "name": "My Workspace", "block_bots": true },
    "plan": {
      "id": "growth",
      "name": "Growth",
      "limits": {
        "links": 200,
        "monthly_clicks": 100000,
        "custom_domains": 3,
        "qr_codes": 30,
        "retention_days": 365
      },
      "features": {
        "api": true,
        "webhooks": true,
        "integrations": true,
        "ai_access": false,
        "geo_analytics": false,
        "smart_link_types": true
      }
    },
    "base_domain": "letl.ink"
  }
}

Cuánto se ha consumido de cada cuota en este mes de facturación. Úsalo para avisar a un cliente antes de que alcance el límite de clics registrados: al superarlo, la redirección sigue funcionando, pero los clics dejan de registrarse.

{
  "data": {
    "links": { "used": 42, "limit": 200, "remaining": 158, "percent_used": 21.0 },
    "clicks_this_month": { "used": 8140, "limit": 100000, "remaining": 91860, "percent_used": 8.1 },
    "custom_domains": { "used": 1, "limit": 3, "remaining": 2, "percent_used": 33.3 },
    "qr_codes": { "used": 4, "limit": 30, "remaining": 26, "percent_used": 13.3 }
  },
  "meta": { "plan": "growth", "period": "2026-09" }
}

Los dominios personalizados del espacio de trabajo y si cada uno terminó la verificación DNS. Solo los dominios verificados se pueden usar en el campo domain al crear un enlace.

Todas las integraciones que ofrece el producto, si tu plan la incluye, si este espacio de trabajo la conectó y cómo van las entregas: último estado, último error y número de fallos consecutivos. Útil para supervisar muchos espacios de trabajo.

Enlaces del espacio de trabajo, con los totales de clics divididos en all, ios, android y desktop. Se incluyen los enlaces sin clics.

Parámetros de consulta

• domain string

  Limita a un nombre de host. Omítelo para listar todos los nombres de host del espacio de trabajo.

  Opcional
• search string

  Busca en el código corto, el título y el destino.

  Opcional
• type string

  direct, utm, appstore, instagram, mobile o device.

  Opcional
• archived boolean

  Por defecto, false. Pasa true para listar el archivo.

  Opcional
• favorite boolean

  Limita a los enlaces destacados.

  Opcional
• sort string

  created_at (predeterminado), clicks, short_code, title o updated_at.

  Opcional
• direction string

  asc o desc. Por defecto, desc.

  Opcional
• limit integer

  1–200. Por defecto, 50.

  Opcional
• offset integer

  Por defecto, 0.

  Opcional
• start_date date

  YYYY-MM-DD. Delimita los totales de clics, no qué enlaces se devuelven.

  Opcional
• end_date date

  YYYY-MM-DD, inclusive.

  Opcional

curl -H "X-API-KEY: YOUR_TOKEN" \
  "https://letl.ink/api/v1/links?sort=clicks&limit=20"

{
  "data": [
    {
      "id": 49,
      "short_code": "spring",
      "domain": "letl.ink",
      "url": "https://letl.ink/spring",
      "destination": "https://shop.example.com/spring",
      "title": "Spring sale",
      "type": "utm",
      "archived": false,
      "favorite": true,
      "created_at": "2026-08-01T09:14:00+00:00",
      "updated_at": "2026-09-02T11:00:00+00:00",
      "clicks": { "all": 650, "ios": 180, "android": 210, "desktop": 260 },
      "total_clicks": 650,
      "device_limit": null,
      "utm": { "source": "twitter", "medium": "social", "campaign": "spring" },
      "split_test": {
        "variations": [
          { "name": "control", "url": "https://example.com/a", "weight": 2 },
          { "name": "variant-b", "url": "https://example.com/b", "weight": 1 }
        ]
      }
    }
  ],
  "meta": {
    "total": 42, "limit": 20, "offset": 0,
    "has_more": true, "next_offset": 20,
    "sort": "clicks", "direction": "desc",
    "date_range": { "start_date": null, "end_date": null },
    "domain": "all"
  }
}

Un enlace por id, con la misma estructura que devuelve el endpoint de lista.

Crea un enlace corto. Omite short_code para obtener uno aleatorio. Si el destino no tiene title, obtenemos el título de la página en segundo plano.

Cuerpo JSON

• destination

  La URL a la que redirigir. Obligatoria para enlaces direct y utm. También se acepta original_url como alias.

  Obligatorio*
• short_code

  Hasta 20 caracteres: letras, números, guiones y guiones bajos, sin empezar ni terminar con un separador. Debe ser único en cada nombre de host.

  Opcional
• title

  Nombre visible en el panel.

  Opcional
• domain

  Un dominio personalizado verificado o el dominio base. Por defecto, el dominio base.

  Opcional
• type

  direct (predeterminado), utm, appstore, instagram, mobile o device. Todos excepto direct y utm requieren el plan Solo, Growth o Ultimate.

  Opcional
• utm_source, utm_medium, utm_campaign

  Para enlaces utm; utm_source es obligatorio cuando type es utm.

  Opcional
• ios_url, android_url

  Destinos por plataforma para enlaces appstore y mobile.

  Opcional
• desktop_url, mobile_url

  Ambos obligatorios para enlaces device.

  Opcional
• instagram_username

  Para enlaces instagram.

  Opcional
• split_variations

  Un array de objetos {name, url, weight} —al menos dos— para ejecutar una prueba A/B ponderada en un enlace direct o utm.

  Opcional
• limit_visits_per_device

  Configúralo como true e indica visit_limit_per_device para limitar las visitas por hora de cada dispositivo.

  Opcional

curl -X POST https://letl.ink/api/v1/links \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "destination": "https://shop.example.com/spring",
        "short_code": "spring",
        "title": "Spring sale",
        "type": "utm",
        "utm_source": "twitter",
        "utm_campaign": "spring"
      }'

The created link, in the shape shown above.

Crea muchos enlaces en una sola solicitud. Cada fila se procesa de forma independiente: las filas válidas se crean y los errores se indican por índice, así que una URL incorrecta nunca descarta el resto del lote. Devuelve 201 si se creó algo y 422 si no se creó nada.

curl -X POST https://letl.ink/api/v1/links/bulk \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"links":[
        {"destination":"https://example.com/1","short_code":"one"},
        {"destination":"https://example.com/2"}
      ]}'

{
  "data": [ { "id": 51, "short_code": "one", … } ],
  "meta": {
    "requested": 2,
    "created": 1,
    "failed": 1,
    "errors": [
      { "index": 1,
        "code": "invalid_request",
        "message": "This shortcode is already taken.",
        "short_code": "two" }
    ]
  }
}

PATCH combina: solo cambian los campos que envías y todo lo demás conserva su valor actual. PUT reemplaza: se borra todo lo que omitas. Acepta los mismos campos que la creación.

curl -X PATCH https://letl.ink/api/v1/links/49 \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Spring sale — extended"}'

Archiva el enlace: deja de resolverse y libera un espacio de tu cuota, mientras que su historial de clics se conserva. Deliberadamente, la API no permite eliminar de forma permanente: destruir un enlace y su historial sigue siendo una acción del panel que requiere una confirmación explícita.

Vuelve a poner en circulación un enlace archivado. Devuelve 403 plan_required si el espacio de trabajo ya alcanzó su cuota de enlaces activos.

Visitas individuales a un enlace, de la más reciente a la más antigua. Acepta limit y offset. El país se incluye en todos los planes.

Las cifras principales de todo el espacio de trabajo: clics totales y en el periodo, visitantes únicos, escaneos QR, día pico y distribuciones por hora del día y día de la semana. Acepta days (30 por defecto, ajustado a tu retención).

{
  "data": {
    "window_days": 30,
    "clicks": {
      "total": 24592, "window": 8140, "last_7_days": 2103,
      "daily_average": 271,
      "peak_day": { "date": "Sep 02", "clicks": 612 }
    },
    "visitors": { "unique_total": 18204, "unique_window": 6021 },
    "qr": { "scans_total": 940, "scans_window": 310 },
    "timing": {
      "by_hour": [12, 4, 2, …],
      "by_weekday": [1420, 1610, 1585, 1490, 1310, 480, 245],
      "peak_hour": { "peakHour": 14, "peakValue": 812, "label": "14:00–14:59" },
      "peak_weekday": { "peakDay": 1, "peakValue": 1610, "label": "Tuesday" }
    },
    "links": { "active": 42, "limit": 200 }
  },
  "meta": { "plan": "growth", "geo_included": true, "retention_days": 365 }
}

Número de clics diarios, listos para graficar. Pasa link_id para limitarlo a un enlace y days para definir el periodo. Los días sin tráfico se devuelven como cero en lugar de omitirse, así que la serie siempre es continua.

{
  "data": [
    { "date": "Sep 04", "clicks": 22 },
    { "date": "Sep 05", "clicks": 11 }
  ],
  "meta": { "window_days": 7, "total": 33, "link_id": null }
}

Clics agrupados por una dimensión, con la proporción del total de cada fila.

Parámetros de consulta

• dimension string

  channel, referrer, device, browser, os, brand, variation o country. browser, os, brand y variation requieren un link_id.

  Obligatorio
• link_id integer

  Limita a un enlace. Omítelo para todo el espacio de trabajo.

  Opcional
• limit integer

  1–100. Por defecto, 10.

  Opcional

{
  "data": [
    { "label": "Search", "value": 215, "share": 33.1 },
    { "label": "Social", "value": 201, "share": 30.9 },
    { "label": "Direct / none", "value": 142, "share": 21.8 }
  ],
  "meta": { "dimension": "channel", "link_id": 49, "total": 650 }
}

Todo lo que muestra el panel para un enlace en una sola llamada: el enlace, los totales de clics, los visitantes únicos y recurrentes, la serie diaria, las distribuciones por hora y día de la semana, todos los desgloses y el marcador de la prueba A/B cuando el enlace tiene una en curso.

"split_test": {
  "active": true,
  "conclusive": true,
  "minClicks": 100,
  "leader": "control",
  "totalClicks": 650,
  "totalVisitors": 172,
  "arms": [
    { "name": "control", "isControl": true, "weight": 2,
      "clicks": 357, "visitors": 60,
      "expectedShare": 50.0, "actualShare": 54.9, "drift": 4.9 },
    { "name": "variant-b", "isControl": false, "weight": 1,
      "clicks": 146, "visitors": 57,
      "expectedShare": 25.0, "actualShare": 22.5, "drift": -2.5 }
  ]
}

El flujo de visitas en bruto de todos los enlaces del espacio de trabajo, de la más reciente a la más antigua. Es el reemplazo moderno de GET /visits: los mismos datos, el envoltorio estándar y compatibilidad con limit y offset.

{
  "data": [
    {
      "id": 2691,
      "link_id": 49,
      "short_code": "spring",
      "occurred_at": "2026-09-10T22:45:33+00:00",
      "ip_address": "203.0.113.7",
      "referrer": "https://twitter.com/",
      "browser": "Chrome",
      "os": "iOS",
      "device_type": "mobile",
      "device_brand": "Apple",
      "country": "US",
      "variation": "control"
    }
  ],
  "meta": { "limit": 50, "returned": 50, "geo_included": true }
}

Endpoints de webhook registrados en esta cuenta.

Registra un endpoint HTTPS para recibir un payload JSON con cada clic registrado. Hasta 25 por cuenta. Las entregas fallidas se reintentan automáticamente.

Cuerpo JSON

• target_url

  Debe ser https://.

  Obligatorio
• event

  Por defecto, link_visited, que actualmente es el único evento.

  Opcional

curl -X POST https://letl.ink/api/v1/hooks \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target_url": "https://example.com/hooks/clicks"}'

Elimina un endpoint de webhook. POST /hooks/subscribe y DELETE /hooks/unsubscribe/{id} siguen disponibles para el flujo de REST Hooks de Zapier.

La prueba de conexión original: devuelve tu id de usuario, correo y el id/nombre del espacio de trabajo como un objeto plano. GET /me devuelve la misma identidad más los límites de tu plan y los indicadores de funciones, y es la mejor opción para código nuevo.

curl -H "X-API-KEY: YOUR_TOKEN" \
  https://letl.ink/api/v1/auth/me

{
  "id": 1,
  "email": "[email protected]",
  "workspace_id": 12,
  "workspace_name": "My Workspace"
}

Totales de clics de un solo enlace, identificado por domain y slug en lugar de por id. Ambos parámetros son obligatorios. GET /links/{id} y GET /analytics/links/{id} ofrecen lo mismo cuando conoces el id.

Parámetros de consulta

• domain string

  El dominio base o uno de tus dominios personalizados verificados.

  Obligatorio
• slug string

  El código corto, sin barra inicial.

  Obligatorio
• start_date date

  YYYY-MM-DD, ajustado a la retención de tu plan.

  Opcional
• end_date date

  YYYY-MM-DD, inclusive.

  Opcional

Las 50 visitas más recientes de todo el espacio de trabajo como un array JSON sin envoltorio, con los nombres de campo visit_id, visit_time, link_shortcode y visitor_*. Es lo que lee el paso "perform list" de los REST Hooks de Zapier, así que su estructura está congelada. Usa GET /events para desarrollos nuevos.

Las 50 visitas más recientes de un enlace, como un array sin envoltorio con created_at, ip_address, country, device_type, browser, os y referrer. Está congelado junto con /visits; usa GET /links/{id}/events para desarrollos nuevos.

Suscripción de REST Hook. Recibe target_url y un event opcional (por defecto link_visited) y devuelve la suscripción creada tal cual, sin envoltorio. POST /hooks es la misma operación con la estructura estándar.

Cancelación de la suscripción de REST Hook, que devuelve {"success": true}. DELETE /hooks/{id} es el equivalente con la estructura estándar.