संस्करण 1 · स्थिर

pik.li की API

कोड से लिंक बनाएँ, संपादित करें और मापें। REST API में JSON इनपुट व आउटपुट, हर एकीकरण के लिए अलग कुंजी और प्रत्येक endpoint के अनुरोध तथा वास्तविक उत्तर के उदाहरण हैं।

API कुंजी प्राप्त करें OpenAPI 3.1

आधार URLhttps://pik.li/api/v1

परिचय

pik.li API आपके सॉफ़्टवेयर को उपयोगकर्ता क्षेत्र के काम करने देती है: लिंक बनाना व बदलना, उनके आँकड़े पढ़ना, टैग और डोमेन सूचीबद्ध करना तथा webhook प्रबंधित करना। यह HTTPS पर चलती है और हर पथ ऊपर दिए base URL से शुरू होता है।

अनुरोध body को Content-Type: application/json के साथ JSON में भेजें; GET अनुरोध के पैरामीटर query string में जाएँगे। उत्तर हमेशा UTF-8 JSON है, केवल QR code endpoint छवि लौटाता है।
संस्करण पथ में स्थिर है (/api/v1) और हर उत्तर में X-Api-Version: 1 हेडर है। v1 उत्तरों में आगे नए फ़ील्ड जुड़ सकते हैं; आपका कोड अज्ञात फ़ील्ड को अनदेखा करे।
तारीख और समय ISO 8601 में timezone offset सहित होते हैं (2026-09-23T10:15:42.118+02:00); केवल तारीख 2026-09-23 जैसी होती है।
आईडी संख्यात्मक होते हैं। एक लिंक इसके छोटे URL से भी पाया जा सकता है, जैसे GET /links/lookup।

त्वरित शुरुआत

सर्वर के लिए कुंजी बनाएँ (कुंजी बनाना देखें) और उसे environment variable में सुरक्षित रखें।
कनेक्शन जाँचें: GET /me आपका खाता और योजना लौटाता है।
POST /links से पहला लिंक बनाएँ।

टर्मिनल

export PIKLI_KEY="pk_live_…"

curl https://pik.li/api/v1/me \
  -H "Authorization: Bearer $PIKLI_KEY"

curl -X POST https://pik.li/api/v1/links \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/a/very/long/page"}'

प्रमाणीकरण

GET /ping को छोड़कर हर कॉल में API कुंजी चाहिए। इसे Authorization हेडर में Bearer token के रूप में भेजें।

हेडर

Authorization: Bearer pk_live_3kZ9vQeX1mT0bR7yNw2aLp4sUc8dHf6J

X-API-Key हेडर भी काम करता है। पुराने clients के लिए api_key query parameter समर्थित है, लेकिन उसे न इस्तेमाल करें: URL logs और browser history में आ जाते हैं।

कुंजियाँ pk_live_ से शुरू होकर 32 वर्णों के साथ समाप्त होती हैं। कुंजी आपके पूरे खाते—लिंक, डोमेन, टैग, आँकड़े और webhook—तक पहुँच देती है; खाते की सभी कुंजियों के अधिकार समान हैं।

कुंजी को पासवर्ड की तरह रखें। उसे केवल server पर सुरक्षित रखें, browser या वितरित app में नहीं। उजागर होने पर तुरंत रद्द करके नई कुंजी बनाएँ।

कुंजी बनाएं

लॉग इन करें और उपयोगकर्ता क्षेत्र में API और कुंजी खोलें।
कुंजी को ऐसा नाम दें जिससे उसका उपयोग याद रहे, जैसे CRM production, और कुंजी बनाएँ दबाएँ।
उसे तुरंत कॉपी करें: पूरी कुंजी केवल एक बार दिखती है।
आप अधिकतम 10 सक्रिय कुंजियाँ रख सकते हैं। पेज हर कुंजी का अंतिम उपयोग और अनुरोध संख्या दिखाता है। रद्द की गई कुंजी की अगली कॉल को 401 Unauthorized मिलेगा।

API का उपयोग कौन कर सकता है

API भुगतान योजनाओं (प्रीमियम और व्यापार) में शामिल है। Base योजना में यह डिफ़ॉल्ट रूप से नहीं है, लेकिन pik.li कर्मचारी इसे मुफ़्त में सक्षम कर सकते हैं। खाते का ईमेल पुष्ट होना चाहिए और खाता अवरुद्ध या निलंबित नहीं होना चाहिए।

इनमें से कोई शर्त पूरी न होने पर API api_disabled, email_unconfirmed या account_blocked लौटाती है।

आधार

कर्मचारी अनुरोध पर

प्रति मिनट अनुरोध: 60
नए लिंक: 1,200 प्रति महीना
बल्क लिंक: 10
आँकड़ों की अवधारण: 90 दिन
Webhook: नहीं

प्रीमियम

API शामिल

प्रति मिनट अनुरोध: 600
नए लिंक: 2,500 प्रति महीना
बल्क लिंक: 100
आँकड़ों की अवधारण: 730 दिन
Webhook: हाँ

व्यापार

API शामिल

प्रति मिनट अनुरोध: 3,000
नए लिंक: 10,000 प्रति महीना
बल्क लिंक: 100
आँकड़ों की अवधारण: 1,095 दिन
Webhook: हाँ

ये प्रत्येक प्लान के मानक मान हैं, जो कि कीमतों के सेटिंग्स से रियल-टाइम में पढ़े जाते हैं। आपके मान, जिनमें अपने संहित अधिकारियों द्वारा अपने संहित अकाउंट पर किए गए किसी भी बदलाव शामिल हैं, आपको GET /limits और GET /me में वापस दिखाते हैं।

दर सीमाएँ

हर प्रमाणीकृत उत्तर बताता है कि इस मिनट में कितने अनुरोध उपलब्ध हैं और सीमा कब रीसेट होगी।

X-RateLimit-Limit: आपकी योजना के अनुसार प्रति मिनट अनुमत अनुरोध।
X-RateLimit-Remaining: मौजूदा मिनट में बचे अनुरोध।
X-RateLimit-Reset: सीमा रीसेट होने का Unix timestamp, seconds में।
Retry-After: केवल 429 उत्तर में; दिए गए seconds तक प्रतीक्षा करें।

सीमा पार होने पर 429, त्रुटि rate_limited और Retry-After हेडर मिलता है। बताए समय तक रुकें, फिर कोशिश करें।

उत्तर

HTTP/1.1 429 Too Many Requests
Content-Type: application/json; charset=utf-8
Retry-After: 18
X-RateLimit-Limit: 600
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1790151360

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Check the X-RateLimit-* headers and retry after the window resets.",
    "details": { "limit": 600, "period_seconds": 60, "resets_at": "2026-09-23T08:16:00Z" },
    "docs_url": "https://pik.li/help#error-rate_limited"
  },
  "request_id": "2b8e51d0-7a4c-4f1e-9d3b-5c6a0e8f7d21"
}

बिना कुंजी वाले endpoint पर हर IP से प्रति मिनट 30 अनुरोध की सीमा है; GET /ping शामिल है।
योजना से अलग, हर IP से प्रति मिनट अधिकतम 600 प्रमाणीकृत अनुरोध स्वीकार होते हैं।

त्रुटियाँ

हर विफल अनुरोध समान संरचना और समस्या के अनुरूप HTTP status code लौटाता है।

उत्तर

{
  "error": {
    "code": "quota_exceeded",
    "message": "Link quota reached: 2500 links per month on your plan.",
    "details": { "limit": 2500, "used": 2500, "period": "month", "resets_at": "2026-09-30T22:00:00Z" },
    "docs_url": "https://pik.li/help#error-quota_exceeded"
  },
  "request_id": "6f1c2a9e-4b0d-4c55-9a51-8f2f0d7c1e3b"
}

code: आपके code के लिए स्थिर पहचानकर्ता; यह बदलता या अनुवादित नहीं होता।
message: उपयोगकर्ता के लिए अनुरोध की भाषा में संदेश; यह बदल सकता है।
details: अमान्य फ़ील्ड, अपेक्षित मान और सीमाओं जैसी संरचित जानकारी; हमेशा मौजूद नहीं।
docs_url: इस कोड के लिए स्पष्टीकरण, जो इस पृष्ठ में दिखाई देता है, के लिए लिंक।
request_id: अनुरोध की विशिष्ट पहचान, जो X-Request-Id हेडर में भी होती है। सहायता से संपर्क करते समय इसे दें।

प्रत्येक अंतरनिर्देश जो एक की अनुप्राणित करने की अनुमति देता है, प्रति मिनट unauthorized account_blocked email_unconfirmed api_disabled rate_limited की अनुप्राणित करने की सीमा देता है: यह नहीं पुनरावृत्ति की जाती है जिनके नीचे प्रत्येक अंतरनिर्देश के लिए।

कोडHTTPअर्थ

unauthorized401

401

API कुंजी नहीं है, गलत है या रद्द हो चुकी है।

account_blocked403

403

अपना खाता ब्लॉक किया गया, अस्थायी रूप से रोका गया या बंद है। अपने खाते की फाइनलिशन तक तुम्हारी अपेक्षा कोई त्याग नहीं है।

email_unconfirmed403

403

अपने खाते का ईमेल पता अभी तक सत्यापित नहीं है। ईमेल में दिए गए लिंक को खोलें, फिर पुनः प्रयास करें।

api_disabled403

403

इस खाते का प्लान लिंक शामिल नहीं करता है, या लिंक इस खाते के लिए निष्क्रिय की गई है। यह देखें कि कौन से लोग लिंक का उपयोग कर सकते हैं।

forbidden403

403

खाते को यह कार्रवाई करने की अनुमति नहीं है। आरक्षित

feature_required402

402

यह योजना में उपलब्ध नहीं है जो इस सेवा के लिए आवश्यक है। विस्तारित जानकारी details.feature और details.plan में दी गई है।

quota_exceeded402

402

दिन की या महीने की लिंक की रिक्ती बार बार बढ़ रही है। विस्तारित जानकारी details द्वारा दी गई है, जो लिंक फिर से बनाने का समय दर्शाती है।

not_found404

404

संसाधन मौजूद नहीं, हटा दिया गया है या दूसरे खाते का है।

link_blocked409

409

इस लिंक को नियंत्रण द्वारा निष्क्रिय किया गया है और इसे API से फिर से उपयोगी नहीं किया जा सकता है। इस लिंक की पेज पर उपयोगकर्ता क्षेत्र से आपको आगे बढ़ने का मार्ग दिया जाएगा।

conflict409

409

कार्रवाई मौजूदा स्थिति से टकराती है। आरक्षित

invalid422

422

कुछ डेटा सत्यापन से अधिक हैं। विस्तारित जानकारी details.fields और details.messages में दी गई है।

domain_not_allowed422

422

यह डोमेन इस खाते में इस्तेमाल नहीं किया जा सकता। उपलब्ध डोमेन GET /domains से देखें।

bad_request400

400

आवश्यक पैरामीटर नहीं है।

invalid_json400

400

body मान्य JSON नहीं है। Syntax और Content-Type हेडर जाँचें।

invalid_parameter400

400

