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

  Ищет по короткому коду, названию и целевому URL.

  Необязательно
• 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. Ограничивает период для подсчёта кликов, а не то, какие ссылки возвращаются.

  Необязательно
• 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 не задан, мы в фоне загрузим заголовок страницы целевого URL.

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

  Целевые 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 заменяет: всё, что вы не передали, очищается. Принимает те же поля, что и создание.

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

Эндпоинты вебхуков, зарегистрированные в этом аккаунте.

Зарегистрируйте 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"}'

Удаляет эндпоинт вебхука. POST /hooks/subscribe и DELETE /hooks/unsubscribe/{id} остаются доступными для REST Hook-потока Zapier.

Изначальная проверка подключения: возвращает ваш ID пользователя, email и ID/название рабочего пространства в виде плоского объекта. 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. Оба параметра обязательны. Если 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 "perform list", поэтому его формат заморожен. Для новых задач используйте 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 Hook, возвращает {"success": true}. DELETE /hooks/{id} — эквивалент в стандартном формате.