REST API
Градете върху вашите връзки.

Идентичност, работно пространство, план и всяко право, което планът носи. Най-евтиният начин да потвърдите токен и да откриете какво е позволено да прави акаунтът, преди да го опитате.

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

Колко от всяка надбавка се изразходва през този месец на фактуриране. Използвайте го, за да предупредите клиент, преди да достигне тавана на проследяваните кликвания — след него пренасочването продължава да работи, но кликванията спират да се записват.

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

Персонализирани домейни в работното пространство и дали всеки от тях е завършил DNS проверката. Само проверени домейни могат да се използват като поле domain при създаване на връзка.

Всяка интеграция, която предлага продуктът, независимо дали вашият план я включва, дали това работно пространство го е свързало и как протича доставката — последно състояние, последна грешка и брой последователни грешки. Полезно за наблюдение на набор от работни пространства.

Връзки в работното пространство, с общи кликвания, разделени на all, ios, android и desktop. Включени са връзки с нула кликвания.

Параметри на заявката

• domain string

  Ограничете до едно име на хост. Пропуснете изброяването на всяко име на хост в работното пространство.

  Не е задължително
• search string

  Съвпада с кратък код, заглавие и дестинация.

  Не е задължително
• type string

  direct, utm, appstore, instagram, mobile или device.

  Не е задължително
• archived boolean

  По подразбиране е false. Вместо това подайте true, за да изведете архива.

  Не е задължително
• favorite boolean

  Ограничаване до връзки със звезда.

  Не е задължително
• sort string

  created_at (по подразбиране), clicks, short_code, title или updated_at.

  Не е задължително
• direction string

  asc или desc. По подразбиране е desc.

  Не е задължително
• limit integer

  1–200. По подразбиране е 50.

  Не е задължително
• offset integer

  По подразбиране е 0.

  Не е задължително
• start_date date

  YYYY-MM-DD. Windows общият брой щраквания, а не кои връзки са върнати.

  Не е задължително
• end_date date

  YYYY-MM-DD, включително.

  Не е задължително

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

Една връзка по id, в същата форма, която крайната точка на списъка връща.

Създайте кратка връзка. Пропуснете short_code за случаен. Ако дестинацията няма title, ние извличаме заглавието на страницата на заден план.

JSON тяло

• destination

  URL адресът за пренасочване. Изисква се за връзки direct и utm. original_url се приема като псевдоним.

  Задължително*
• short_code

  До 20 знака: букви, цифри, тирета и долни черти, които не започват и не завършват с разделител. Трябва да е уникален за име на хост.

  Не е задължително
• title

  Показвано име в таблото за управление.

  Не е задължително
• domain

  Проверен потребителски домейн или основен домейн. По подразбиране основният домейн.

  Не е задължително
• type

  direct (по подразбиране), utm, appstore, instagram, mobile или device. Всичко освен direct и utm се нуждае от Solo, Growth или Ultimate план.

  Не е задължително
• utm_source, utm_medium, utm_campaign

  За utm връзки; utm_source се изисква, когато type е utm.

  Не е задължително
• ios_url, android_url

  Платформени дестинации за appstore и mobile връзки.

  Не е задължително
• desktop_url, mobile_url

  И двете са необходими за device връзки.

  Не е задължително
• instagram_username

  За instagram връзки.

  Не е задължително
• split_variations

  Масив от {name, url, weight} обекти — поне два — за провеждане на претеглен разделен тест на direct или utm връзка.

  Не е задължително
• limit_visits_per_device

  Задайте true и предоставете visit_limit_per_device, за да ограничите почасовите посещения на устройство.

  Не е задължително

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.

Създайте много връзки в една заявка. Всеки ред се опитва независимо: създават се валидни редове и грешките се докладват за индекс, така че един лош URL адрес никога не отхвърля останалата част от пакета. Връща 201, когато нещо е създадено, 422, когато нищо не е било.

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 се слива: променят се само полетата, които изпращате, всичко останало запазва текущата си стойност. PUT замества: всичко, което пропуснете, се изчиства. Приема същите полета като create.

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