एक पैरामीटर एक मान वाला है जो इस एंडपोइंट को जानता नहीं है। जानकारी दिखाती है कि कौन सा पैरामीटर और यदि उपलब्ध है तो details.allowed में वह मान दिखाता है जो स्वीकार्य हैं।

bulk_empty400

400

थोक अनुरोध में links खाली है या मौजूद नहीं है।

bulk_too_many400

400

एक ही बार में बहुत से लिंक भेजने से बचें। डिटेल्स.मेक्स तुम्हारे प्लान का सीमित है: इस सूची को अधिक बार में विभाजित करें।

idempotency_key_invalid400

400

Idempotency-Key हेडर 128 वर्णों से अधिक लंबा है।

rate_limited429

429

इस मिनट बहुत अधिक अनुरोध हुए। Retry-After में दिए समय तक रुकें, फिर प्रयास करें।

500 उत्तर हमारी ओर की समस्या बताता है। थोड़ी देर बाद फिर कोशिश करें; जारी रहने पर सहायता को X-Request-Id हेडर का मान दें।

पृष्ठांकन

जो कि लंबे समय तक लगातार दिखाई दे सकते हैं, वे पृष्ठों में विभाजित होते हैं: GET /links, GET /links/active और GET /links/:id/clicks.

page: आपकी चाहिए गई पृष्ठ, जो 1 से शुरू होती है।
per_page: प्रति पृष्ठ कितने अवयव, 1 से 100 तक (स्टैंडर्ड 50 के अनुसार डिफ़ॉल्ट)। limit एक अनुवाद के रूप में स्वीकार किया जाता है।

उत्तर में pagination object और X-Total-Count हेडर में कुल संख्या होती है। next_page के null होने तक अगले पेज माँगते रहें।

उत्तर

{
  "links": [],
  "pagination": { "page": 2, "per_page": 50, "total": 137, "total_pages": 3, "next_page": 3, "prev_page": 1 }
}

दोहराव-रोधी अनुरोध

POST /links, POST /links/bulk और POST /links/generate Idempotency-Key हेडर स्वीकार करते हैं: अधिकतम 128 वर्णों की अपनी string, जैसे operation ID या UUID।

वही मान उसी API कुंजी के साथ 24 घंटों में फिर भेजने पर pik.li नया संसाधन नहीं बनाता; पहला उत्तर और Idempotent-Replayed: true हेडर लौटाता है। timeout के बाद सुरक्षित retry से duplicate नहीं बनता।

वही अनुरोध, वही कुंजी, 24 घंटे के भीतर

HTTP/1.1 201 Created
Idempotent-Replayed: true
Content-Type: application/json; charset=utf-8

5xx उत्तर दर्ज नहीं होते, इसलिए उसी मान से retry अनुरोध फिर चलाता है। बहुत लंबा मान idempotency_key_invalid लौटाता है।

भाषाएँ

त्रुटि संदेश नौ भाषाओं में उपलब्ध हैं: en it zh ar ru fr de es pt-BR lt hi hu। API पहले locale पैरामीटर, फिर Accept-Language हेडर और अंत में खाते की भाषा चुनती है; न मिलने पर अंग्रेज़ी। केवल संदेश अनुवादित होता है; code और फ़ील्ड नाम स्थिर रहते हैं और docs_url इसी भाषा में पृष्ठ खोलता है।

टर्मिनल

curl "https://pik.li/api/v1/links?status=nope" \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Accept-Language: it"

{
  "error": {
    "code": "invalid_parameter",
    "message": "Valore non valido per il parametro status.",
    "details": { "allowed": ["all", "active", "disabled", "review", "expired"] },
    "docs_url": "https://pik.li/help?locale=it#error-invalid_parameter"
  },
  "request_id": "0d5c9b7e-1f2a-4e3b-8c6d-7a9e0f1b2c3d"
}

सांख्यिकीय विवरण

सांख्यिकीय तथ्यांक एक अवधि को पढ़ते हैं और उसकी इस अवधि की तुलना करते हैं, जो उसी अवधि की है: इससे previous और delta_pct आते हैं।

period: 24h, 7d, 30d, 90d, 1y या all (तुमको रखने वाले प्लान के रिकॉर्ड की कुल अवधि)। दिनों की संख्या भी काम करती है: period=45, या पुराना days=45। डिफ़ॉल्ट मूल्य खाते के लिए 7d, एक लिंक के लिए 30d और एक लिंक की लिस्ट के लिए all है।
from, to: परिसर की बदलती विधि के बजाय, एक तारिख (जैसे 2026-09-01) या ISO 8601 का समय. यदि इन्हें निर्धारित नहीं करते हैं, तो to वर्तमान समय के साथ बराबर होगा और from to से 30 दिन पहले के साथ बराबर होगा; तारिख to में वह पूरा दिन भी शामिल होगा।
interval: hour या day, एक समय अवधि का चरण। अवधियां तक 48 घंटे तक अवधि के लिए अपने डिफ़ॉल्ट मूल्य के रूप में घंटे की अवधि हैं, और उन अवधियों जो लंबी अवधि की हैं, दिन की अवधि हैं; एक घंटे की अवधि का एक चरण अधिकतम 7 दिनों को कवर करता है।
window.clamped: फ़िल्टर आपकी योजना की अवधारण अवधि (retention_days) से पीछे नहीं जा सकता। काटे जाने पर window.clamped true होता है।
bots: बॉट क्लिक छोड़ दिए गए हैं। उन्हें गणना करने के लिए bots=1 जोड़ें; एक व्यक्तिगत लिंक की टैब्लेट में उन्हें period.bots में भी अलग रखा जाता है।

लिंक वस्तु

हर एक बिंदु जो किसी व्यक्ति को प्रभावित करता है, उसे इस रूप में प्रभावित करता है।

idinteger: लिंक का पहचानकर्ता।
short_urlstring: साझा करने योग्य पूरा छोटा पता।
slugstring: डोमेन के बाद आने वाला लिंक कोड।
domainstring: छोटे लिंक का डोमेन।
target_urlstring: लिंक का गंतव्य।
target_hoststring: गंतव्य का host, grouping के लिए उपयोगी।
titlestring | null: आपका शीर्षक, अधिकतम 160 वर्ण।
descriptionstring | null: लिंक पर आपकी टिप्पणियाँ।
tagsarray: छोटे अक्षरों में tags, अधिकतम 10।
statusstring: active, disabled या expired।
moderationstring: स्वचालित जाँच का परिणाम: pending, allowed, review या disabled।
activeboolean: जब छोटा लिंक अभी redirect करता है तब true।
expiredboolean: समाप्ति तारीख या क्लिक सीमा पूरी होने पर true।
password_protectedboolean: आगंतुकों को पासवर्ड देना हो तो true।
clicksinteger: जब लिंक बनाया गया था, तब उस पर क्लिक किये गए व्यक्ति की संख्या।
unique_clicksinteger: जब लिंक बनाया गया था, तब अद्वितीय दृश्यकर्ता की संख्या।
last_clicked_atstring | null: अंतिम क्लिक की समय स्थिति, या न तो नहीं।
expires_atstring | null: कितने क्लिक बाद लिंक काम नहीं करेगा, या न तो नहीं।
max_clicksinteger | null: क्लिकों की संख्या तक लिंक काम करेगा, या न तो नहीं।
disabled_reasonstring | null: लिंक को निष्क्रिय रखने का कारण, शब्दों में स्पष्ट किया गया, या न तो नहीं।
utmobject | null: गंतव्य में जोड़े गए UTM पैरामीटर (source, medium, campaign, term, content), या null।
preview_urlstring: इंटरनेट पते का निरीक्षण करें: यह दिखाता है जहाँ लिंक जाने वाला है, बिल्कुल जाकर नहीं।
qr_urlstring: API के माध्यम से लिंक का QR कोड डाउनलोड करने का पता।
created_atstring: जब लिंक बनाया गया था।
updated_atstring: जब लिंक अंतिम बार संशोधित किया गया था।

अंतिम बिंदु

हर endpoint के साथ उसके पैरामीटर, terminal में चिपकाने योग्य अनुरोध और वास्तविक उत्तर दिया गया है; लंबी सूचियाँ संक्षिप्त की गई हैं। त्वरित शुरुआत की तरह उदाहरण $PIKLI_KEY से कुंजी पढ़ते हैं।

सेवा

यदि आपकी API सक्रिय हैं और आपके प्लान में कितना बचा है।

GET /ping बिना कुंजी के

स्वास्थ्य जांच करें

स्वास्थ्य जांच के लिए आवश्यक नहीं: यह स्वास्थ्य जांच के लिए डिजाइन किया गया है। इससे सर्वर की समय स्थिति और यहाँ और यहाँ के फाइल डाक्ट्रेशन और ऑपन API फाइल के लिए जांच लेता है।

अनुरोध

curl https://pik.li/api/v1/ping

उत्तर · 200

{
  "ok": true,
  "service": "pik.li",
  "version": "v1",
  "time": "2026-09-23T08:15:42Z",
  "docs": "https://pik.li/help",
  "openapi": "https://pik.li/openapi.json"
}

त्रुटियाँ कोई प्रमाणीकृत त्रुटि नहीं: इस endpoint को कुंजी नहीं चाहिए।

GET /limits

कितना बाकी है

योजना, API पहुँच, दर सीमा, लिंक कोटा, थोक सीमा, अवधारण अवधि और webhook की वास्तविक सीमाएँ। कर्मचारियों द्वारा खाते पर किए बदलाव भी शामिल हैं।

अनुरोध

curl https://pik.li/api/v1/limits \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "plan": "premium",
  "plan_name": "Premium",
  "links": {
    "period": "month", "limit": 2500, "used": 412, "remaining": 2088,
    "resets_at": "2026-09-30T22:00:00Z",
    "today": 9, "this_month": 412, "per_day": 0, "per_month": 2500
  },
  "clicks": { "limit": 150000, "used": 38120, "remaining": 111880, "resets_at": "2026-09-30T22:00:00Z" },
  "rate_limit": { "limit": 600, "remaining": 597, "period_seconds": 60, "resets_at": "2026-09-23T08:16:00Z" },
  "api_keys": { "used": 2, "limit": 10 },
  "custom_domains": { "used": 1, "limit": 3 },
  "bulk": { "max_items": 100 },
  "retention_days": 730,
  "link_ttl_days": 0,
  "features": ["qr", "analytics_full", "tags", "export", "custom_slug", "password", "expiry", "utm", "bulk", "api", "webhooks"]
}

त्रुटियाँ केवल वे त्रुटियाँ जो हर endpoint पर आ सकती हैं।

खाता

कुंजी किस खाते की है और उसके साथ कौन-सा खाता जुड़ा है।

GET /me

आपका खाता और योजना

प्रोफाइल, प्लान और उनकी अवधि, फंक्शन, सीमा और खपत, और जोड़ा जो आपका खाता कर रहा है, उसके गेम काउंटर।

अनुरोध

