CPAlead Publisher API Documentation

Overview

What this API is designed for

Offer Sync

Pull available offers, filter by device or country, and use updated_since for incremental refreshes.

Tracking Safety

The Offers API never returns native CPC offers. Boost-click offers can appear, but they keep their normal rank.

OpenAPI File

The public OpenAPI file is available at /api/openapi.json .

01

آفرز اے پی آئی

دستیاب آفرز کی جیسون فہرست واپس کرتا ہے. نمایاں آفرز پہلے نظر آسکتی ہیں. اس کے بعد, کم offer_rank قدریں پہلے نظر آتی ہیں.

درجہ بندی & ملکی ادائیگیاں

ہر آفر میں ایک offer_rank شامل ہوتا ہے جہاں 1 سب سے زیادہ درجہ بندی والی آفر ہوتی ہے. نمایاں آفرز پہلے آ سکتی ہیں. اس کے بعد نتائج کم سے زیادہ offer_rank ترتیب میں رہتے ہیں.
کچھ آفرز ملک کے مطابق مختلف رقم ادا کرتی ہیں. اگر کسی آفر میں "payouts_per_country" کی فہرست ہو, تو صارف کے دو حرفی ملکی کوڈ (مثلاً, US, CA, GB) کے مطابق ادائیگی استعمال کریں. اگر ان کا ملک فہرست میں نہ ہو, تو "amount" میں دکھائی گئی طے شدہ ادائیگی استعمال کریں.

آفر اے پی آئی نوٹس

سی پی سی آفرز اس اے پی آئی سے واپس نہیں آتیں.
اگر کسی آفر میں بوئسٹ کلکس ہوں, تو وہ پھر بھی اپنی عام درجہ بندی پر ہی رہتی ہے. صرف بوئسٹ کلکس ہونے کی وجہ سے اسے اوپر نہیں لایا جاتا.
اے پی آئی سے حاصل شدہ بالکل اسی لنک کا استعمال کرنے سے بہترین انتساب برقرار رہتا ہے. اگر آپ اپنے نظام میں لنکس محفوظ یا دوبارہ بناتے ہیں, تو کلکس پھر بھی کام کرتے ہیں.

اینڈ پوائنٹ

https://www.cpalead.com/api/offers?id={PUBLISHER_ID}

دستیاب ایچ ٹی ٹی پی استعلامی پیرامیٹرز

