Dokumentasyon sa CPAlead Publisher API

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

API sa mga Alayon

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

Ranggo & Mga Bayad sa Nasod

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
Ang uban nga mga alayon lain-lain ang bayad depende sa nasod. Kung ang usa ka alayon naglakip og lista sa "payouts_per_country", gamita ang bayad nga mohaom sa duha ka-titik nga code sa nasod sa gamiton (pananglitan, US, CA, GB). Kung ang ilang nasod wala sa lista, gamita ang default nga bayad nga ipakita sa "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.

Mga Pahimangno sa API sa Alayon

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.
Kung ang usa ka alayon adunay boost clicks, magpabilin kini sa iyang normal nga ranggo. Dili kini ibutang sa taas lang kay naa kini boost clicks.
Ang paggamit sa eksaktong link nga gibalik sa API nagpabilin sa pinakamaayong attribution. Kung imong i-save o usbon pag-usab ang mga link sa imong kaugalingong system, ang mga pag-klik maglihok pa gihapon.
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.

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
country	Ipakita lang ang mga alayon gikan sa nasod, isulod ang duha ka-titik nga ISO nga code sa nasod Gamita `country=user` aron makuha ang mga alayon para sa nasod sa gamiton nga tiggamit awtomatiko
limit	Limitahi ang gidaghanon sa mga alayon nga mabalik. Makatabang kini nga paspason ang imong mga tawag sa API. Ang default mao ang 2500 ug ang pinakataas mao ang 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	Ibalik lang ang mga field sa alayon nga imong gikinahanglan. Gamita ang lista nga gipagkamao sa komo, pananglitan `&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	Boolean (tinuod\|sayop). Gamita ang tinuod kung gusto mo usab ang mga alayon nga gi-markahan para sa offerwall. Ang mga alayon nga CPC magpabilin nga wala ug ang mga alayon nga boost-click magpadayon sa ilang normal nga ranggo.
device	Gamita kini kung dili ka gamita og awtomatikong pag-target sa device. Sa default, ang API makapabalik sa tanan nga klase sa device. Gamita kini nga field aron sa piho lang nga mga klase sa device ang mabalik. Magamit nga mga balor: ios, android, mobile, ug desktop. Ang Device pwede usab nga lista nga gipagkamao sa komo, pananglitan: `&device=ios,android,mobile,desktop` Para makakuha lang og mga alayon nga CPI / CPE (nga nanginahanglan lang og pag-instalar alang sa konbersiyon - gamita device=ios,android Gamita `device=user` aron makuha ang mga alayon para sa device sa gamiton nga tiggamit awtomatiko
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. Ikaduhang variable sa subid alang sa dugang nga datos Ikatulong variable sa subid alang sa dugang nga datos
gaid / idfa	Kung naa kay Google Advertising ID (GAID) para sa mobile, gamita kini nga variable aron awtomatikong mapuno ang gaid sa imong tracking link Kung naa kay Apple Identifier For Advertisers (IDFA) para sa mobile, gamita kini nga variable aron awtomatikong mapuno ang idfa sa imong tracking link
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag

{
    "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": []
        }
    ]
}

Pananglitan sa code

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

API sa mga Konbersiyon

Limitasyon: 1 hangyo kada minuto
Ang API sa Konbersiyon naghatag kanimo og kapabilidad nga iping ang CPAlead aron mosusi sa mga konbersiyon, mapuslanon sa paghimo og mga custom nga aplikasyon. Ihatag ang subid isip subid o IP address, o "user" aron ang atong system magamit ang IP address sa kliyente nga mitawag niining script (mapuslanon para sa mga tawag sa JSONP)
Para sa serbisyo sa konbersiyon nga tipo push (Server-to-Server Postback), tan-awa ang among Dokumentasyon sa Postback

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Gikinahanglan. Tan-awa ang konbersiyon pinaagi sa subid, ihatag ang subid o IP address sa gamiton, ihatag ang "user" aron magamit ang IP address sa kliyente nga mitawag niining script (mapuslanon para sa mga tawag sa JSONP)
offer_id	Opsyonal. Susiha lang ang konbersiyon para niining ID sa alayon (kampanya)
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag

03

API sa mga Pagbalik

Limitasyon: 1 hangyo kada minuto
Gamita kini nga API aron ma-download ang imong lista sa daotang mga lead taliwala sa duha ka mga petsa. Mapuslanon ni sa paghan-ay sa daotang trapiko

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Petsa sa sinugdanan nga gamiton sa pagkuha sa daotang mga lead. Porma: yyyy-mm-dd
end_date	Petsa sa katapusan nga gamiton sa pagkuha sa daotang mga lead. Hangtod lang sa usa ka bulan ang pwede makuha sa usa ka panahon
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag

Publisher API Documentation

What this API is designed for

API sa mga Alayon

API sa mga Konbersiyon

API sa mga Pagbalik