curl https://pik.li/api/v1/me \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "id": 1042,
  "username": "anna",
  "email": "[email protected]",
  "name": "Anna Rossi",
  "status": "active",
  "confirmed": true,
  "locale": "it",
  "plan": "premium",
  "plan_name": "Premium",
  "interval": "monthly",
  "plan_expires_at": "2026-10-14T23:59:59.000+02:00",
  "api_enabled": true,
  "features": ["qr", "analytics_full", "tags", "export", "custom_slug", "password", "expiry", "utm", "bulk", "api", "webhooks"],
  "limits": {
    "links_per_day": 0, "links_per_month": 2500, "clicks_per_month": 150000,
    "retention_days": 730, "link_ttl_days": 0, "custom_domains": 3, "api_rpm": 600
  },
  "usage": {
    "links_today": 9, "links_this_month": 412, "clicks_this_month": 38120,
    "links_quota_used": 412, "links_quota_limit": 2500, "links_total": 3187
  },
  "api_key": {
    "id": 55, "name": "CRM production", "prefix": "pk_live_Xq3v",
    "created_at": "2026-09-02T16:40:10.311+02:00", "last_used_at": "2026-09-23T10:15:42.020+02:00", "requests_count": 18230
  },
  "created_at": "2026-03-11T09:12:47.664+01:00"
}

त्रुटियाँ केवल वे त्रुटियाँ जो हर endpoint पर आ सकती हैं।

लिंक

लिंक बनाएं, खोजें, संशोधित करें, रोकें और उनकी गतिविधियों का माप।

GET /links

आपके लिंकों को दर्शाएं और खोजें

सबसे नवीन से दर्शाएं, यदि आप अन्य व्यवस्था नहीं चुनते हैं। फिल्टर जोड़ जाते हैं: एक लिंक उन सभी को पूरा करना चाहिए।

मापदंड

q string क्वेरी

मैं एक नियम की खोज कर रहा हूँ, एक शीर्षक की खोज करना चाहता हूँ।
tag string क्वेरी

केवल यह टैग वाले लिंक।
tags string क्वेरी

केवल उन लिंकों के लिए जिनमें ये सभी टैग हों, जिन्हें चौंकाने वाले रूप से अलग-अलग लिखें।
domain string क्वेरी

केवल यह डोमेन, जो होस्टनेम (उदाहरण के लिए lnkz.li) के रूप में दिखाई देता है। यह आपके में से एक होना चाहिए: देखें GET /domains।
status string क्वेरी

all, active, disabled, review या expired।
view string क्वेरी

उपयोगकर्ता क्षेत्र की इस प्रतिबिम्बों: active_24h (क्लिक किए गए अंतर्गत 24 घंटों में), created_today, expiring, moderated, review, disabled, expired, protected (के साथ पासवर्ड)।
within_days integer क्वेरी

को view=expiring के साथ: कितने दिन पहले देखें, 1 से 365 तक (मूल्यांकन 7)।
created_after string क्वेरी

इस तार या वेळ से तैयार हुए: ISO 8601 के रूप में यह तार या वेळ।
created_before string क्वेरी

इस तार या वेळ तक तैयार हुए: इस दिन के दौरान, पूरे दिन में शामिल है।
clicked_after string क्वेरी

इस तार या वेळ से एक बार भी क्लिक किए गए: इस तार या वेल से अगले तक क्लिक किए गए।
sort string क्वेरी

recent (मूल रूप से), oldest, clicks, alpha (पते और फिर कोड के अनुसार), expiring (पहले वे जो पहले से अवैध होंगे, केवल वे लिंक जो अवैध होंगे), last_clicked।
page integer क्वेरी

पृष्ठ संख्या, पृष्ठ संख्या।
per_page integer क्वेरी

प्रति पृष्ठ तत्व, 1 से 100 तक (मूल्यांकन 50)। यह भी limit के रूप में काम करता है।

अनुरोध

curl "https://pik.li/api/v1/links?status=active&tag=promo&sort=clicks&per_page=20" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "links": [{
    "id": 4821,
    "short_url": "https://lnkz.li/spring-sale",
    "slug": "spring-sale",
    "domain": "lnkz.li",
    "target_url": "https://example.com/shop/spring-sale",
    "target_host": "example.com",
    "title": "Spring sale",
    "description": null,
    "tags": ["promo", "newsletter"],
    "status": "active",
    "moderation": "allowed",
    "active": true,
    "expired": false,
    "password_protected": false,
    "clicks": 1284,
    "unique_clicks": 902,
    "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
    "expires_at": null,
    "max_clicks": null,
    "disabled_reason": null,
    "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
    "preview_url": "https://lnkz.li/spring-sale+",
    "qr_url": "https://pik.li/api/v1/links/4821/qr",
    "created_at": "2026-09-01T08:30:05.117+02:00",
    "updated_at": "2026-09-01T08:30:05.117+02:00"
  }],
  "pagination": { "page": 1, "per_page": 20, "total": 37, "total_pages": 2, "next_page": 2, "prev_page": null },
  "page": 1,
  "per_page": 20,
  "total": 37
}

त्रुटियाँ invalid_parameter domain_not_allowed

GET /links/count

आपके लिंकों की गणना

उपयोगकर्ता क्षेत्र में काउंटर: कुल, सक्रिय, अनुमोदित, निष्क्रिय, निष्क्रिय रूप से, समाप्त, खाते से खुले, दिनों में बनाए गए, दिनों में क्लिक किए गए और 7 दिनों में समाप्त होने वाले।

अनुरोध

curl https://pik.li/api/v1/links/count \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "total": 3187,
  "active": 2954,
  "review": 3,
  "disabled": 41,
  "moderated": 2,
  "expired": 189,
  "protected": 12,
  "created_today": 9,
  "active_24h": 214,
  "expiring_7d": 6
}

त्रुटियाँ केवल वे त्रुटियाँ जो हर endpoint पर आ सकती हैं।

GET /links/active

क्लिक किए गए लिंक

क्लिक किए गए लिंक, जो अंतिम घंटों में दर्शाए गए हैं, प्रत्येक के साथ clicks_in_window और uniques_in_window।

मापदंड

hours integer क्वेरी

कितनी पिछली घंटे देखें, 1 से 168 तक (मूल रूप से 24)।
page integer क्वेरी

पृष्ठ संख्या, पृष्ठ संख्या।
per_page integer क्वेरी

प्रति पृष्ठ तत्व, 1 से 100 तक (मूल्यांकन 50)। यह भी limit के रूप में काम करता है।

अनुरोध

curl "https://pik.li/api/v1/links/active?hours=24" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "hours": 24,
  "since": "2026-09-22T08:15:42Z",
  "total_clicks": 3308,
  "links": [{
    "id": 4821,
    "short_url": "https://lnkz.li/spring-sale",
    "slug": "spring-sale",
    "domain": "lnkz.li",
    "target_url": "https://example.com/shop/spring-sale",
    "target_host": "example.com",
    "title": "Spring sale",
    "description": null,
    "tags": ["promo", "newsletter"],
    "status": "active",
    "moderation": "allowed",
    "active": true,
    "expired": false,
    "password_protected": false,
    "clicks": 1284,
    "unique_clicks": 902,
    "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
    "expires_at": null,
    "max_clicks": null,
    "disabled_reason": null,
    "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
    "preview_url": "https://lnkz.li/spring-sale+",
    "qr_url": "https://pik.li/api/v1/links/4821/qr",
    "created_at": "2026-09-01T08:30:05.117+02:00",
    "updated_at": "2026-09-01T08:30:05.117+02:00",
    "clicks_in_window": 311,
    "uniques_in_window": 240
  }],
  "pagination": { "page": 1, "per_page": 50, "total": 214, "total_pages": 5, "next_page": 2, "prev_page": null }
}

त्रुटियाँ केवल वे त्रुटियाँ जो हर endpoint पर आ सकती हैं।

GET /links/lookup

क्लिक किए गए लिंक को उसके छोटे URL से खोजें

पूरा छोटा URL दें, या url, domain और slug अलग-अलग भेजें। तभी तुम्हारे लिंक पाएंगे।

मापदंड

url string क्वेरी

कुछ लिंक का पूरा छोटा आईपी, उदाहरण के लिए https://lnkz.li/spring-sale।
domain string क्वेरी

या url के बजाय: छोटे लिंक का डोमेन…
slug string क्वेरी

...और इसका जिलजुजुओकोडीस।

अनुरोध

curl "https://pik.li/api/v1/links/lookup?url=https://lnkz.li/spring-sale" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "id": 4821,
  "short_url": "https://lnkz.li/spring-sale",
  "slug": "spring-sale",
  "domain": "lnkz.li",
  "target_url": "https://example.com/shop/spring-sale",
  "target_host": "example.com",
  "title": "Spring sale",
  "description": null,
  "tags": ["promo", "newsletter"],
  "status": "active",
  "moderation": "allowed",
  "active": true,
  "expired": false,
  "password_protected": false,
  "clicks": 1284,
  "unique_clicks": 902,
  "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
  "expires_at": null,
  "max_clicks": null,
  "disabled_reason": null,
  "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
  "preview_url": "https://lnkz.li/spring-sale+",
  "qr_url": "https://pik.li/api/v1/links/4821/qr",
  "created_at": "2026-09-01T08:30:05.117+02:00",
  "updated_at": "2026-09-01T08:30:05.117+02:00"
}

त्रुटियाँ invalid_parameter not_found

GET /links/:id

एक लिंक पढ़ें

लिंक का विषय, जिसमें अपडेट किए गए काउंटर शामिल हैं।

मापदंड

id integer पथ में अनिवार्य

लिंक का id।

अनुरोध

curl https://pik.li/api/v1/links/4821 \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "id": 4821,
  "short_url": "https://lnkz.li/spring-sale",
  "slug": "spring-sale",
  "domain": "lnkz.li",
  "target_url": "https://example.com/shop/spring-sale",
  "target_host": "example.com",
  "title": "Spring sale",
  "description": null,
  "tags": ["promo", "newsletter"],
  "status": "active",
  "moderation": "allowed",
  "active": true,
  "expired": false,
  "password_protected": false,
  "clicks": 1284,
  "unique_clicks": 902,
  "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
  "expires_at": null,
  "max_clicks": null,
  "disabled_reason": null,
  "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
  "preview_url": "https://lnkz.li/spring-sale+",
  "qr_url": "https://pik.li/api/v1/links/4821/qr",
  "created_at": "2026-09-01T08:30:05.117+02:00",
  "updated_at": "2026-09-01T08:30:05.117+02:00"
}

त्रुटियाँ not_found

POST /links Idempotency-Key

एक छोटा लिंक बनाएं

केवल url आवश्यक है: pik.li डिफ़ॉल्ट डोमेन और एक रैंडम कोड चुनता है। लिंक तुरंत काम करने लगता है और स्वचालित जाँच कुछ मिनटों में पूरी होती है (moderation की शुरुआती स्थिति pending होती है)। हर लिंक आपके प्लान की सीमा में गिना जाता है।

मापदंड

url string JSON बॉडी अनिवार्य

लक्ष्य. यदि यह अज्ञात है, तो https:// जोड़ा जाता है; होस्ट का नाम एक वास्तविक नाम डोमेन या एक IP रिस्ट्रक्ट होना चाहिए। target_url एक अनुवाद है।
title string JSON बॉडी

एक शीर्षक जो आपका है, जो वर्णों को 160 तक छोटा रखता है।
description string JSON बॉडी

स्वतंत्र नोट।
tags array | string JSON बॉडी

