REST API
リンクを基盤に、開発しよう。

ID、ワークスペース、プラン、そのプランのすべての利用権限。トークンを確認し、操作を試す前にアカウントで何ができるかを把握する最も手軽な方法です。

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別のクリック合計。クリック数0のリンクも含まれます。

クエリパラメータ

• domain string

  1つのホスト名に限定します。省略するとワークスペース内のすべてのホスト名を一覧表示します。

  任意
• 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。返されるリンクではなく、クリック合計の期間を絞り込みます。

  任意
• 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で指定した1つのリンク。一覧エンドポイントと同じ形式です。

短縮リンクを作成します。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リンク用。typeがutmの場合はutm_sourceが必須です。

  任意
• ios_url, android_url

  appstoreとmobileリンクのプラットフォーム別リンク先。

  任意
• desktop_url, mobile_url

  deviceリンクでは両方必須です。

  任意
• instagram_username

  instagramリンク用。

  任意
• split_variations

  directまたはutmリンクで重み付きスプリットテストを実行するための{name, url, weight}オブジェクトの配列（2つ以上）。

  任意
• limit_visits_per_device

  trueに設定し、visit_limit_per_deviceを指定すると、デバイスごとの1時間あたりの訪問回数を制限できます。

  任意

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.

1回のリクエストで多数のリンクを作成します。各行は個別に処理されます：有効な行は作成され、失敗はインデックスごとに報告されるため、1つの不正なURLでバッチ全体が破棄されることはありません。1件でも作成された場合は201、1件も作成されなかった場合は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"}'

リンクをアーカイブします：リンクは機能しなくなり、プランの枠が1つ空きますが、クリック履歴は保持されます。APIには意図的に完全削除がありません — リンクとその履歴の削除は、明示的な確認を伴うダッシュボードの操作に限られます。

アーカイブしたリンクを再び有効にします。ワークスペースがすでに有効リンクの上限に達している場合は403 plan_requiredを返します。

1つのリンクへの個別の訪問（新しい順）。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で1つのリンクに絞り込み、daysで期間を設定します。トラフィックのない日は省略されずゼロとして返されるため、系列は常に連続しています。

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

1つの軸でグループ化したクリックと、各行の合計に対する割合。

クエリパラメータ

• dimension string

  channel、referrer、device、browser、os、brand、variationまたはcountry。browser、os、brand、variationにはlink_idが必要です。

  必須
• link_id integer

  1つのリンクに限定します。省略するとワークスペース全体が対象です。

  任意
• 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 }
}

1つのリンクについてダッシュボードに表示される内容を1回の呼び出しで取得：リンク自体、クリック合計、ユニーク訪問者とリピーター、日別の系列、時間帯と曜日の分布、すべての内訳、そしてスプリットテスト実行中の場合はその成績表。

"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ペイロードを受け取れます。1アカウントにつき最大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のエンドポイントを削除します。ZapierのREST Hookフロー用にPOST /hooks/subscribeとDELETE /hooks/unsubscribe/{id}も引き続き利用できます。

元の接続テスト：ユーザーID、メールアドレス、ワークスペースの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"
}

IDではなく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の「perform list」ステップが読み取るもののため、形式は固定されています。新規開発にはGET /eventsを使ってください。

1つのリンクへの最新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}は標準形式での同等の操作です。