API – seznam textových kampaní (metoda campaigns)

zpět na přehled API

Metoda campaigns umožňuje číst seznam textových kampaní partnera.

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

Údaje o textové kampani

Vysvětlení jednotlivých údajů uvedených u textové kampaně:

• ID – ID kampaně
• title – název kampaně
• token – identifikace kampaně, která se vkládá jako parametr do provizních odkazů
• refererUrl – adresa WWW stránek, které jsou přiřazeny k této textové kampani v rámci detekce partnera podle HTTP referer
• createdDate – datum a čas vytvoření kampaně

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

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ů textových kampaní.

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

{
    "results": [
        {
            "ID": 300027,
            "title": "testovací kampaň",
            "token": "6kQjs8",
            "refererUrl": null,
            "createdDate": "2017-06-05 15:52:31"
        },
        {
            "ID": 300026,
            "title": "testovací referer",
            "token": "NXKSP3",
            "refererUrl": "www.example.com",
            "createdDate": "2016-11-10 15:23:55"
        }
    ],
    "page": 1,
    "count": 13,
    "filteredCount": 13,
    "totalCount": 13,
    "requestId": "1497613128.8953.7023"
}

Příklad požadavků

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

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

Vrácení textové kampaně s konkrétním ID:

https://api.wedos.as/partner/campaigns?ID=300026

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ář.