एक अरे (["promo","autumn"]) या विराम बिंदु से अलग टेक्स्ट। निम्न से बच्चे के रूप में बनाए जाते हैं, और अधिकांश तक रखें।
domain string JSON बॉडी

एक डोमेन का होस्टनेम जो आपके डोमेनों में से एक है (GET /domains)। यदि आप इसे नहीं दर्ज करते हैं, तो आपका डिफ़ॉल्ट डोमेन उपयोग किया जाता है।
slug string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

छोटे पते का अंतिम भाग, जिसे आप चुनते हैं: छोटे अक्षर, अंक, - और _ के 2 से 64 वर्ण। न देने पर pik.li इसे बनाता है।
password string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

आगंतुकों को लिंक खोलने के लिए यह पासवर्ड देना होगा।
expires_at string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

इस समय के बाद लिंक काम करना बंद कर देगा।
max_clicks integer JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

इतने क्लिक के बाद लिंक काम करना बंद कर देगा।
utm_source, utm_medium, utm_campaign, utm_term, utm_content string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

redirect करते समय गंतव्य में UTM पैरामीटर जोड़ता है।
Idempotency-Key string हेडर

कॉल को सुरक्षित रूप से दोहराने योग्य बनाता है; दोहराव-रोधी अनुरोध अनुभाग देखें।

अनुरोध

curl -X POST https://pik.li/api/v1/links \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1042-spring" \
  -d '{"url":"https://example.com/shop/spring-sale","title":"Spring sale","slug":"spring-sale","tags":["promo","newsletter"],"utm_source":"newsletter","utm_medium":"email","utm_campaign":"spring"}'

उत्तर · 201

{
  "id": 4821,
  "short_url": "https://lnkz.li/spring-sale",
  "slug": "spring-sale",
  "domain": "lnkz.li",
  "target_url": "https://example.com/shop/spring-sale",
  "target_host": "example.com",
  "title": "Spring sale",
  "description": null,
  "tags": ["promo", "newsletter"],
  "status": "active",
  "moderation": "pending",
  "active": true,
  "expired": false,
  "password_protected": false,
  "clicks": 0,
  "unique_clicks": 0,
  "last_clicked_at": null,
  "expires_at": null,
  "max_clicks": null,
  "disabled_reason": null,
  "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
  "preview_url": "https://lnkz.li/spring-sale+",
  "qr_url": "https://pik.li/api/v1/links/4821/qr",
  "created_at": "2026-09-23T10:15:42.118+02:00",
  "updated_at": "2026-09-23T10:15:42.118+02:00"
}

त्रुटियाँ quota_exceeded domain_not_allowed invalid invalid_json idempotency_key_invalid

POST /links/bulk Idempotency-Key

एक ही कल्पना में कई लिंक बनाएं।

एक links आरेख जिसमें प्रत्येक तत्व लॉजिक POST /links के तत्वों के बराबर हैं। यह अवश्य नहीं है कि यह एक या अन्य रूप से नहीं हो: जवाब में बनाए गए चीजों की सूची दी जाती है और प्रत्येक असफल पंक्ति की स्थिति (index) और त्रुटि दिखाई देती है। जबकि कुछ पंक्तियाँ असफल होती हैं, रिस्पोन्स का स्थिति 200 होता है। एक अपडेट में सभी लिंक एक ही batch_id के साथ शेयर किए जाते हैं।

मापदंड

links array JSON बॉडी अनिवार्य

लिंक जो बनाए जाने चाहिए, प्रत्येक के लिए POST /links के क्षेत्र। एक बार की अधिकतम 10, ब्लूक लिंक्स के योग्य प्लानों में 100 तक।
Idempotency-Key string हेडर

कॉल को सुरक्षित रूप से दोहराने योग्य बनाता है; दोहराव-रोधी अनुरोध अनुभाग देखें।

अनुरोध

curl -X POST https://pik.li/api/v1/links/bulk \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: import-2026-09-23-001" \
  -d '{"links":[{"url":"https://example.com/a","tags":"autumn,promo"},{"url":"nope"}]}'

उत्तर · 200

{
  "created": [{
    "id": 4821,
    "short_url": "https://lnkz.li/spring-sale",
    "slug": "spring-sale",
    "domain": "lnkz.li",
    "target_url": "https://example.com/shop/spring-sale",
    "target_host": "example.com",
    "title": "Spring sale",
    "description": null,
    "tags": ["promo", "newsletter"],
    "status": "active",
    "moderation": "allowed",
    "active": true,
    "expired": false,
    "password_protected": false,
    "clicks": 1284,
    "unique_clicks": 902,
    "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
    "expires_at": null,
    "max_clicks": null,
    "disabled_reason": null,
    "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
    "preview_url": "https://lnkz.li/spring-sale+",
    "qr_url": "https://pik.li/api/v1/links/4821/qr",
    "created_at": "2026-09-01T08:30:05.117+02:00",
    "updated_at": "2026-09-01T08:30:05.117+02:00"
  }],
  "errors": [
    {
      "index": 1,
      "url": "nope",
      "error": {
        "code": "invalid",
        "message": "The request contains invalid data.",
        "details": {
          "fields": { "target_url": ["is not a web address: write it in full, for example example.com/page", "is invalid"] },
          "messages": ["Destination URL is not a web address: write it in full, for example example.com/page", "Destination URL is invalid"]
        },
        "docs_url": "https://pik.li/help#error-invalid"
      }
    }
  ],
  "batch_id": "api-tBUqFUYw",
  "summary": { "requested": 2, "created": 1, "failed": 1, "quota_remaining": 2087, "max_items": 100 }
}

त्रुटियाँ bulk_empty bulk_too_many invalid_json idempotency_key_invalid

POST /links/generate योजनाएँ: प्रीमियम · व्यापार Idempotency-Key

समान लक्ष्य की लिंकों को जनरेट करें।

सूचनाएँ दें: count छोटे लिंक बनाएं, प्रत्येक का अपना यादृच्छिक कोड, और उन्हें सभी destination की ओर दिन। POST /links/bulk की तुलना में, यह या तो सब कुछ या नहीं: यदि राशि में बचे लिंक की संख्या count से कम है, या यदि उद्देश्य वैध नहीं है या ब्लॉक है, तो कुछ नहीं बनाया जाएगा; यदि quota_exceeded है, तो details.remaining बताएगा कि कितने बचे हैं। उद्देश्य एक बार की जांच के बाद दिया जाता है और सभी लिंक एक ही रूप से मॉडरेशन के निर्णय के साथ शुरू होते हैं। लिंक एक batch_id शेयर करते हैं, जिसमें gen- से शुरू होता है, और एक ही बैच उपयोगकर्ता क्षेत्र में अपने CSV से दिखाई देता है। domains का उपयोग करके आप अपने दोहराव को अपने अधिकांश डोमेन पर वितरित कर सकते हैं; जवाब में, distribution बताता है कि प्रत्येक डोमेन कितने लिंक प्राप्त किए हैं।

मापदंड

destination string JSON बॉडी अनिवार्य

सभी लिंकों का लक्ष्य जो जाता है। यदि यह अज्ञात है, तो https:// जोड़ा जाता है। url एक अनुवाद है।
count integer JSON बॉडी अनिवार्य

कितने लिंक बनाने की जानकारी, 2 से उस निर्धारित सीमा तक जो pik.li द्वारा निर्धारित है। उस संख्या से अधिक लिंक बनाने की जानकारी के लिए जवाब invalid_parameter होगा, और इस सीमा को details.max में देखें।
domain string JSON बॉडी

एक डोमेन का होस्टनेम जो आपके डोमेनों में से एक है (GET /domains)। यदि आप इसे नहीं दर्ज करते हैं, तो आपका डिफ़ॉल्ट डोमेन उपयोग किया जाता है।
domains array | string JSON बॉडी

यदि दोनों भेजे जाते हैं, तो domain को निष्पक्ष रूप से निष्पादित किया जाता है। आपके एक या अधिक डोमेन को एक ऐसे रूप में भेज सकते हैं जैसे कि एक आरेख (["lnkz.li","pikz.link"]) या एक तालिका के रूप में जिसमें चौंकाने वाले बिंदुओं के साथ विभाजित किया जाता है। लिंक डोमेनों के बीच वितरित होते हैं, जिसकी दर एक विकल्प से दूसरे तक बदलती है: दो डोमेनों के लिए 50/50 तक 70/30 तक, तीन या अधिक डोमेनों के लिए दो डोमेनों के बीच का अनुपात निरंतर 7 और 3 से अधिक नहीं चलता है। लिंक यादृच्छिक व्यवस्था में होते हैं, डोमेनों के अनुसार गटक नहीं होते। count डोमेनों की संख्या के बराबर या उससे अधिक होना चाहिए, नहीं तो जवाब invalid_parameter होगा, और उस निम्न सीमा को details.min में देखें। यदि आपके अकाउंट के लिए किसी डोमेन उपलब्ध नहीं है, तो कुछ नहीं बनाया जाता है और जवाब domain_not_allowed होगा, और उस डोमेन नाम को details.domain में देखें।
title_prefix string JSON बॉडी

वैकल्पिक। प्रत्येक लिंक को उसका शीर्षक और उसका संख्यात्मक मान से जुड़ा रखा जाता है: तालिका 001, तालिका 002…
tags array | string JSON बॉडी

एक अरे (["promo","autumn"]) या विराम बिंदु से अलग टेक्स्ट। निम्न से बच्चे के रूप में बनाए जाते हैं, और अधिकांश तक रखें।
expires_at string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

इस समय के बाद लिंक काम करना बंद कर देगा।
Idempotency-Key string हेडर

कॉल को सुरक्षित रूप से दोहराने योग्य बनाता है; दोहराव-रोधी अनुरोध अनुभाग देखें।

अनुरोध

curl -X POST https://pik.li/api/v1/links/generate \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: menu-tables-2026-09" \
  -d '{"destination":"https://example.com/menu","count":3,"domains":["lnkz.li","pikz.link"],"title_prefix":"Table","tags":["menu"]}'

उत्तर · 201

{
  "batch_id": "gen-7XkQ2mPa",
  "destination": "https://example.com/menu",
  "created": 3,
  "distribution": { "lnkz.li": 2, "pikz.link": 1 },
  "quota_remaining": 2085,
  "links": [{
    "id": 5310,
    "short_url": "https://lnkz.li/k7qm2xd",
    "slug": "k7qm2xd",
    "domain": "lnkz.li",
    "target_url": "https://example.com/menu",
    "target_host": "example.com",
    "title": "Table 001",
    "description": null,
    "tags": ["menu"],
    "status": "active",
    "moderation": "allowed",
    "active": true,
    "expired": false,
    "password_protected": false,
    "clicks": 0,
    "unique_clicks": 0,
    "last_clicked_at": null,
    "expires_at": null,
    "max_clicks": null,
    "disabled_reason": null,
    "utm": null,
    "preview_url": "https://lnkz.li/k7qm2xd+",
    "qr_url": "https://pik.li/api/v1/links/5310/qr",
    "created_at": "2026-09-24T11:02:18.402+02:00",
    "updated_at": "2026-09-24T11:02:18.402+02:00"
  }]
}

