LinkLab for developers,in a real documentation format.

LinkLab exposes a practical REST API on the same application domain you already use in the dashboard. Logged-in users can generate one API key, and that key automatically inherits the current pricing plan, monthly shortening allowance, and analytics access of the owning account.

Quickstart

The shortest path to integration is intentionally simple: generate one API key, create one link, store the returned `link.id`, and use that identifier for analytics.

Authentication

API keys are owned by one account and are not scoped separately from the account’s current plan. If the plan changes, the API key immediately inherits the updated monthly limit and access behavior.

Create Link

`POST /api/links` accepts the same core shape used by the LinkLab dashboard. When an API key is present, the created link is owned by that account and the request counts against that account’s monthly quota.

curl -X POST https://www.linklab.in/api/links \
  -H "Authorization: Bearer ll_live_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "originalUrl": "https://example.com/campaigns/spring-launch?utm_source=api",
    "customAlias": "spring-launch",
    "expirationDate": "2026-05-01",
    "qrStyle": {
      "presetId": "ocean-glow",
      "foregroundColor": "#2563eb",
      "backgroundColor": "#eff6ff",
      "cornerColor": "#0f172a",
      "dotStyle": "dots",
      "cornerStyle": "classy-rounded",
      "frameStyle": "glass"
    }
  }'

{
  "link": {
    "id": "67fd9e4f2aa4a7e1d763e101",
    "originalUrl": "https://example.com/campaigns/spring-launch?utm_source=api",
    "shortCode": "spring-launch",
    "customAlias": "spring-launch",
    "createdAt": "4/5/2026",
    "clicks": 0,
    "status": "active",
    "expirationDate": "5/1/2026",
    "shortUrl": "https://www.linklab.in/spring-launch",
    "qrCodeDataUrl": "data:image/png;base64,..."
  },
  "quota": {
    "planId": "launch",
    "planName": "Launch",
    "subscriptionStatus": "active",
    "isPaid": true,
    "quotaSubject": "account",
    "monthlyLinkLimit": 500,
    "linksUsedThisMonth": 42,
    "linksRemainingThisMonth": 458,
    "upgradeRequired": false,
    "currentPeriodKey": "2026-04",
    "resetAt": "2026-05-01T00:00:00.000Z"
  }
}

Analytics

Use the `link.id` returned from link creation with `GET /api/links/{id}/analytics` to fetch performance data. Analytics access is restricted to links owned by the authenticated account behind the API key.

curl -X GET https://www.linklab.in/api/links/67fd9e4f2aa4a7e1d763e101/analytics \
  -H "x-api-key: ll_live_xxxxxxxxxxxxxxxxx"

{
  "analytics": {
    "selectedCode": "spring-launch",
    "metrics": [
      { "title": "Total Clicks", "value": "128", "subtitle": "84 in the last 7 days" },
      { "title": "Unique Visitors", "value": "91", "subtitle": "63 unique visitors this week" }
    ],
    "timeline": [
      { "date": "04/01", "clicks": 12, "uniqueVisitors": 9 },
      { "date": "04/02", "clicks": 18, "uniqueVisitors": 14 }
    ],
    "linkDetails": {
      "originalUrl": "https://example.com/campaigns/spring-launch?utm_source=api",
      "shortUrl": "https://www.linklab.in/spring-launch",
      "shortCode": "spring-launch",
      "createdDate": "4/5/2026",
      "status": "active",
      "qrCodeDataUrl": "data:image/png;base64,..."
    }
  }
}

Plan Limits

The API key does not have its own separate quota bucket. It shares the same monthly shortening allowance already shown in the dashboard and settings UI.

Errors

LinkLab uses simple JSON error payloads with a `message` field. Link creation may also return a `quota` snapshot when the current plan limit has been reached.