Архивира връзката: спира преобразуването и освобождава слот за квоти, докато историята на кликванията се запазва. Умишлено няма постоянно изтриване на API — унищожаването на връзка и нейната история остава действие на таблото за управление зад изрично потвърждение.

Връща архивирана връзка обратно в ротация. Връща 403 plan_required, ако работното пространство вече е в разрешената активна връзка.

Индивидуални посещения на една връзка, първо най-новите. Приема limit и offset. Държавата е включена във всеки план.

Заглавните числа за цялото работно пространство: кликвания през цялото време и в прозореца, уникални посетители, QR сканирания, пиков ден и разпределение по час от деня и ден от седмицата. Приема days (по подразбиране 30, прикрепено към вашето задържане).

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

Дневните кликвания се броят, готови за диаграма. Предайте link_id, за да го обхватите до една връзка, и days, за да зададете прозореца. Дните без трафик се връщат като нула, вместо да се пропускат, така че серията винаги е последователна.

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

Щракванията са групирани по едно измерение, като всеки ред има дял от общия брой.

Параметри на заявката

• dimension string

  channel, referrer, device, browser, os, brand, variation или country. browser, os, brand и variation се нуждаят от link_id.

  Задължително
• link_id integer

  Обхват до една връзка. Пропуснете за цялото работно пространство.

  Не е задължително
• limit integer

  1–100. По подразбиране е 10.

  Не е задължително

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

Всичко, което таблото за управление показва за една връзка в едно извикване: самата връзка, общи кликвания, уникални и завръщащи се посетители, дневни серии, разпределения по часове и дни от седмицата, всички разбивки и таблица с резултати за разделен тест, когато връзката работи.

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

Необработената емисия за посещения във всяка връзка в работното пространство, първо най-новите. Това е модерният заместител на GET /visits: същите данни, стандартен плик, поддръжка на limit и 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 }
}

Крайни точки на Webhook, регистрирани в този акаунт.

Регистрирайте HTTPS крайна точка, за да получавате JSON полезен товар при всяко записано кликване. До 25 на акаунт. Неуспешните доставки се опитват автоматично.

JSON тяло

• target_url

  Трябва да е https://.

  Задължително
• event

  По подразбиране е link_visited, което в момента е единственото събитие.

  Не е задължително

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

Премахване на крайна точка на webhook. POST /hooks/subscribe и DELETE /hooks/unsubscribe/{id} остават налични за REST Hook потока на Zapier.

Оригиналният тест за връзка: връща вашия потребителски идентификатор, имейл и идентификатор/име на работното пространство като плосък обект. GET /me връща същата самоличност плюс вашите планови ограничения и флагове за функции и е по-добрият избор за нов код.

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

Общо кликвания за една връзка, адресирана от domain и slug, а не от id. И двата параметъра са задължителни. GET /links/{id} и GET /analytics/links/{id} покриват една и съща основа, когато знаете идентификатора.

Параметри на заявката

• domain string

  Базовият домейн или един от вашите проверени персонализирани домейни.

  Задължително
• slug string

  Краткият код, без водеща наклонена черта.

  Задължително
• start_date date

  YYYY-MM-DD, прикрепен към задържането на вашия план.

  Не е задължително
• end_date date

  YYYY-MM-DD, включително.

  Не е задължително

50-те най-скорошни посещения в работното пространство като гол JSON масив — без плик — с използване на имена на полета visit_id, visit_time, link_shortcode и visitor_*. Ето какво гласи стъпката „списък за изпълнение“ на Zapier REST Hook, така че формата му е замразена. Използвайте GET /events за нова работа.

50-те най-скорошни посещения на една връзка, като гол масив с created_at, ip_address, country, device_type, browser, os и referrer. Замразени заедно с /visits; използвайте GET /links/{id}/events за нова работа.

REST Hook абонирайте се. Взема target_url и незадължителен event (по подразбиране link_visited) и връща създадения абонаментен апартамент, без плик. POST /hooks е същата операция в стандартната форма.

REST Хук отписване, връщане на {"success": true}. DELETE /hooks/{id} е еквивалентът в стандартната форма.