त्रुटियाँ feature_required invalid_parameter quota_exceeded domain_not_allowed invalid invalid_json idempotency_key_invalid

PATCH /links/:id

एक लिंक को संपादित करें।

केवल वे क्षेत्र भेजें जिन्हें आप बदलना चाहते हैं। डोमेन बदला या जाना नहीं जा सकता। एक नया गंतव्य निर्देशित नियंत्रण प्रणाली से पुनर्निर्देशित होगा।

यही endpoint उन्हीं पैरामीटरों के साथ PUT भी स्वीकार करता है।

मापदंड

id integer पथ में अनिवार्य

लिंक का id।
url string JSON बॉडी

नई लक्ष्य जगह। लिंक तकनीकी अनुमोदन के रूप में फिर से pending रहेगा जब तक इसे फिर से अनुमोदित नहीं किया जाता है।
title string JSON बॉडी

एक शीर्षक जो आपका है, जो वर्णों को 160 तक छोटा रखता है।
description string JSON बॉडी

स्वतंत्र नोट।
tags array | string JSON बॉडी

सभी टैगों को बदल देता है। एक खाली आरेख उन्हें हटा देता है।
slug string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

छोटे पते का अंतिम भाग, जिसे आप चुनते हैं: छोटे अक्षर, अंक, - और _ के 2 से 64 वर्ण। न देने पर pik.li इसे बनाता है।
password string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

आगंतुकों को लिंक खोलने के लिए यह पासवर्ड देना होगा।
expires_at string | null JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

नई समाप्ति तारीख; null उसे हटा देता है।
max_clicks integer | null JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

नया क्लिक सीमा; null उसे हटा देता है।
utm_source, utm_medium, utm_campaign, utm_term, utm_content string JSON बॉडी योजनाएँ: प्रीमियम · व्यापार

redirect करते समय गंतव्य में UTM पैरामीटर जोड़ता है।

अनुरोध

curl -X PATCH https://pik.li/api/v1/links/4821 \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Spring sale","tags":["promo","newsletter"]}'

उत्तर · 200

{
  "id": 4821,
  "short_url": "https://lnkz.li/spring-sale",
  "slug": "spring-sale",
  "domain": "lnkz.li",
  "target_url": "https://example.com/shop/spring-sale",
  "target_host": "example.com",
  "title": "Spring sale",
  "description": null,
  "tags": ["promo", "newsletter"],
  "status": "active",
  "moderation": "allowed",
  "active": true,
  "expired": false,
  "password_protected": false,
  "clicks": 1284,
  "unique_clicks": 902,
  "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
  "expires_at": null,
  "max_clicks": null,
  "disabled_reason": null,
  "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
  "preview_url": "https://lnkz.li/spring-sale+",
  "qr_url": "https://pik.li/api/v1/links/4821/qr",
  "created_at": "2026-09-01T08:30:05.117+02:00",
  "updated_at": "2026-09-01T08:30:05.117+02:00"
}

त्रुटियाँ not_found invalid invalid_json

DELETE /links/:id

लिंक हटाएँ

मापदंड

id integer पथ में अनिवार्य

लिंक का id।

अनुरोध

curl -X DELETE https://pik.li/api/v1/links/4821 \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 204

सफल होने पर खाली body लौटाता है।

त्रुटियाँ not_found

POST /links/:id/disable

लिंक को अक्षम करें

इस पते पर एक संक्षिप्त सूचना दिखाई जाती है, जो कि निर्देशित की जाती है।

मापदंड

id integer पथ में अनिवार्य

लिंक का id।

अनुरोध

curl -X POST https://pik.li/api/v1/links/4821/disable \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "id": 4821,
  "short_url": "https://lnkz.li/spring-sale",
  "slug": "spring-sale",
  "domain": "lnkz.li",
  "target_url": "https://example.com/shop/spring-sale",
  "target_host": "example.com",
  "title": "Spring sale",
  "description": null,
  "tags": ["promo", "newsletter"],
  "status": "disabled",
  "moderation": "allowed",
  "active": false,
  "expired": false,
  "password_protected": false,
  "clicks": 1284,
  "unique_clicks": 902,
  "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
  "expires_at": null,
  "max_clicks": null,
  "disabled_reason": "Disabled by the owner",
  "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
  "preview_url": "https://lnkz.li/spring-sale+",
  "qr_url": "https://pik.li/api/v1/links/4821/qr",
  "created_at": "2026-09-01T08:30:05.117+02:00",
  "updated_at": "2026-09-23T10:15:42.118+02:00"
}

त्रुटियाँ not_found

POST /links/:id/enable

लिंक को फिर से कार्यक्षम करें

लिंक को फिर से कार्यक्षम करें। एक निर्देशित लिंक का उत्तर 409 link_blocked होता है: ऐसे मामले में, आपका दावा उपयोगकर्ता क्षेत्र से करें।

मापदंड

id integer पथ में अनिवार्य

लिंक का id।

अनुरोध

curl -X POST https://pik.li/api/v1/links/4821/enable \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "id": 4821,
  "short_url": "https://lnkz.li/spring-sale",
  "slug": "spring-sale",
  "domain": "lnkz.li",
  "target_url": "https://example.com/shop/spring-sale",
  "target_host": "example.com",
  "title": "Spring sale",
  "description": null,
  "tags": ["promo", "newsletter"],
  "status": "active",
  "moderation": "allowed",
  "active": true,
  "expired": false,
  "password_protected": false,
  "clicks": 1284,
  "unique_clicks": 902,
  "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
  "expires_at": null,
  "max_clicks": null,
  "disabled_reason": null,
  "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
  "preview_url": "https://lnkz.li/spring-sale+",
  "qr_url": "https://pik.li/api/v1/links/4821/qr",
  "created_at": "2026-09-01T08:30:05.117+02:00",
  "updated_at": "2026-09-01T08:30:05.117+02:00"
}

त्रुटियाँ not_found link_blocked

GET /links/:id/stats

लिंक की सांख्यिकी

सबसे नवीन से, आपके प्लान ने बचाव किया हुआ इतिहास के भीतर क्लिक और अद्वितीय दृश्यकर्ता की संख्या की तुलना की जाती है, पूर्व अवधि की श्रृंखला और देश, डिवाइस, ब्राउज़र, सिस्टम ऑपरेटिंग, भाषा, रिफरर, दिन की गणकाला, घंटा और शहर के विभाजन। एक लिंक के लिए विभाजन वस्तुएं होती हैं ({"IT": 188}); series पुराने क्लाइंटों के लिए श्रृंखला को दोहराता है, जिसमें प्रत्येक योजना दोहराई जाती है।

मापदंड

id integer पथ में अनिवार्य

लिंक का id।
period string क्वेरी

विंडो: 24h, 7d, 30d (प्रतिनिधित्व की दर), 90d, 1y, all। देखें: विंडों की दर।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
interval string क्वेरी

hour या day, टाइम सीरीज का चरण।

अनुरोध

curl "https://pik.li/api/v1/links/4821/stats?period=7d" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "id": 4821,
  "short_url": "https://lnkz.li/spring-sale",
  "clicks": 1284,
  "unique": 902,
  "period_days": 7,
  "period_clicks": 311,
  "window": {
    "from": "2026-09-17T00:00:00+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 7,
    "interval": "day",
    "period": "7d",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-10T00:00:00+02:00", "to": "2026-09-17T00:00:00+02:00" }
  },
  "period": { "clicks": 311, "uniques": 240, "bots": 18 },
  "previous": { "clicks": 265, "uniques": 201, "delta_pct": 17.4 },
  "series": [["2026-09-17", 38], ["2026-09-18", 52]],
  "timeseries": {
    "interval": "day",
    "points": [
      { "at": "2026-09-17", "clicks": 38, "uniques": 30 },
      { "at": "2026-09-18", "clicks": 52, "uniques": 41 }
    ]
  },
  "countries": { "IT": 188, "DE": 61, "FR": 34 },
  "devices": { "mobile": 204, "desktop": 101, "tablet": 6 },
  "browsers": { "Chrome": 142, "Safari": 120, "Firefox": 31 },
  "os": { "iOS": 118, "Android": 86, "Windows": 64 },
  "languages": { "it": 190, "de": 58, "en": 40 },
  "referrers": { "instagram.com": 97, "google.com": 44 },
  "cities": { "Milano": 61, "Roma": 38 },
  "hourly": { "0": 3, "1": 1, "2": 0, "3": 0, "4": 0, "5": 1, "6": 4, "7": 9, "8": 17, "9": 21, "10": 19, "11": 18,
              "12": 24, "13": 22, "14": 16, "15": 15, "16": 17, "17": 20, "18": 23, "19": 21, "20": 19, "21": 14, "22": 11, "23": 9 }
}

त्रुटियाँ not_found invalid_parameter

GET /links/:id/clicks

एक साथ जुड़ी हुई, एक साथ जोड़ी गई

मापदंड

id integer पथ में अनिवार्य

लिंक का id।
period string क्वेरी

फिस्टन, all अगर न दर्ज करें. देखें: फिस्टन रिपोर्ट।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
bots string क्वेरी

1 बट डाउन क्लिक भी गिने जाएँ।
page integer क्वेरी

पृष्ठ संख्या, पृष्ठ संख्या।
per_page integer क्वेरी

प्रति पृष्ठ तत्व, 1 से 100 तक (मूल्यांकन 50)। यह भी limit के रूप में काम करता है।

अनुरोध

curl "https://pik.li/api/v1/links/4821/clicks?period=24h&per_page=2" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "window": {
    "from": "2026-09-22T10:15:42+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 1,
    "interval": "hour",
    "period": "24h",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-21T10:15:42+02:00", "to": "2026-09-22T10:15:42+02:00" }
  },
  "clicks": [
    {
      "id": 918273,
      "occurred_at": "2026-09-23T09:58:12.431+02:00",
      "ip": "151.78.52.•••",
      "country": "IT",
      "region": "Lombardy",
      "city": "Milano",
      "device": "mobile",
      "browser": "Safari",
      "os": "iOS",
      "language": "it",
      "referrer_host": "instagram.com",
      "referrer": "https://instagram.com/",
      "bot": false,
      "unique": true
    }
  ],
  "pagination": { "page": 1, "per_page": 2, "total": 44, "total_pages": 22, "next_page": 2, "prev_page": null }
}

त्रुटियाँ not_found invalid_parameter

GET /links/:id/qr.{svg|png}

कोड QR डाउनलोड करें

लिंक के कोड QR, उपयोगकर्ता क्षेत्र में चुने गए उतने ही रंग और लोगो के साथ। .svg में, यदि आपको .png की आवश्यकता है तो अलग चाहिए।

मापदंड

id integer पथ में अनिवार्य

लिंक का id।
format string पथ में

फैल्स: .svg (पूर्वनिर्धारित) या .png।
size integer क्वेरी

पिक्सेल में भुजा: 128-2048 फोर्नेट (पूर्वनिर्धारित 512), 64-1024 फोर्नेट (पूर्वनिर्धारित 240)।

अनुरोध

curl "https://pik.li/api/v1/links/4821/qr.png?size=1024" \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -o spring-sale-qr.png

उत्तर · 200

