REST API
Bau auf deinen Links auf.

Identität, Workspace, Tarif und alle Berechtigungen, die dieser Tarif mitbringt. Der einfachste Weg, ein Token zu prüfen und herauszufinden, was das Konto darf, bevor du es versuchst.

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

Wie viel von jedem Kontingent in diesem Abrechnungsmonat verbraucht ist. Nutze das, um Kunden zu warnen, bevor sie die Grenze für erfasste Klicks erreichen — danach funktioniert die Weiterleitung weiter, aber Klicks werden nicht mehr erfasst.

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

Eigene Domains im Workspace und ob jede davon die DNS-Verifizierung abgeschlossen hat. Nur verifizierte Domains dürfen beim Erstellen eines Links als Feld domain verwendet werden.

Alle Integrationen, die das Produkt bietet, ob dein Tarif sie enthält, ob dieser Workspace sie verbunden hat und wie die Zustellung läuft – letzter Status, letzter Fehler und Anzahl aufeinanderfolgender Fehlschläge. Nützlich zur Überwachung vieler Workspaces.

Links im Workspace mit Klicksummen aufgeteilt in all, ios, android und desktop. Links ohne Klicks sind enthalten.

Query-Parameter

• domain string

  Auf einen Hostnamen beschränken. Weglassen, um alle Hostnamen im Workspace aufzulisten.

  Optional
• search string

  Durchsucht Kurzcode, Titel und Ziel.

  Optional
• type string

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

  Optional
• archived boolean

  Standardmäßig false. Übergib true, um stattdessen das Archiv aufzulisten.

  Optional
• favorite boolean

  Auf markierte Links beschränken.

  Optional
• sort string

  created_at (Standard), clicks, short_code, title oder updated_at.

  Optional
• direction string

  asc oder desc. Standard ist desc.

  Optional
• limit integer

  1–200. Standard ist 50.

  Optional
• offset integer

  Standardmäßig 0.

  Optional
• start_date date

  YYYY-MM-DD. Begrenzt den Zeitraum der Klicksummen, nicht welche Links zurückgegeben werden.

  Optional
• end_date date

  YYYY-MM-DD, einschließlich.

  Optional

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

Ein Link per ID, im selben Format, das der Listen-Endpunkt zurückgibt.

Erstellt einen Kurzlink. Lass short_code weg, um einen zufälligen zu erhalten. Hat das Ziel keinen title, holen wir den Seitentitel im Hintergrund.

JSON-Body

• destination

  Die URL, zu der weitergeleitet wird. Erforderlich für direct- und utm-Links. original_url wird als Alias akzeptiert.

  Erforderlich*
• short_code

  Bis zu 20 Zeichen: Buchstaben, Zahlen, Bindestriche und Unterstriche, ohne Trennzeichen am Anfang oder Ende. Muss pro Hostname eindeutig sein.

  Optional
• title

  Anzeigename im Dashboard.

  Optional
• domain

  Eine verifizierte eigene Domain oder die Basisdomain. Standard ist die Basisdomain.

  Optional
• type

  direct (Standard), utm, appstore, instagram, mobile oder device. Alles außer direct und utm erfordert den Solo-, Growth- oder Ultimate-Tarif.

  Optional
• utm_source, utm_medium, utm_campaign

  Für utm-Links; utm_source ist Pflicht, wenn type auf utm steht.

  Optional
• ios_url, android_url

  Plattform-Ziele für appstore- und mobile-Links.

  Optional
• desktop_url, mobile_url

  Beide sind für device-Links erforderlich.

  Optional
• instagram_username

  Für instagram-Links.

  Optional
• split_variations

  Ein Array aus {name, url, weight}-Objekten — mindestens zwei —, um einen gewichteten Split-Test auf einem direct- oder utm-Link durchzuführen.

  Optional
• limit_visits_per_device

  Setze true und gib visit_limit_per_device an, um die stündlichen Besuche pro Gerät zu begrenzen.

  Optional

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.

Erstelle viele Links mit einer Anfrage. Jede Zeile wird einzeln verarbeitet: Gültige Zeilen werden erstellt und Fehler pro Index gemeldet, sodass eine fehlerhafte URL nie den Rest des Stapels verwirft. Gibt 201 zurück, wenn etwas erstellt wurde, 422, wenn nichts erstellt wurde.

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 führt zusammen: Nur die gesendeten Felder werden geändert, alles andere behält seinen aktuellen Wert. PUT ersetzt: Alles, was du weglässt, wird geleert. Akzeptiert dieselben Felder wie das Erstellen.

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

