API – seznam pohybů na provizním účtu (metoda account)

zpět na přehled API

Metoda account umožňuje číst seznam pohybů na provizním účtu (připsané provize, bonusy, výplaty).

URL: https://api.wedos.as/partner/account

Aktuální zůstatek účtu získáte metodou partner.

Údaje o pohybu na provizním účtu

Vysvětlení jednotlivých údajů uvedených u pohybu:

• ID – ID pohybu
• advertiserId – ID inzerenta (viz. číselník inzerentů)
• createdDate – datum a čas pohybu
• entryId – ID příchodu (prokliku)
• textCampaignId – ID textové kampaně
• boardId – ID reklamní plochy
• customId – uživatelské ID (viz. uživatelské ID v odkazech a plochách)
• orderId – ID provizní objednávky
• orderNum – číslo objednávky přidělené inzerentem
• type – typ pohybu
• amount – částka (v měně partnera)
• currency – měna
• qty – množství (používá se u provize za počet zobrazení reklamních ploch)
• billId – ID vyúčtování
• billDate – datum a čas vyúčtování

Možné typy pohybu (hodnota type):

• bonus – registrační či jiný bonus
• affiliate – provize za objednávku
• referralAffiliate – referral provize za objednávku
• entryAffiliate – odměna za zobrazení reklamních ploch (placené prokliky)
• payout – výplata

Vstupní parametry (GET)

Pomocí vstupních parametrů lze filtrovat a stránkovat záznamy – viz. Seznamy v API.

Filtrovat lze podle následujících položek:

• ID
• advertiserId
• textCampaignId
• boardId
• entryId
• customId
• billId
• type

K dispozici je parametr lastID, který vrátí pouze záznamy, jejichž ID je větší než uvedená hodnota.

Dále lze ovlivnit počet a stránku vracených záznamů:

• page
• count

Výstupní data

Metoda vrací v položce results pole záznamů pohybů na provizním účtu.

Příklad odpovědi (seznam položek zkrácen):

{
    "results": [
        {
            "ID": 403644,
            "advertiserId": 2,
            "createdDate": "2017-05-22 11:31:57",
            "entryId": 50000271,
            "textCampaignId": 300000,
            "boardId": null,
            "customId": null,
            "orderId": 500894,
            "orderNum": "8151700025",
            "type": "affiliate",
            "amount": 1422.4,
            "currency": "CZK",
            "qty": null,
            "billId": null,
            "billDate": null
        },
        {
            "ID": 403584,
            "advertiserId": 2,
            "createdDate": "2017-03-31 08:23:18",
            "entryId": 50000248,
            "textCampaignId": null,
            "boardId": 30005,
            "customId": null,
            "orderId": 500826,
            "orderNum": "8171700008",
            "type": "referralAffiliate",
            "amount": 13.4,
            "currency": "CZK",
            "qty": null,
            "billId": 320,
            "billDate": "2017-04-11 16:21:50"
        },
        {
            "ID": 400142,
            "advertiserId": 2,
            "createdDate": "2016-05-31 18:02:37",
            "entryId": null,
            "textCampaignId": null,
            "boardId": null,
            "customId": null,
            "orderId": null,
            "orderNum": null,
            "type": "entryAffiliate",
            "amount": 1.4,
            "currency": "CZK",
            "qty": 2,
            "billId": 320,
            "billDate": "2017-04-11 16:21:50"
        }
    ],
    "page": 1,
    "count": 100,
    "filteredCount": 159,
    "totalCount": 502,
    "requestId": "1495648671.7985.13846"
}

Příklad požadavků

Vrácení seznamu všech pohybů (resp. prvních 100, což je výchozí stránkování):

https://api.wedos.as/partner/account

Vrácení seznamu pohybů typu affiliate (provize z objednávky), pouze posledních 10:

https://api.wedos.as/partner/account?type=affiliate&count=10

Vrácení seznamu pohybů, jejichž ID je větší než 1234:

https://api.wedos.as/partner/account?lastID=1234

Máte-li jakýkoliv problém či dotaz ohledně provizního systému, využijte diskuzní fórum (veřejně viditelné), pro soukromou komunikaci použijte kontaktní formulář.