एक छवि, न कि JSON: image/svg+xml, image/png.

त्रुटियाँ not_found feature_required

खाता सांख्यिकी

सभी क्षेत्रों में फ़िल्टर किए गए डेटाः खिड़की, प्रशासन, विभाग, कामकाज।

GET /stats

खाता की सांख्यिकियां

खाता विवरण, अंतिम जानकारी, अवधि संबंधी जानकारी, देशों के संदर्भ, डिवाइस, ब्राउज़र और ऑपरेटिंग सिस्टम पर क्लिक किए गए लिंक। अन्य जेंडेपॉइंट/स्टेट्स अलग-अलग हिस्सों को देते हैं, और अधिक सूची प्रस्तुत करते हैं।

मापदंड

period string क्वेरी

फिस्टन: 24h, 7d (स्थैतिक), 30d, 90d, 1y, all. देखें: फिस्टन रिपोर्ट।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
interval string क्वेरी

hour या day, टाइम सीरीज का चरण।
domain string क्वेरी

केवल यह डोमेन, जो होस्टनेम (उदाहरण के लिए lnkz.li) के रूप में दिखाई देता है। यह आपके में से एक होना चाहिए: देखें GET /domains।
tag string क्वेरी

केवल एक ही लिंक है।
bots string क्वेरी

1 बट डाउन क्लिक भी गिने जाएँ।

अनुरोध

curl "https://pik.li/api/v1/stats?period=7d" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "window": {
    "from": "2026-09-17T00:00:00+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 7,
    "interval": "day",
    "period": "7d",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-10T00:00:00+02:00", "to": "2026-09-17T00:00:00+02:00" }
  },
  "filters": { "bots": false },
  "totals": {
    "links": 3187, "active_links": 2954, "clicks": 402118, "unique_clicks": 288930,
    "clicks_today": 1204, "links_active_24h": 214, "links_created_in_window": 61
  },
  "period": { "clicks": 21480, "uniques": 15522, "links_clicked": 690, "clicks_per_link": 31.1 },
  "previous": { "clicks": 19870, "uniques": 14410, "links_clicked": 655, "clicks_per_link": 30.3, "delta_pct": 8.1, "uniques_delta_pct": 7.7 },
  "timeseries": {
    "interval": "day",
    "points": [
      { "at": "2026-09-17", "clicks": 2890, "uniques": 2104 },
      { "at": "2026-09-18", "clicks": 3120, "uniques": 2240 }
    ]
  },
  "referrers": [{ "referrer": "instagram.com", "clicks": 5210, "share": 24.3 }],
  "direct": 8740,
  "countries": [{ "country": "IT", "clicks": 12877, "share": 59.9 }],
  "devices": [{ "device": "mobile", "clicks": 14002, "share": 65.2 }],
  "browsers": [{ "browser": "Chrome", "clicks": 9406, "share": 43.8 }],
  "os": [{ "os": "iOS", "clicks": 7340, "share": 34.2 }],
  "top_links": [{
    "id": 4821,
    "short_url": "https://lnkz.li/spring-sale",
    "slug": "spring-sale",
    "domain": "lnkz.li",
    "target_url": "https://example.com/shop/spring-sale",
    "target_host": "example.com",
    "title": "Spring sale",
    "description": null,
    "tags": ["promo", "newsletter"],
    "status": "active",
    "moderation": "allowed",
    "active": true,
    "expired": false,
    "password_protected": false,
    "clicks": 1284,
    "unique_clicks": 902,
    "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
    "expires_at": null,
    "max_clicks": null,
    "disabled_reason": null,
    "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
    "preview_url": "https://lnkz.li/spring-sale+",
    "qr_url": "https://pik.li/api/v1/links/4821/qr",
    "created_at": "2026-09-01T08:30:05.117+02:00",
    "updated_at": "2026-09-01T08:30:05.117+02:00",
    "clicks_in_window": 311,
    "uniques_in_window": 240
  }]
}

त्रुटियाँ invalid_parameter domain_not_allowed

GET /stats/timeseries

समय पर क्लिक करें

समय पर क्लिक और अद्वितीय दृश्यकर्ता, अपने राउंड टाइम के कुल और प्रतिशत वृद्धि/कमी के साथ।

मापदंड

period string क्वेरी

फिस्टन: 24h, 7d (स्थैतिक), 30d, 90d, 1y, all. देखें: फिस्टन रिपोर्ट।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
interval string क्वेरी

hour या day, टाइम सीरीज का चरण।
domain string क्वेरी

केवल यह डोमेन, जो होस्टनेम (उदाहरण के लिए lnkz.li) के रूप में दिखाई देता है। यह आपके में से एक होना चाहिए: देखें GET /domains।
tag string क्वेरी

केवल एक ही लिंक है।
bots string क्वेरी

1 बट डाउन क्लिक भी गिने जाएँ।

अनुरोध

curl "https://pik.li/api/v1/stats/timeseries?period=24h" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "window": {
    "from": "2026-09-22T10:15:42+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 1,
    "interval": "hour",
    "period": "24h",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-21T10:15:42+02:00", "to": "2026-09-22T10:15:42+02:00" }
  },
  "filters": { "bots": false },
  "interval": "hour",
  "clicks": 3308,
  "previous_clicks": 2977,
  "delta_pct": 11.1,
  "points": [
    { "at": "2026-09-22T08:00:00Z", "clicks": 131, "uniques": 97 },
    { "at": "2026-09-22T09:00:00Z", "clicks": 158, "uniques": 120 }
  ]
}

त्रुटियाँ invalid_parameter domain_not_allowed

GET /stats/referrers

वे कहाँ से आए

साइटों की सूची जो अधिक बार जाएंगी, प्रत्येक के साथ कुल अनुपात, और अनुपात निर्धारित नहीं किए गए क्लिक (direct)।

मापदंड

period string क्वेरी

फिस्टन: 24h, 7d (स्थैतिक), 30d, 90d, 1y, all. देखें: फिस्टन रिपोर्ट।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
domain string क्वेरी

केवल यह डोमेन, जो होस्टनेम (उदाहरण के लिए lnkz.li) के रूप में दिखाई देता है। यह आपके में से एक होना चाहिए: देखें GET /domains।
tag string क्वेरी

केवल एक ही लिंक है।
bots string क्वेरी

1 बट डाउन क्लिक भी गिने जाएँ।
limit integer क्वेरी

सूची में पंक्तियों की संख्या, 1 से 50 तक (पूर्वनिर्धारित 10)।

अनुरोध

curl "https://pik.li/api/v1/stats/referrers?period=30d&limit=5" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "window": {
    "from": "2026-09-17T00:00:00+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 7,
    "interval": "day",
    "period": "7d",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-10T00:00:00+02:00", "to": "2026-09-17T00:00:00+02:00" }
  },
  "filters": { "bots": false },
  "clicks": 21480,
  "direct": 8740,
  "referrers": [
    { "referrer": "instagram.com", "clicks": 5210, "share": 24.3 },
    { "referrer": "google.com", "clicks": 3011, "share": 14.0 }
  ]
}

त्रुटियाँ invalid_parameter domain_not_allowed

GET /stats/countries

देश

देश जैसे ISO कोड, उनके साथ कुल अनुपात; cities पूर्ण सांख्यिकियों को शामिल करने वाले प्लानों के साथ उपलब्ध है।

मापदंड

period string क्वेरी

फिस्टन: 24h, 7d (स्थैतिक), 30d, 90d, 1y, all. देखें: फिस्टन रिपोर्ट।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
domain string क्वेरी

केवल यह डोमेन, जो होस्टनेम (उदाहरण के लिए lnkz.li) के रूप में दिखाई देता है। यह आपके में से एक होना चाहिए: देखें GET /domains।
tag string क्वेरी

केवल एक ही लिंक है।
bots string क्वेरी

1 बट डाउन क्लिक भी गिने जाएँ।
limit integer क्वेरी

सूची में पंक्तियों की संख्या, 1 से 50 तक (पूर्वनिर्धारित 10)।

अनुरोध

curl "https://pik.li/api/v1/stats/countries?period=30d" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "window": {
    "from": "2026-09-17T00:00:00+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 7,
    "interval": "day",
    "period": "7d",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-10T00:00:00+02:00", "to": "2026-09-17T00:00:00+02:00" }
  },
  "filters": { "bots": false },
  "clicks": 21480,
  "countries": [
    { "country": "IT", "clicks": 12877, "share": 59.9 },
    { "country": "DE", "clicks": 2630, "share": 12.2 }
  ],
  "cities": [
    { "city": "Milano", "clicks": 3120, "share": 14.5 },
    { "city": "Roma", "clicks": 2210, "share": 10.3 }
  ]
}

त्रुटियाँ invalid_parameter domain_not_allowed

GET /stats/devices

उपकरण, ब्राउज़र, भाषा प्रणाली

चार जने एक दूसरे को बुलाए, और किसी ने उन्हें नहीं बताया।

मापदंड

period string क्वेरी

फिस्टन: 24h, 7d (स्थैतिक), 30d, 90d, 1y, all. देखें: फिस्टन रिपोर्ट।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
domain string क्वेरी

केवल यह डोमेन, जो होस्टनेम (उदाहरण के लिए lnkz.li) के रूप में दिखाई देता है। यह आपके में से एक होना चाहिए: देखें GET /domains।
tag string क्वेरी

केवल एक ही लिंक है।
bots string क्वेरी

1 बट डाउन क्लिक भी गिने जाएँ।
limit integer क्वेरी

सूची में पंक्तियों की संख्या, 1 से 50 तक (पूर्वनिर्धारित 10)।

अनुरोध

curl "https://pik.li/api/v1/stats/devices?period=30d" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "window": {
    "from": "2026-09-17T00:00:00+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 7,
    "interval": "day",
    "period": "7d",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-10T00:00:00+02:00", "to": "2026-09-17T00:00:00+02:00" }
  },
  "filters": { "bots": false },
  "clicks": 21480,
  "devices": [{ "device": "mobile", "clicks": 14002, "share": 65.2 }, { "device": "desktop", "clicks": 7100, "share": 33.1 }],
  "browsers": [{ "browser": "Chrome", "clicks": 9406, "share": 43.8 }],
  "os": [{ "os": "iOS", "clicks": 7340, "share": 34.2 }],
  "languages": [{ "language": "it", "clicks": 12690, "share": 59.1 }]
}

त्रुटियाँ invalid_parameter domain_not_allowed

GET /stats/top

लिंक जोड़े गए

क्लिक अधिक वाले लिंक, प्रत्येक के साथ clicks_in_window और uniques_in_window।

मापदंड

period string क्वेरी

फिस्टन: 24h, 7d (स्थैतिक), 30d, 90d, 1y, all. देखें: फिस्टन रिपोर्ट।
from string क्वेरी

फिस्टनेव्हर का शुरुआती तारीख या एक इसो 8601 निर्धारण, जो period का विकल्प है: एक तारीख या समय।
to string क्वेरी

फिनाइल फिनाइलैफिन्स्ट्रा फिनाइलकॉर्डिफेडः
domain string क्वेरी

केवल यह डोमेन, जो होस्टनेम (उदाहरण के लिए lnkz.li) के रूप में दिखाई देता है। यह आपके में से एक होना चाहिए: देखें GET /domains।
tag string क्वेरी

