API – seznam příchodů (metoda entries)

zpět na přehled API

Metoda entries umožňuje číst seznam příchodů (prokliků) přes provizní odkazy a přes reklamní plochy.

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

Údaje o příchodu

Vysvětlení jednotlivých údajů uvedených u příchodu:

• ID – ID příchodu
• advertiserId – ID inzerenta (viz. číselník inzerentů)
• clickDate – datum a čas kliknutí
• referer – HTTP hlavička Referer (tedy URL adresa stránky, odkud klient přišel)
• textCampaignId – ID textové kampaně (při kliknutí na provizní odkaz)
• boardId – ID reklamní plochy (při kliknutí na banner na reklamní ploše)
• customId – uživatelské ID (viz. uživatelské ID v odkazech a plochách)

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

Záznamy příchodů se archivují podle roků. V aktuální databázi naleznete pouze příchody za posledních 6 měsíců. Pokud chcete vidět starší záznamy, je potřeba zvolit konkrétní archiv (rok). To učiníte parametrem archive (např. archive=2016).

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ů příchodů.

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

{
    "results": [
        {
            "ID": 50000272,
            "advertiserId": 2,
            "clickDate": "2017-05-23 10:32:19",
            "referer": "https://www.example.com/",
            "textCampaignId": 300000,
            "boardId": null,
            "customId": null
        },
        {
            "ID": 50000240,
            "advertiserId": 1,
            "clickDate": "2017-02-06 16:35:51",
            "referer": "",
            "textCampaignId": 266,
            "boardId": null,
            "customId": null
        }
    ],
    "page": 1,
    "count": 28,
    "filteredCount": 28,
    "totalCount": 28,
    "requestId": "1495637627.333.12657"
}

Příklad požadavků

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

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

Vrácení seznamu příchodů (max. 5 nejnovějších) z archivu roku 2016, které pochází z reklamní plochy s ID 666:

https://api.wedos.as/partner/entries?archive=2016&boardId=666&count=5

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

https://api.wedos.as/partner/entries?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ář.