ایچ ٹی ٹی پی پیرامیٹر	تفصیل
id	Required. Your publisher ID.
country	صرف اس ملک کی آفرز دکھائیں, دو حرفی آئی ایس او ملک کوڈ دیں استعمال کریں `country=user` صارف کے ملک کی آفرز خودکار طور پر حاصل کرنے کے لیے
limit	واپس آنے والی آفرز کی تعداد محدود کریں. اس سے آپ کی اے پی آئی کالز تیز ہو سکتی ہیں. ڈیفالٹ 2500 ہے اور زیادہ سے زیادہ 5000 ہے.
type	یہ اے پی آئی سی پی سی آفرز واپس نہیں کرتی. ڈیفالٹ طور پر یہ سی پی اے, سی پی آئی, اور سی پی ای آفرز واپس کرتی ہے. آپ سی پی آر بھی کوما سے الگ کی گئی فہرست کے ساتھ طلب کر سکتے ہیں, مثال کے طور پر `&type=cpi,cpe,cpr`
updated_since	Only return offers updated on or after this date. You can use YYYY-MM-DD or a full ISO date and time, for example `&updated_since=2026-04-01T00:00:00Z`
fields	Only return the offer fields you need. Use a comma-separated list, for example `&fields=id,title,link,amount,offer_rank` Available fields: `id, title, description, conversion, device, daily_cap, is_fast_pay, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country`
offerwall_offers	بولین (true\|false). اگر آپ ایسی آفرز بھی چاہتے ہیں جو آفر والز کے لیے نشان زد ہوں تو true استعمال کریں. سی پی سی آفرز پھر بھی نہیں آئیں گی, اور بوئسٹ-کلک آفرز اپنی عام درجہ بندی پر رہیں گی.
device	اسے صرف تب استعمال کریں جب آپ خودکار ڈیوائس ٹارگٹنگ استعمال نہیں کر رہے. ڈیفالٹ طور پر اے پی آئی تمام ڈیوائس اقسام واپس کر سکتی ہے. اس فیلڈ سے صرف مخصوص ڈیوائس اقسام واپس کریں. دستیاب قدریں: ios, android, mobile, اور desktop. ڈیوائس کوما سے الگ کی گئی فہرست بھی ہو سکتی ہے, مثال کے طور پر: `&device=ios,android,mobile,desktop` صرف سی پی آئی / سی پی ای آفرز حاصل کرنے کے لیے (جن کے لیے کنورژن کے لیے صرف انسٹالیشن درکار ہوتی ہے - استعمال کریں device=ios,android استعمال کریں `device=user` صارف کے ڈیوائس کی خودکار معلومات حاصل کرنے کے لیے
subid / subid2 / subid3	سب آئی ڈی ٹریکنگ آپ کو اضافی ڈیٹا بھیجنے کی اجازت دیتی ہے جب کوئی صارف آپ کے افیلیٹ لنکس پر کلک کرتا ہے اور آپ افیلیٹ لنکس کے آخر میں ایک ٹیگ بھیجتے ہیں, یہ پیرامیٹر خودکار طور پر آپ کے ٹریکنگ لنک میں سب آئی ڈی بھردے گا. آپ سب آئی ڈیز کو لیڈز کو حصوں میں تقسیم کرنے, مہمات کو بہتر بنانے, اور کنورژنز میں بہتری لانے کے لیے استعمال کر سکتے ہیں, یہاں کچھ مثالیں ہیں: سب-افیلیٹ آئی ڈیز, ذرائع (Organic, PPC, Email etc), مطلوبہ الفاظ, مقامات, وغیرہ... اضافی ڈیٹا کے لیے ایک دوسری سب آئی ڈی متغیر اضافی ڈیٹا کے لیے ایک تیسری سب آئی ڈی متغیر
gaid / idfa	اگر آپ کے پاس موبائل کے لیے گوگل ایڈورٹائزنگ آئی ڈی (GAID) ہے, تو اس متغیر کو استعمال کریں تاکہ آپ کے ٹریکنگ لنک میں gaid خودکار طور پر بھرجائے اگر آپ کے پاس موبائل کے لیے ایپل آئیڈنٹیفائر فار ایڈورٹائزرز (IDFA) ہے, تو اس متغیر کو استعمال کریں تاکہ آپ کے ٹریکنگ لنک میں idfa خودکار طور پر بھرجائے
format / callback	جیسون یا جیسون پی فارمیٹ. جیسون بطور ڈیفالٹ جیسون پی کال بیک فنکشن کا نام. صرف جیسون پی فارمیٹ کے لیے استعمال ہوتا ہے. اگر jQuery getJSON استعمال کر رہے ہیں تو callback=? استعمال کریں اور jQuery آپ کے لیے فنکشن کا نام خودکار طور پر بھردے گا. جیسون پی کی مثال دیکھیں

جواب کی مثال

{
    "status": "success",
    "number_offers": 2,
    "country": "US",
    "devices": null,
    "offers": [
        {
            "id": 999001,
            "title": "QuizBlitz Pro",
            "description": "Test your knowledge and win rewards!",
            "conversion": "Complete Level 5 (New Users Only)",
            "device": "android",
            "daily_cap": 50,
            "is_fast_pay": true,
            "link": "https://{tracking_domain}/view.php?id=999001&pub={PUBLISHER_ID}&_src=api&_src_sig={SIGNATURE}",
            "preview_link": "https://example.com/offerblast",
            "amount": 1.2,
            "payout_currency": "USD",
            "payout_type": "CPE",
            "countries": [
                "US",
                "CA",
                "GB",
                "AU",
                "NZ"
            ],
            "epc": 0.95,
            "creatives": {
                "url": "https://{assets_domain}/images/offerblast.png"
            },
            "offer_rank": 7,
            "payouts_per_country": {
                "US": 1.2,
                "CA": 1.1,
                "GB": 0.9
            }
        },
        {
            "id": 999002,
            "title": "PhotoMaster Lite",
            "description": "Edit photos with one tap.",
            "conversion": "Install, open & keep for 2 days (New Users Only)",
            "device": "ios",
            "daily_cap": 100,
            "is_fast_pay": false,
            "link": "https://{tracking_domain}/view.php?id=999002&pub={PUBLISHER_ID}&_src=api&_src_sig={SIGNATURE}",
            "preview_link": "https://example.com/photomaster",
            "amount": 0.85,
            "payout_currency": "USD",
            "payout_type": "CPI",
            "countries": [
                "US"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12
        }
    ]
}

کوڈ کی مثال

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>CPAlead Offers API Example</title>
</head>
<body>
    <div id="offer-list">Loading offers...</div>

document.getElementById("offer-list").innerHTML = html || "No offers found.";
            })
            .catch(() => {
                document.getElementById("offer-list").innerText = "Failed to load offers.";
            });
    </script>