केवल एक ही लिंक है।
bots string क्वेरी

1 बट डाउन क्लिक भी गिने जाएँ।
limit integer क्वेरी

सूची में पंक्तियों की संख्या, 1 से 50 तक (पूर्वनिर्धारित 10)।

अनुरोध

curl "https://pik.li/api/v1/stats/top?period=7d&limit=10" \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "window": {
    "from": "2026-09-17T00:00:00+02:00",
    "to": "2026-09-23T10:15:42+02:00",
    "days": 7,
    "interval": "day",
    "period": "7d",
    "clamped": false,
    "retention_days": 730,
    "previous": { "from": "2026-09-10T00:00:00+02:00", "to": "2026-09-17T00:00:00+02:00" }
  },
  "filters": { "bots": false },
  "clicks": 21480,
  "links": [{
    "id": 4821,
    "short_url": "https://lnkz.li/spring-sale",
    "slug": "spring-sale",
    "domain": "lnkz.li",
    "target_url": "https://example.com/shop/spring-sale",
    "target_host": "example.com",
    "title": "Spring sale",
    "description": null,
    "tags": ["promo", "newsletter"],
    "status": "active",
    "moderation": "allowed",
    "active": true,
    "expired": false,
    "password_protected": false,
    "clicks": 1284,
    "unique_clicks": 902,
    "last_clicked_at": "2026-09-23T09:58:12.431+02:00",
    "expires_at": null,
    "max_clicks": null,
    "disabled_reason": null,
    "utm": { "source": "newsletter", "medium": "email", "campaign": "spring" },
    "preview_url": "https://lnkz.li/spring-sale+",
    "qr_url": "https://pik.li/api/v1/links/4821/qr",
    "created_at": "2026-09-01T08:30:05.117+02:00",
    "updated_at": "2026-09-01T08:30:05.117+02:00",
    "clicks_in_window": 311,
    "uniques_in_window": 240
  }]
}

त्रुटियाँ invalid_parameter domain_not_allowed

आपके लिंक पर उपयोग किए गए टैग, जिन लिंकों के द्वारा उन्हें जोड़ा गया है और उन्हें जोड़ने वाले क्लिक, जैसे कि सबसे अधिक उपयोग किए गए टैग से शुरू किया जाता है।

मापदंड

q string क्वेरी

केवल ऐसे टैग जो यह टेक्स्ट को शामिल करते हैं।

अनुरोध

curl https://pik.li/api/v1/tags \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "tags": [
    { "name": "promo", "links": 214, "clicks": 90211 },
    { "name": "newsletter", "links": 58, "clicks": 20473 }
  ],
  "total": 2
}

त्रुटियाँ केवल वे त्रुटियाँ जो हर endpoint पर आ सकती हैं।

डोमेन

आपके लिंक के लिए उपलब्ध जगह।

GET /domains

आप का प्रयोग कर सकने वाले डोमेन

प्लान द्वारा अनुमोदित pik.li डोमेन और पहचान की जाने वाले आपके आदेश डोमेन, डोमेन का मूल डोमेन क्या है और आपके प्लान द्वारा कितने प्रत्यक्ष डोमेन अनुमोदित किए गए हैं। जब आप एक लिंक बनाते हैं, तो आपको hostname को domain के रूप में पास करना होगा।

अनुरोध

curl https://pik.li/api/v1/domains \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "domains": [
    { "id": 1, "hostname": "lnkz.li", "base_url": "https://lnkz.li", "kind": "system", "min_plan": "free", "status": "active", "verified": true, "default": true },
    { "id": 318, "hostname": "go.example.com", "base_url": "https://go.example.com", "kind": "custom", "min_plan": "free", "status": "active", "verified": true, "default": false }
  ],
  "default": "lnkz.li",
  "custom_domains": { "used": 1, "limit": 3 }
}

त्रुटियाँ केवल वे त्रुटियाँ जो हर endpoint पर आ सकती हैं।

वेबहॉकयोजनाएँ: प्रीमियम · व्यापार

वेबहॉक को आपके कोड से प्रबंधित करें। वेबहॉक कैसे काम करते हैं यह नीचे वेबहॉक भाग में बताया गया है।

GET /webhooks

आपके webhook की सूची

आपके webhook और आप इनमें से किन घटनाओं को सदस्यता दे सकते हैं। घटना का रहस्य बनाने के बाद इसे दिखाया जाता नहीं है।

अनुरोध

curl https://pik.li/api/v1/webhooks \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "webhooks": [{
    "id": 17,
    "url": "https://example.com/hooks/pikli",
    "events": ["link.created", "link.disabled"],
    "active": true,
    "failures_count": 0,
    "last_delivered_at": "2026-09-22T18:04:11.520+02:00",
    "created_at": "2026-09-10T11:20:33.004+02:00",
    "updated_at": "2026-09-10T11:20:33.004+02:00",
    "signature_header": "X-Pikli-Signature"
  }],
  "events": ["link.created", "link.clicked", "link.disabled", "link.deleted"]
}

त्रुटियाँ feature_required

GET /webhooks/:id

एक webhook पढ़ें

यह एक बहुत ही महत्वपूर्ण विषय है जो हमें इस बारे में पता चलता है कि आपका सर्वर इन घटनाओं के लिए कैसे प्रतिक्रिया देता है। इसमें अंतिम 20 भेजी गई घटनाएँ और घटनाओं के साथ आपके सर्वर का जवाब शामिल हैं।

मापदंड

id integer पथ में अनिवार्य

वेबहॉक का id।

अनुरोध

curl https://pik.li/api/v1/webhooks/17 \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 200

{
  "id": 17,
  "url": "https://example.com/hooks/pikli",
  "events": ["link.created", "link.disabled"],
  "active": true,
  "failures_count": 0,
  "last_delivered_at": "2026-09-22T18:04:11.520+02:00",
  "created_at": "2026-09-10T11:20:33.004+02:00",
  "updated_at": "2026-09-10T11:20:33.004+02:00",
  "signature_header": "X-Pikli-Signature",
  "deliveries": [
    { "id": 903, "event": "ping", "response_code": 200, "attempts": 1, "delivered_at": "2026-09-22T18:04:11.520+02:00", "created_at": "2026-09-22T18:04:11.520+02:00" }
  ]
}

त्रुटियाँ feature_required not_found

POST /webhooks

एक webhook बनाएँ

उत्तर में secret शामिल है, जिसे घटनाओं को ऑफ़र्सियल करने के लिए उपयोग किया जाता है, इस बार केवल इसके लिए: इसे तुरंत संरक्षित करें।

मापदंड

url string JSON बॉडी अनिवार्य

संपत्ति लेने का एडर, http:// या https://, इंटरनेट से अनुस्यर्णित।
events array | string JSON बॉडी

जो घटनाएँ लेनी चाहिए, जैसे एरे या चिह्नित विराम से अलग। अगर नहीं दिखाए जाएँ: सभी। नीचे घटनाओं की सूची देखें।
active boolean JSON बॉडी

false एक रिक्वाइर्ड रिकॉर्ड बनाने के लिए। प्रतिनिधित्व करता है true।

अनुरोध

curl -X POST https://pik.li/api/v1/webhooks \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/pikli","events":["link.created","link.disabled"]}'

उत्तर · 201

{
  "id": 17,
  "url": "https://example.com/hooks/pikli",
  "events": ["link.created", "link.disabled"],
  "active": true,
  "failures_count": 0,
  "last_delivered_at": null,
  "created_at": "2026-09-10T11:20:33.004+02:00",
  "updated_at": "2026-09-10T11:20:33.004+02:00",
  "signature_header": "X-Pikli-Signature",
  "secret": "ec307f56cfac71856a10d641eee7dd58e0eb8286"
}

त्रुटियाँ feature_required invalid_parameter invalid invalid_json

PATCH /webhooks/:id

एक webhook संशोधित करें

केवल बदलने वाली चीजें भेजें: आドレス, घटनाएँ, या active को रोकने और फिर से शुरू करने के लिए उपयोग किया जाता है।

यही endpoint उन्हीं पैरामीटरों के साथ PUT भी स्वीकार करता है।

मापदंड

id integer पथ में अनिवार्य

वेबहॉक का id।
url string JSON बॉडी

एक नया एडर।
events array | string JSON बॉडी

नया घटनाएँ की सूची; यह खाली नहीं हो सकता।
active boolean JSON बॉडी

false लिंक की रोकथाम को रोकता है, true लिंक की रोकथाम को सुधारता है।

अनुरोध

curl -X PATCH https://pik.li/api/v1/webhooks/17 \
  -H "Authorization: Bearer $PIKLI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":false}'

उत्तर · 200

{
  "id": 17,
  "url": "https://example.com/hooks/pikli",
  "events": ["link.created", "link.disabled"],
  "active": false,
  "failures_count": 0,
  "last_delivered_at": "2026-09-22T18:04:11.520+02:00",
  "created_at": "2026-09-10T11:20:33.004+02:00",
  "updated_at": "2026-09-23T10:15:42.118+02:00",
  "signature_header": "X-Pikli-Signature"
}

त्रुटियाँ feature_required not_found invalid_parameter invalid invalid_json

DELETE /webhooks/:id

एक webhook हटाएँ

घटनाएँ बंद हो जाती हैं और उनका इतिहास उससे एक हटाया जाता है।

मापदंड

id integer पथ में अनिवार्य

वेबहॉक का id।

अनुरोध

curl -X DELETE https://pik.li/api/v1/webhooks/17 \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 204

सफल होने पर खाली body लौटाता है।

त्रुटियाँ feature_required not_found

POST /webhooks/:id/test

एक परीक्षण भेजें

कोई ping webhook के एडर्स की ओर रिक्वेस्ट किया जाता है, जिसे जैसे हर भेजी गई घटना के रूप में ऑफ़र्सियल किया जाता है: यह रहस्य की जांच करने का सबसे तेज़ तरीका है। यह तेज़ी से शुरू होता है और इसे GET /webhooks/:id में देखा जा सकता है।

मापदंड

id integer पथ में अनिवार्य

वेबहॉक का id।

अनुरोध

curl -X POST https://pik.li/api/v1/webhooks/17/test \
  -H "Authorization: Bearer $PIKLI_KEY"

उत्तर · 202

{
  "queued": true,
  "event": "ping",
  "webhook_id": 17
}

त्रुटियाँ feature_required not_found

वेबहॉकयोजनाएँ: प्रीमियम · व्यापार

एक webhook आपके सर्वर पर एक यूरल है जिसे pik.li अपने खाते में कुछ घटनाओं के दौरान POST रूपांतरण के रूप में अपने सर्वर पर कॉल करता है। आप उसे उपयोगकर्ता क्षेत्र की webhook पृष्ठ से या गैर-प्रोसेस्ड डेटा के माध्यम से भी बना सकते हैं।पॉइंट

विंटलेटर

