CPAlead Publisher API

Publisher API Documentation

Use these APIs to pull offers, check conversions, and download reversals. If you want, you can also use the OpenAPI file below with your own API tools.

OpenAPI JSON آفرز اے پی آئی کنورژنز اے پی آئی ریورسلز اے پی آئی

کیا آپ مشتہر کی مہمات منظم کرنا چاہتے ہیں؟

اس صفحے پر موجود Publisher API آفرز حاصل کرنے اور پبلشر رپورٹنگ کے لیے ہے۔ مشتہرین الگ Campaign API کے ذریعے سیلف سروس مہمات کی توثیق، تخلیق، ترمیم، آغاز اور عارضی توقف کر سکتے ہیں، بشمول AI ایجنٹ کی مدد کے۔

Advertiser Campaign API گائیڈ پڑھیں

This page is public. Replace placeholder values like {PUBLISHER_ID} and {API_KEY} with your own values after you sign in.

Quick Facts

Formats: JSON and JSONP
Offers Default Limit: 2500
CPC API Access: صرف فیس ادا کرنے والے CPAlead Premium ممبران کے لیے
OpenAPI File: https://www.cpalead.com/api/openapi.json

On This Page

OpenAPI File

You can use this file if you want to import the API into your own tools.

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

CPC اور بوسٹ کلکس سے کمائی کے لیے فیس ادا شدہ CPAlead Premium رکنیت اور فعال CPC API رسائی ضروری ہے۔ بوسٹ والی آفرز اپنی معمول کی درجہ بندی پر رہتی ہیں۔

OpenAPI File

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

آفرز اے پی آئی

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

آپ کی CPC API رسائی

اپنی رسائی دیکھنے کے لیے سائن ان کریں

کلک انعامات عارضی طور پر کیوں رک سکتے ہیں

اگر آپ کی ٹریفک سے بار بار کلکس آئیں مگر کافی اہل CPA یا CPI کنورژنز نہ ہوں تو CPC آفرز اور بوسٹ کلک انعامات عارضی طور پر محدود ہو سکتے ہیں۔ اس سے اشتہار دینے والوں کو بوٹس اور غیر درست ٹریفک سے تحفظ ملتا ہے۔

اس وقفے کے دوران نیٹو CPC آفرز اور بوسٹ کلک انعام کے فیلڈز آپ کی API فیڈ میں چھپا دیے جاتے ہیں۔ اہل CPA یا CPI کنورژنز ہونے پر وقفہ خود بخود ختم ہو جاتا ہے۔ اہل کنورژن آفرز دستیاب رہتی ہیں۔ دستیاب آفرز کو اپ ڈیٹ کرنے کے لیے اپنی مکمل آفر فیڈ ریفریش کریں؛ کلک کی اہلیت کی دیگر جانچیں لاگو رہتی ہیں۔

CPC اہلیت کی حیثیت

ہر کامیاب آفر جواب میں cpc_eligibility ہوتا ہے، چاہے کوئی آفر نہ ملے یا fields استعمال ہو۔ access_enabled آپ کے اکاؤنٹ کی اجازت دکھاتا ہے۔ status کی قدر not_enabled، eligible، conversion_limited یا unavailable ہوتی ہے۔ native_cpc_available اور boost_click_rewards_available دکھاتے ہیں کہ یہ انعامات آپ کے اکاؤنٹ کے لیے فی الحال دستیاب ہیں یا نہیں۔

ہر سنک کے وقت ان قدروں کا موازنہ کریں۔ ان کے بدلنے پر updated_since کے بغیر پوری فیڈ ریفریش کریں اور محفوظ آفر فہرست بدل دیں۔ یہ حیثیت ہر کلک کے انعام کی ضمانت نہیں دیتی؛ کلک کی دیگر جانچیں لاگو رہتی ہیں۔

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

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.
CPA and CPI offers with conversion_mode=events pay each listed event once. The offer amount is the maximum total reward; events.amount is the reward for that event. Complete events within 30 days of the original click. The daily cap counts new acquisitions on the day of their first paid event.
CPT (Cost Per Task) offers use screenshot verification. Send visitors to the returned offer link for instructions and My Tasks. Each task pays after approval; the events list shows the publisher rewards. Lockers unlock only after every required task is confirmed.
ایونٹ آفر پر واپس آتے وقت وہی subid یا اشتہاری ID استعمال کریں۔ ہم اصل کلک اور اس کی 30 دن کی مدت برقرار رکھتے ہیں۔ آفر دوبارہ کھولنے سے وہ نئے سرے سے شروع نہیں ہوتی۔ ID کے بغیر براہ راست لنکس براؤزر کوکی استعمال کرتے ہیں؛ براؤزر یا ٹریکنگ ڈومین بدلنے یا کوکیز مٹانے سے شناخت ختم ہو سکتی ہے۔
Use lead_id to credit each reward once. Event callbacks and conversion or reversal records include event_key and event_name. A later event has a new lead_id even when it belongs to the same offer and user.

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