Archiviert den Link: Er wird nicht mehr aufgelöst und gibt einen Platz im Kontingent frei, sein Klickverlauf bleibt aber erhalten. Ein endgültiges Löschen gibt es in der API bewusst nicht — einen Link samt Verlauf zu vernichten, bleibt eine Dashboard-Aktion mit ausdrücklicher Bestätigung.

Holt einen archivierten Link zurück in den aktiven Bestand. Gibt 403 plan_required zurück, wenn der Workspace sein Kontingent an aktiven Links bereits ausschöpft.

Einzelne Besuche eines Links, neueste zuerst. Akzeptiert limit und offset. Das Land ist in jedem Tarif enthalten.

Die wichtigsten Kennzahlen für den gesamten Workspace: Klicks insgesamt und im Zeitraum, eindeutige Besucher, QR-Scans, stärkster Tag sowie Verteilungen nach Tageszeit und Wochentag. Akzeptiert days (Standard 30, begrenzt auf deine Aufbewahrungsdauer).

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

Tägliche Klickzahlen, bereit fürs Diagramm. Übergib link_id, um auf einen Link einzugrenzen, und days, um den Zeitraum festzulegen. Tage ohne Traffic werden als null zurückgegeben statt ausgelassen, sodass die Reihe immer lückenlos ist.

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

Klicks gruppiert nach einer Dimension, mit dem Anteil jeder Zeile am Gesamtwert.

Query-Parameter

• dimension string

  channel, referrer, device, browser, os, brand, variation oder country. browser, os, brand und variation erfordern eine link_id.

  Erforderlich
• link_id integer

  Auf einen Link beschränken. Weglassen für den ganzen Workspace.

  Optional
• limit integer

  1–100. Standard ist 10.

  Optional

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

Alles, was das Dashboard für einen Link zeigt, in einem einzigen Aufruf: der Link selbst, Klicksummen, eindeutige und wiederkehrende Besucher, die tägliche Reihe, Verteilungen nach Stunde und Wochentag, alle Aufschlüsselungen und die Split-Test-Auswertung, wenn der Link einen durchführt.

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

Der Roh-Feed aller Besuche über alle Links im Workspace, neueste zuerst. Das ist der moderne Ersatz für GET /visits: dieselben Daten, Standardhülle, Unterstützung für limit und 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 }
}

In diesem Konto registrierte Webhook-Endpunkte.

Registriere einen HTTPS-Endpunkt, der bei jedem erfassten Klick einen JSON-Payload erhält. Bis zu 25 pro Konto. Fehlgeschlagene Zustellungen werden automatisch wiederholt.

JSON-Body

• target_url

  Muss mit https:// beginnen.

  Erforderlich
• event

  Standardmäßig link_visited, derzeit das einzige Event.

  Optional

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

Einen Webhook-Endpunkt entfernen. POST /hooks/subscribe und DELETE /hooks/unsubscribe/{id} bleiben für den REST-Hook-Ablauf von Zapier verfügbar.

Der ursprüngliche Verbindungstest: liefert deine Nutzer-ID, E-Mail-Adresse sowie Workspace-ID und -Name als flaches Objekt. GET /me liefert dieselbe Identität plus deine Tariflimits und Feature-Flags und ist für neuen Code die bessere Wahl.

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

Klicksummen für einen einzelnen Link, angesprochen über domain und slug statt über die ID. Beide Parameter sind Pflicht. GET /links/{id} und GET /analytics/links/{id} liefern dasselbe, wenn du die ID kennst.

Query-Parameter

• domain string

  Die Basis-Domain oder eine deiner verifizierten eigenen Domains.

  Erforderlich
• slug string

  Der Kurzcode, ohne führenden Schrägstrich.

  Erforderlich
• start_date date

  YYYY-MM-DD, begrenzt auf die Aufbewahrungsdauer deines Tarifs.

  Optional
• end_date date

  YYYY-MM-DD, einschließlich.

  Optional

Die 50 neuesten Besuche im gesamten Workspace als reines JSON-Array – ohne Hülle – mit den Feldnamen visit_id, visit_time, link_shortcode und visitor_*. Diesen Schritt „perform list“ liest Zapiers REST Hook, daher ist das Format eingefroren. Nutze für neue Projekte GET /events.

Die 50 neuesten Besuche eines Links als reines Array mit created_at, ip_address, country, device_type, browser, os und referrer. Zusammen mit /visits eingefroren; nutze für neue Projekte GET /links/{id}/events.

REST-Hook-Abonnement. Nimmt target_url und optional event (Standard link_visited) entgegen und gibt das erstellte Abonnement flach ohne Envelope zurück. POST /hooks ist dieselbe Operation im Standardformat.

REST-Hook-Abmeldung, gibt {"success": true} zurück. DELETE /hooks/{id} ist das Gegenstück im Standardformat.