</body>
</html>

02

کنورژنز اے پی آئی

حد: فی منٹ 1 درخواست
کنورژن اے پی آئی آپ کو کنورژنز کے لیے آزمائش کرنے کی غرض سے سی پی اے لیڈ کو پنگ کرنے دیتی ہے, جو حسب ضرورت کسٹم ایپس بنانے میں مفید ہے. سب آئی ڈی کو سب آئی ڈی یا آئی پی ایڈریس کے طور پر بھیجیں, یا "user" استعمال کریں تاکہ ہمارا نظام اس اسکرپٹ کو کال کرنے والے کلائنٹ کا آئی پی ایڈریس استعمال کرے (جیسون پی کالز کے لیے مفید)
پش قسم کی کنورژن سروس (سرور-ٹو-سرور پوسٹ بیک) کے لیے, ہمارے پوسٹ بیک دستاویزات دیکھیں

اینڈ پوائنٹ

https://www.cpalead.com/api/conversions?id={PUBLISHER_ID}&api_key={API_KEY}

دستیاب ایچ ٹی ٹی پی استعلامی پیرامیٹرز

ایچ ٹی ٹی پی پیرامیٹر	تفصیل
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	لازمی. سب آئی ڈی کی بنیاد پر کنورژن تلاش کریں, سب آئی ڈی یا صارف کا آئی پی ایڈریس بھیجیں, "user" بھیجیں تاکہ اس اسکرپٹ کو کال کرنے والے کلائنٹ کا آئی پی ایڈریس استعمال ہو (جیسون پی کالز کے لیے مفید)
offer_id	اختیاری. صرف اس آفر (مہم) آئی ڈی کے لیے کنورژن چیک کرے گا
format / callback	جیسون یا جیسون پی فارمیٹ. جیسون بطور ڈیفالٹ جیسون پی کال بیک فنکشن کا نام. صرف جیسون پی فارمیٹ کے لیے استعمال ہوتا ہے. اگر jQuery getJSON استعمال کر رہے ہیں تو callback=? استعمال کریں اور jQuery آپ کے لیے فنکشن کا نام خودکار طور پر بھردے گا. جیسون پی کی مثال دیکھیں

جواب کی مثال

03

ریورسلز اے پی آئی

حد: فی منٹ 1 درخواست
اس اے پی آئی کو استعمال کریں تاکہ دو تاریخوں کے درمیان اپنی خراب لیڈز کی فہرست ڈاؤنلوڈ کریں. خراب ٹریفک کو الگ کرنے کے لیے مفید

اینڈ پوائنٹ

https://www.cpalead.com/api/reversals?id={PUBLISHER_ID}&api_key={API_KEY}

دستیاب ایچ ٹی ٹی پی استعلامی پیرامیٹرز

ایچ ٹی ٹی پی پیرامیٹر	تفصیل
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	خراب لیڈز حاصل کرتے وقت استعمال کرنے کی ابتدائی تاریخ. فارمیٹ: yyyy-mm-dd
end_date	خراب لیڈز حاصل کرتے وقت استعمال کرنے کی اختتامی تاریخ. ایک وقت میں زیادہ سے زیادہ ایک ماہ حاصل کیا جا سکتا ہے
format / callback	جیسون یا جیسون پی فارمیٹ. جیسون بطور ڈیفالٹ جیسون پی کال بیک فنکشن کا نام. صرف جیسون پی فارمیٹ کے لیے استعمال ہوتا ہے. اگر jQuery getJSON استعمال کر رہے ہیں تو callback=? استعمال کریں اور jQuery آپ کے لیے فنکشن کا نام خودکار طور پر بھردے گا. جیسون پی کی مثال دیکھیں

جواب کی مثال