سی پی اے لیڈ پبلشر اے پی آئی دستاویزات

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

Most accounts do not receive 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

آفرز اے پی آئی

Returns a JSON list of available offers. Lower offer_rank values show first.

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

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
کچھ آفرز ملک کے مطابق مختلف رقم ادا کرتی ہیں. اگر کسی آفر میں "payouts_per_country" کی فہرست ہو, تو صارف کے دو حرفی ملکی کوڈ (مثلاً, US, CA, GB) کے مطابق ادائیگی استعمال کریں. اگر ان کا ملک فہرست میں نہ ہو, تو "amount" میں دکھائی گئی طے شدہ ادائیگی استعمال کریں.
Some offers pay by event. If an offer includes an "events" list, use each event name, description, and amount for the completed event. Event amounts are already adjusted to your publisher payout split.

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

Most accounts do not receive native CPC offers. If CPAlead enables CPC API access for your account, native CPC offers can appear and the amount field is your publisher payout.
اگر کسی آفر میں بوئسٹ کلکس ہوں, تو وہ پھر بھی اپنی عام درجہ بندی پر ہی رہتی ہے. صرف بوئسٹ کلکس ہونے کی وجہ سے اسے اوپر نہیں لایا جاتا.
اے پی آئی سے حاصل شدہ بالکل اسی لنک کا استعمال کرنے سے بہترین انتساب برقرار رہتا ہے. اگر آپ اپنے نظام میں لنکس محفوظ یا دوبارہ بناتے ہیں, تو کلکس پھر بھی کام کرتے ہیں.
If CPAlead enables CPC API access for your publisher account, native CPC offers can appear in the Offers API. Boosted CPA, CPI, or CPE offers can also include publisher-only CPC rewards.
For native CPC offers, use the amount field. For boosted offers, boost_click_balance shows the remaining boost clicks. The API shows cpc_reward_type, cpc_payout_us, cpc_payout_not_us, or both payout fields based on the offer target countries. CPC API rewards do not fire publisher postbacks.

اینڈ پوائنٹ

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

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

ایچ ٹی ٹی پی پیرامیٹر	تفصیل
id	Required. Your publisher ID.
country	صرف اس ملک کی آفرز دکھائیں, دو حرفی آئی ایس او ملک کوڈ دیں استعمال کریں `country=user` صارف کے ملک کی آفرز خودکار طور پر حاصل کرنے کے لیے
limit	واپس آنے والی آفرز کی تعداد محدود کریں. اس سے آپ کی اے پی آئی کالز تیز ہو سکتی ہیں. ڈیفالٹ 2500 ہے اور زیادہ سے زیادہ 5000 ہے.
type	By default this API returns CPA, CPI, and CPE offers. Publishers with CPC API access can also receive native CPC offers and boosted offers with CPC rewards. You can request payout types with a comma-separated list, for example `&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	صرف وہ آفر فیلڈز واپس کریں جو آپ کو درکار ہیں. کوما سے الگ کی گئی فہرست استعمال کریں, مثال کے طور پر `&fields=id,title,link,amount,offer_rank` Available fields: `id, title, description, long_description, conversion, device, daily_cap, is_fast_pay, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country, events, cpc_reward_type, cpc_payout_us, cpc_payout_not_us, boost_click_balance` Use "description" for the short offer description. Use "long_description" when you want the longer marketplace description.
include_long_description	Set this to 0 or false to leave long_description out of the default Offers API response. If your fields list includes long_description, it will still be returned. `&include_long_description=0`
offerwall_offers	بولین (true\|false). اگر آپ ایسی آفرز بھی چاہتے ہیں جو آفر والز کے لیے نشان زد ہوں تو true استعمال کریں. سی پی سی آفرز پھر بھی نہیں آئیں گی, اور بوئسٹ-کلک آفرز اپنی عام درجہ بندی پر رہیں گی.
device	اسے صرف تب استعمال کریں جب آپ خودکار ڈیوائس ٹارگٹنگ استعمال نہیں کر رہے. ڈیفالٹ طور پر اے پی آئی تمام ڈیوائس اقسام واپس کر سکتی ہے. اس فیلڈ سے صرف مخصوص ڈیوائس اقسام واپس کریں. دستیاب قدریں: ios, android, mobile, اور desktop. ڈیوائس کوما سے الگ کی گئی فہرست بھی ہو سکتی ہے, مثال کے طور پر: `&device=ios,android,mobile,desktop` صرف سی پی آئی / سی پی ای آفرز حاصل کرنے کے لیے (جن کے لیے کنورژن کے لیے صرف انسٹالیشن درکار ہوتی ہے - استعمال کریں device=ios,android استعمال کریں `device=user` صارف کے ڈیوائس کی خودکار معلومات حاصل کرنے کے لیے
subid / subid2 / subid3	SubID tracking lets you pass extra data into CPAlead tracking links. CPAlead stores the value with clicks and conversions and returns it in publisher postbacks when available. If you do not pass subid, CPAlead will not add one automatically. Use a user ID, wallet ID, or click reference when you need to credit a specific visitor. You can also use a shared value for a page, site, sub-affiliate, keyword, or traffic source, but shared values are for reporting and segmentation and cannot identify one visitor for rewards. اضافی ڈیٹا کے لیے ایک دوسری سب آئی ڈی متغیر اضافی ڈیٹا کے لیے ایک تیسری سب آئی ڈی متغیر
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!",
            "long_description": "Play QuizBlitz Pro, answer trivia questions, and complete the required level to earn your reward.",
            "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
            },
            "events": [
                {
                    "key": "event_1",
                    "name": "Event 1",
                    "description": "Install and open the app.",
                    "amount": 0.7,
                    "payout_currency": "USD"
                },
                {
                    "key": "event_2",
                    "name": "Event 2",
                    "description": "Reach level 5.",
                    "amount": 1.2,
                    "payout_currency": "USD"
                }
            ]
        },
        {
            "id": 999002,
            "title": "PhotoMaster Lite",
            "description": "Edit photos with one tap.",
            "long_description": "Install PhotoMaster Lite, try the editing tools, and keep the app installed for the required period.",
            "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,
            "events": []
        }
    ]
}

کوڈ کی مثال

<!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 آپ کے لیے فنکشن کا نام خودکار طور پر بھردے گا. جیسون پی کی مثال دیکھیں

جواب کی مثال

Publisher API Documentation

What this API is designed for

آفرز اے پی آئی

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

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