API REST
Construa sobre seus links.

Identidade, espaço de trabalho, plano e todos os direitos que esse plano inclui. A forma mais barata de verificar um token e descobrir o que a conta pode fazer antes de tentar.

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

Quanto de cada cota foi consumido neste mês de cobrança. Use para avisar um cliente antes que ele atinja o teto de cliques rastreados — depois disso o redirecionamento continua funcionando, mas os cliques deixam de ser registrados.

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

Domínios personalizados do espaço de trabalho e se cada um já concluiu a verificação de DNS. Só domínios verificados podem ser usados no campo domain ao criar um link.

Todas as integrações que o produto oferece, se o seu plano as inclui, se este espaço de trabalho as conectou e como está a entrega — último status, último erro e número de falhas consecutivas. Útil para monitorar vários espaços de trabalho.

Links do espaço de trabalho, com totais de cliques divididos em all, ios, android e desktop. Links sem cliques também são incluídos.

Parâmetros de consulta

• domain string

  Limita a um nome de host. Omita para listar todos os nomes de host do espaço de trabalho.

  Opcional
• search string

  Busca no código curto, título e destino.

  Opcional
• type string

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

  Opcional
• archived boolean

  O padrão é false. Passe true para listar o arquivo.

  Opcional
• favorite boolean

  Limita aos links marcados com estrela.

  Opcional
• sort string

  created_at (padrão), clicks, short_code, title ou updated_at.

  Opcional
• direction string

  asc ou desc. O padrão é desc.

  Opcional
• limit integer

  1–200. O padrão é 50.

  Opcional
• offset integer

  O padrão é 0.

  Opcional
• start_date date

  YYYY-MM-DD. Delimita os totais de cliques, não quais links são retornados.

  Opcional
• end_date date

  YYYY-MM-DD, inclusivo.

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

Um link pelo id, no mesmo formato que o endpoint de listagem retorna.

Cria um link curto. Omita short_code para gerar um aleatório. Se o destino não tiver title, buscamos o título da página em segundo plano.

Corpo JSON

• destination

  A URL para a qual redirecionar. Obrigatória para links direct e utm. original_url é aceito como alias.

  Obrigatório*
• short_code

  Até 20 caracteres: letras, números, hifens e sublinhados, sem começar nem terminar com separador. Deve ser único por nome de host.

  Opcional
• title

  Nome de exibição no painel.

  Opcional
• domain

  Um domínio personalizado verificado ou o domínio base. O padrão é o domínio base.

  Opcional
• type

  direct (padrão), utm, appstore, instagram, mobile ou device. Todos, exceto direct e utm, exigem o plano Solo, Growth ou Ultimate.

  Opcional
• utm_source, utm_medium, utm_campaign

  Para links utm; utm_source é obrigatório quando type é utm.

  Opcional
• ios_url, android_url

  Destinos por plataforma para links appstore e mobile.

  Opcional
• desktop_url, mobile_url

  Ambas obrigatórias para links device.

  Opcional
• instagram_username

  Para links instagram.

  Opcional
• split_variations

  Um array de objetos {name, url, weight} — pelo menos dois — para executar um teste A/B ponderado em um link direct ou utm.

  Opcional
• limit_visits_per_device

  Defina true e informe visit_limit_per_device para limitar as 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.

Crie vários links em uma única requisição. Cada linha é processada de forma independente: as válidas são criadas e as falhas são informadas por índice, então uma URL ruim nunca descarta o restante do lote. Retorna 201 quando algo foi criado e 422 quando nada foi.

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 mescla: só os campos enviados são alterados, todo o resto mantém o valor atual. PUT substitui: tudo o que você omitir é apagado. Aceita os mesmos campos da criação.

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

Arquiva o link: ele deixa de funcionar e libera uma vaga na cota, enquanto o histórico de cliques é mantido. Propositalmente, não há exclusão permanente na API — destruir um link e seu histórico continua sendo uma ação do painel, com confirmação explícita.

Traz um link arquivado de volta à ativa. Retorna 403 plan_required se o espaço de trabalho já estiver no limite de links ativos.

Visitas individuais a um link, das mais recentes para as mais antigas. Aceita limit e offset. O país está incluído em todos os planos.

Os números principais de todo o espaço de trabalho: cliques desde o início e no período, visitantes únicos, leituras de QR, dia de pico e distribuições por hora do dia e dia da semana. Aceita days (padrão 30, limitado à sua retenção).

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

Contagem diária de cliques, pronta para gráficos. Passe link_id para limitar a um link e days para definir o período. Dias sem tráfego são retornados como zero em vez de omitidos, então a série é sempre contínua.

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

Cliques agrupados por uma dimensão, com a participação de cada linha no total.

Parâmetros de consulta

• dimension string

  channel, referrer, device, browser, os, brand, variation ou country. browser, os, brand e variation exigem um link_id.

  Obrigatório
• link_id integer

  Limita a um link. Omita para todo o espaço de trabalho.

  Opcional
• limit integer

  1–100. O padrão é 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 }
}

Tudo o que o painel mostra para um link em uma única chamada: o próprio link, totais de cliques, visitantes únicos e recorrentes, a série diária, distribuições por hora e dia da semana, todos os detalhamentos e o placar do teste A/B quando o link tiver um.

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

O feed bruto de visitas de todos os links do espaço de trabalho, das mais recentes para as mais antigas. É o substituto moderno de GET /visits: os mesmos dados, envelope padrão e suporte a limit e 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 nesta conta.

Registre um endpoint HTTPS para receber um payload JSON a cada clique registrado. Até 25 por conta. Entregas que falham são repetidas automaticamente.

Corpo JSON

• target_url

  Deve ser https://.

  Obrigatório
• event

  O padrão é link_visited, que atualmente é o ú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"}'

Remove um endpoint de webhook. POST /hooks/subscribe e DELETE /hooks/unsubscribe/{id} continuam disponíveis para o fluxo de REST Hooks do Zapier.

O teste de conexão original: retorna seu id de usuário, e-mail e id/nome do espaço de trabalho como um objeto plano. GET /me retorna a mesma identidade mais os limites do seu plano e os recursos disponíveis, e é a melhor escolha para código novo.

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

Totais de cliques de um único link, identificado por domain e slug em vez do id. Os dois parâmetros são obrigatórios. GET /links/{id} e GET /analytics/links/{id} cobrem o mesmo quando você sabe o id.

Parâmetros de consulta

• domain string

  O domínio base ou um dos seus domínios personalizados verificados.

  Obrigatório
• slug string

  O código curto, sem barra inicial.

  Obrigatório
• start_date date

  YYYY-MM-DD, limitado à retenção do seu plano.

  Opcional
• end_date date

  YYYY-MM-DD, inclusivo.

  Opcional

As 50 visitas mais recentes em todo o espaço de trabalho, como um array JSON puro — sem envelope —, usando os nomes de campo visit_id, visit_time, link_shortcode e visitor_*. É isso que a etapa "perform list" do REST Hook do Zapier lê, então o formato está congelado. Use GET /events para novos desenvolvimentos.

As 50 visitas mais recentes a um link, como um array puro com created_at, ip_address, country, device_type, browser, os e referrer. Congelado junto com /visits; use GET /links/{id}/events para novos desenvolvimentos.

Assinatura de REST Hook. Recebe target_url e um event opcional (padrão link_visited) e retorna a assinatura criada de forma plana, sem envelope. POST /hooks é a mesma operação no formato padrão.

Cancelamento de REST Hook, retornando {"success": true}. DELETE /hooks/{id} é o equivalente no formato padrão.