API کے ذریعے CPC آفرز اور بوسٹ کلک انعامات صرف ان CPAlead Premium ممبران کے لیے دستیاب ہیں جنہوں نے $100 رکنیت فیس ادا کی ہے اور جن کی CPC API رسائی فعال ہے۔
اگر کسی آفر میں بوئسٹ کلکس ہوں, تو وہ پھر بھی اپنی عام درجہ بندی پر ہی رہتی ہے. صرف بوئسٹ کلکس ہونے کی وجہ سے اسے اوپر نہیں لایا جاتا.
API سے واپس ملنے والا لنک بالکل ویسا ہی استعمال کریں۔ اپنے سسٹم میں آفر IDs سے CPAlead ٹریکنگ لنکس دوبارہ نہ بنائیں۔
CPA، CPI یا CPE آفرز پر اہل بوسٹ کلکس کے لیے امریکی وزیٹرز پر $0.10 اور دوسرے ممالک کے وزیٹرز پر $0.07 ملتے ہیں۔ انعام کے لیے بوسٹ کلکس باقی ہونے چاہییں اور کلک کی اہلیت کی معمول کی حدیں لاگو رہتی ہیں۔
اصل CPC آفرز کے لیے cpc_reward_type کی قدر native ہوتی ہے اور amount فی کلک آپ کی ادائیگی ہے۔ بوسٹ والی آفرز کے لیے cpc_reward_type کی قدر boost_click ہوتی ہے اور amount کنورژن کی ادائیگی ہی رہتی ہے۔ boost_click_balance باقی بوسٹ کلکس دکھاتا ہے۔ آفر کے ہدف ممالک کے مطابق API، cpc_payout_us، cpc_payout_not_us یا دونوں واپس کرتی ہے۔ یہ کلک انعامات صرف پبلشر کو ملتے ہیں۔ ان سے پبلشر پوسٹ بیک نہیں بھیجا جاتا اور پوسٹ بیک کے ذریعے مواد ان لاک نہیں ہوتا۔

اینڈ پوائنٹ

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

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

ایچ ٹی ٹی پی پیرامیٹر	تفصیل
id	Required. Your publisher ID.
country	صرف اس ملک کی آفرز دکھائیں, دو حرفی آئی ایس او ملک کوڈ دیں استعمال کریں `country=user` صارف کے ملک کی آفرز خودکار طور پر حاصل کرنے کے لیے
limit	واپس آنے والی آفرز کی تعداد محدود کریں. اس سے آپ کی اے پی آئی کالز تیز ہو سکتی ہیں. ڈیفالٹ 2500 ہے اور زیادہ سے زیادہ 5000 ہے.
type	بطور ڈیفالٹ یہ API، CPA، CPI، CPE اور CPT آفرز واپس کرتی ہے۔ اصل CPC آفرز اور بوسٹ کلک انعامات کے لیے فیس ادا شدہ CPAlead Premium رکنیت اور فعال CPC API رسائی ضروری ہے۔ آپ ادائیگی کی اقسام کو کوما سے الگ کر کے مانگ سکتے ہیں، مثلاً `&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, review_period_hours, payment_terms_label, payment_terms_description, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country, events, conversion_mode, verification_method, 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,
    "cpc_eligibility": {
        "access_enabled": false,
        "status": "not_enabled",
        "native_cpc_available": false,
        "boost_click_rewards_available": false
    },
    "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",
            "conversion_mode": "single",
            "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",
            "conversion_mode": "single",
            "countries": [
                "US"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12,
            "events": []
        }
    ]
}

جواب کی مثال: HTTP 403

کوڈ کی مثال

<!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>

بوسٹ کلک والے جواب کی مثال

فیس ادا کرنے والے اور CPC API رسائی رکھنے والے Premium ممبر کے لیے مثالی جواب۔ یہ CPI آفر امریکہ اور کینیڈا کے لیے ہے، اس لیے بوسٹ ادائیگی کے دونوں فیلڈ دکھائے گئے ہیں۔ amount کنورژن کی ادائیگی ہے؛ CPC فیلڈ ممکنہ کلک انعامات دکھاتے ہیں۔

{
    "status": "success",
    "number_offers": 1,
    "country": "US",
    "devices": null,
    "cpc_eligibility": {
        "access_enabled": true,
        "status": "eligible",
        "native_cpc_available": true,
        "boost_click_rewards_available": true
    },
    "offers": [
        {
            "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",
            "conversion_mode": "single",
            "countries": [
                "US",
                "CA"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12,
            "events": [],
            "cpc_reward_type": "boost_click",
            "boost_click_balance": 250,
            "cpc_payout_us": 0.1,
            "cpc_payout_not_us": 0.07
        }
    ]
}

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

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

اگر API درخواست HTTP 429 واپس کرے تو دوبارہ کوشش سے پہلے Retry-After میں درج سیکنڈ تک انتظار کریں۔ X-RateLimit-Limit اور X-RateLimit-Remaining دیکھیں اور بار بار ناکامی پر انتظار کا وقت بڑھائیں۔

اینڈ پوائنٹ

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

جواب کی مثال

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

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

اینڈ پوائنٹ

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

جواب کی مثال