ping: परीक्षण करते समय, एक परीक्षण लिंक को एक उपयोगकर्ता के वेबहॉक पॉइंट के लिए भेजा जाता है। यह आपके अपलोगी अकाउंट में कुछ घटना के दौरान भेजा जाता है। आप इसे उपयोगकर्ता क्षेत्र के वेबहॉक पॉइंट या API के माध्यम से बनाएं सकते हैं।
link.created: एक लिंक बनाया गया है, या अपलोगी अकाउंट या API के माध्यम से। आ रहा हूँ
link.clicked: किसी ने एक लिंक पर क्लिक किया। आ रहा हूँ
link.disabled: एक लिंक निष्क्रिय है, और एक मॉडरेशन है। आ रहा हूँ
link.deleted: एक लिंक हटा दिया गया है। आ रहा हूँ

लिंक के घटनाएँ वेबहॉक में चुनाव कर सकते हैं, लेकिन उनकी रोकथाम अभी तक शुरू नहीं हुई है: अब तक pik.li केवल परीक्षण पिंग को भेजता है।

कैसे किया गया है

एक POST जो तीन क्षेत्रों का एक JSON शरीर जुड़ा है: event, घटना का नाम; created_at, जब इसे भेजा गया था; data, घटना के विवरण। इसके साथ ये हेडर आते हैं:

आपके सर्वर को क्या मिलता है

POST /hooks/pikli HTTP/1.1
Content-Type: application/json
X-Pikli-Event: ping
X-Pikli-Signature: sha256=bdaf35d42413498dab7fea8be1f292c36b690152e5ec7d66e6dd2c2cd0b2d61c

{"event":"ping","created_at":"2026-09-23T10:15:42+02:00","data":{"message":"pik.li webhook test","at":"2026-09-23T10:15:42+02:00","via":"api"}}

Content-Type: सदैव application/json।
X-Pikli-Event: घटना का नाम, जो शरीर का स्थिति है। यह आपको रिक्वेस्ट को पहले से ही विभाजित करने में मदद करता है।
X-Pikli-Signature: और उसके बाद शरीर के अंगों का एक चिन्ह, जैसा कि लिखा है,

हस्ताक्षर की जाँच करें

प्रत्येक लॉन्च के साथ, आपके webhook का secret एकल रूप से जब आप उसे बनाते हैं तब ही प्राप्त होता है। शीर्षक X-Pikli-Signature में sha256= फिर बाकी काल्पनिक शरीक के अम्लीय रूप में ग्राउंड बॉडी के HMAC-SHA256 का उपयोग किया जाता है। आपके रिसीव्ड बायट्स पर उसी HMAC का निर्धारण करें — JSON डिकोडिंग से पहले, जो उन्हें परिवर्तित कर देता है — और दोनों शब्दों को अच्छी तरह से तुलना करें। अगर वे अलग हैं, 401 कोड दें और आपकी अनुरोध को नज़रअंदाज करें।

यहाँ ऊपर दिखाए गए उदाहरण के secret ec307f56cfac71856a10d641eee7dd58e0eb8286 का उपयोग करके आपका कोड पर टेस्ट करें: यहाँ दिखाए गए लॉन्च का शरीक दिखाए गए उदाहरण के उपरांत उत्पन्न शायद उत्पन्न हस्ताक्षर को उपलब्ध शीर्षक में दिखाया गया है।

Node.js

import crypto from "node:crypto";
import express from "express";

const app = express();

app.post("/hooks/pikli", express.raw({ type: "application/json" }), (req, res) => {
  const expected = "sha256=" + crypto
    .createHmac("sha256", process.env.PIKLI_WEBHOOK_SECRET)
    .update(req.body)
    .digest("hex");
  const received = req.get("X-Pikli-Signature") || "";
  const valid = received.length === expected.length &&
    crypto.timingSafeEqual(Buffer.from(received), Buffer.from(expected));
  if (!valid) return res.sendStatus(401);

  const event = JSON.parse(req.body);
  res.sendStatus(204);
});

Python

import hashlib, hmac, os
from flask import Flask, abort, request

app = Flask(__name__)
SECRET = os.environ["PIKLI_WEBHOOK_SECRET"].encode()

@app.post("/hooks/pikli")
def pikli_hook():
    body = request.get_data()
    expected = "sha256=" + hmac.new(SECRET, body, hashlib.sha256).hexdigest()
    if not hmac.compare_digest(expected, request.headers.get("X-Pikli-Signature", "")):
        abort(401)
    event = request.get_json()
    return "", 204

Ruby

class PikliHooksController < ActionController::API
  def create
    body = request.raw_post
    expected = "sha256=" + OpenSSL::HMAC.hexdigest("SHA256", ENV.fetch("PIKLI_WEBHOOK_SECRET"), body)
    received = request.headers["X-Pikli-Signature"].to_s
    return head(:unauthorized) unless ActiveSupport::SecurityUtils.secure_compare(expected, received)

    event = JSON.parse(body)
    head :no_content
  end
end

PHP

<?php
$body = file_get_contents('php://input');
$expected = 'sha256=' . hash_hmac('sha256', $body, getenv('PIKLI_WEBHOOK_SECRET'));
$received = $_SERVER['HTTP_X_PIKLI_SIGNATURE'] ?? '';
if (!hash_equals($expected, $received)) {
    http_response_code(401);
    exit;
}
$event = json_decode($body, true);
http_response_code(204);

नए प्रयास और असफलता

किसी भी स्थिति में, आपको जल्दी से किसी भी रिस्पोन्स के साथ जवाब दें जिसका स्टेट 2xx हो, और धीमी गति से लंबे समय तक अपनी कार्यक्रम को देखें।
अगर pik.li आपके एड्रेस पर वास्तव में योग्य रूप से अवश्य नहीं पहुंच सकता — नेटवर्क त्रुटि, जोड़ी निरस्त की गई, या एक निर्यातित एड्रेस — तो लॉन्च तक 5 बार प्रयास किए जाते हैं, जिनमें प्रत्येक प्रयास के बीच अधिक देरी होती है: अंतिम प्रयास पहले प्रयास के लगभग छह मिनट बाद होता है।
किसी भी रिस्पोन्स का स्टेट 400 या उससे अधिक होने पर, यह नोट किया जाता है और फिर दोहराया जाता है। failures_count का मूल्य webhook में एक बढ़ता है, जो आपकी पहली रिस्पोन्स के साथ शून्य हो जाता है।
क्षेत्र उत्तराधिकारी की उपलब्ध रिकॉर्ड्स के लिए अंतिम 20 लॉन्च का अवलोकन करें, जिसमें आपका सर्वर द्वारा दिया गया स्टेट शामिल है। यह डेटाबेस रिकॉर्ड के लिए GET /webhooks/:id और उपयोगकर्ता क्षेत्र की Webhook पृष्ठ में उपलब्ध है।
इंडर्शियल रिक्वाइर्ड होना चाहिए: pik.li लोकाल या इंटरनेट के बाहर की रिक्वाइर्ड को अप्लाइ नहीं करता है। इसलिए इसे https:// का उपयोग करें, ताकि डेटा उपलब्ध रूप से भेजे जाएं।

ओपनएपीआई

इसी समान संदर्भ, एक मशीन पढ़ने वाले फॉर्मेट में, पब्लिक लिंक /openapi.json (OpenAPI 3.1) पर प्रकाशित किया गया है। इसे पोस्टमन, इंसोम्निया या ब्रॉनो में इंपोर्ट करें, या एक क्लाइंट बनाएं जिसके लिए उपयोग किया गया ओपनएपीआई-गनरेटर है।

यदि कुछ अज्ञात है या कुछ यह नहीं काम कर रहा है जैसा कि यह पेज कहता है, तो [email protected] पर लिखें।

नाम	उद्देश्य	अवधि
_pikli_session	तकनीकी सत्र: request forgery सुरक्षा token, अस्थायी संदेश, लॉगिन बाद वापसी पेज और कुकी चयन प्रति।	ब्राउज़र बंद होने तक
session_id	उपयोगकर्ता को लॉगिन रखता है; signed और केवल server-readable।	ब्राउज़र बंद होने तक या ‘मुझे याद रखें’ पर 14 दिन
pk_aid	साइन किया हुआ तकनीकी कुकी pk_aid एक साल रहता है। यह बिना अकाउंट वाले QR की सीमा लागू करने और उसी ब्राउज़र में बनाया गया कोड दोबारा खोलने के लिए ब्राउज़र की पहचान करता है। रजिस्ट्रेशन के बाद कोड को अकाउंट में जोड़ने पर वह आपके अकाउंट से जुड़ जाता है।	1 वर्ष
privacy_consent	कुकी पैनल चयन सहेजता है।	1 वर्ष
locale	भाषा सहेजता है; केवल उपयोगकर्ता के स्पष्ट चयन पर।	1 वर्ष
theme	लॉगिन उपयोगकर्ता की सेटिंग्स में सहेजी थीम।	1 वर्ष
unlock_<link>	केवल लिंक डोमेन: सुरक्षित लिंक का पासवर्ड डालना याद रखता है ताकि फिर न माँगे।	1 घंटा
cf_clearance और समान कुकी	Cloudflare सुरक्षा जाँच पास होने पर ही सेट करता और याद रखता है; Cloudflare कुकी सूचना में वर्णित।	Cloudflare द्वारा निर्धारित

pik.li की API

परिचय

त्वरित शुरुआत

प्रमाणीकरण

कुंजी बनाएं

API का उपयोग कौन कर सकता है

आधार

प्रीमियम

व्यापार

दर सीमाएँ

त्रुटियाँ

पृष्ठांकन

दोहराव-रोधी अनुरोध

भाषाएँ

सांख्यिकीय विवरण

लिंक वस्तु

अंतिम बिंदु

सेवा

स्वास्थ्य जांच करें

कितना बाकी है

खाता

आपका खाता और योजना

लिंक

आपके लिंकों को दर्शाएं और खोजें

मापदंड

आपके लिंकों की गणना

क्लिक किए गए लिंक

मापदंड

क्लिक किए गए लिंक को उसके छोटे URL से खोजें

मापदंड

एक लिंक पढ़ें

मापदंड

एक छोटा लिंक बनाएं

मापदंड

एक ही कल्पना में कई लिंक बनाएं।

मापदंड

समान लक्ष्य की लिंकों को जनरेट करें।

मापदंड

एक लिंक को संपादित करें।

मापदंड

लिंक हटाएँ

मापदंड

लिंक को अक्षम करें

मापदंड

लिंक को फिर से कार्यक्षम करें

मापदंड

लिंक की सांख्यिकी

मापदंड

एक साथ जुड़ी हुई, एक साथ जोड़ी गई

मापदंड

कोड QR डाउनलोड करें

मापदंड

खाता सांख्यिकी

खाता की सांख्यिकियां

मापदंड

समय पर क्लिक करें

मापदंड

वे कहाँ से आए

मापदंड

देश

मापदंड

उपकरण, ब्राउज़र, भाषा प्रणाली

मापदंड

लिंक जोड़े गए

मापदंड

टैग

आपके टैग

मापदंड

डोमेन

आप का प्रयोग कर सकने वाले डोमेन

वेबहॉकयोजनाएँ: प्रीमियम · व्यापार

आपके webhook की सूची

एक webhook पढ़ें

मापदंड

एक webhook बनाएँ

मापदंड

एक webhook संशोधित करें

मापदंड

एक webhook हटाएँ

मापदंड