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. క్లిక్ మొత్తాల వ్యవధిని నిర్ణయిస్తుంది, ఏ లింక్‌లు తిరిగి వస్తాయో కాదు.

  ఐచ్ఛికం
• 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 లింక్‌ల కోసం; 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} ఆబ్జెక్ట్‌ల అర్రే — కనీసం రెండు.

  ఐచ్ఛికం
• 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 }
}

ఈ ఖాతాలో నమోదు చేసిన వెబ్‌హుక్ ఎండ్‌పాయింట్‌లు.

నమోదైన ప్రతి క్లిక్‌పై JSON పేలోడ్‌ను అందుకోవడానికి HTTPS ఎండ్‌పాయింట్‌ను నమోదు చేయండి. ఖాతాకు 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"}'

వెబ్‌హుక్ ఎండ్‌పాయింట్‌ను తొలగించండి. 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 arrayగా — 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తో ఎన్వలప్ లేని array‌గా. /visitsతో పాటు స్థిరం చేయబడింది; కొత్త పని కోసం GET /links/{id}/events ఉపయోగించండి.

REST Hook సబ్‌స్క్రైబ్. target_url మరియు ఐచ్ఛిక event (డిఫాల్ట్ link_visited) తీసుకుని, సృష్టించిన సబ్‌స్క్రిప్షన్‌ను ఎన్వలప్ లేకుండా నేరుగా తిరిగి ఇస్తుంది. POST /hooks అదే ఆపరేషన్ స్టాండర్డ్ రూపంలో.

REST Hook అన్‌సబ్‌స్క్రైబ్, {"success": true}ను తిరిగి ఇస్తుంది. DELETE /hooks/{id} స్టాండర్డ్ రూపంలో దీనికి సమానం.