https://<alamdomeen>.sendsmaily.net/api/campaign.php


Nimekirjas olevad postitused on järjestatud loomiskuupäeva järgi, kasvavalt.


Parameetrid

Esitatud parameetrite väärtused peavad olema URL kodeeritud.


Väli

Väärtus

limit

Päringus tagastatavate kirjete arvu piirang. Kui parameeter on määramata või väärtuseks on 0, siis piirangut ei rakendata ning tagastatakse kõik kirjed.

page

Kirjete komplekti määraja. Rakendub ainult siis, kui limit väli “tõest” väärtust. Vaikimisi väärtuseks on 1.

status

Kirjete filtreerimine staatuse järgi. Võimalikud väärtused on: DRAFT, PENDING, COMPLETED. Korraga mitme väärtuse määramiseks lisa URI parameetritesse status kujul status[]=DRAFT&status[]=PENDING.

 tags Kirjete filtreerimine sildi järgi. Korraga mitme vääruse määramiseks lisada URI parameetritesse  tags kujul tags[]=Tag1&tags[]=Tag2.

sort_by

Väli, mille järgi laetud kirjeid sorteeritakse. Hetkel võimalik vaid created_at väärtuse kasutamine, mida rakendatakse ka vaikimisi.

sort_order

Kirjete sorteerimise suund. Võimalikud väärtused on: ASC - kasvav järjestus; DESC - kahanev järjestus. Vaikimisi sorteeritakse kirjeid kasvavas järjestuses.

Vastuse väljad

Väli

Väärtus

id

Postituse unikaalne tunnus. Numbriline väärtus.

name

Kirja subjekt.

template

Postituses kasutatud kirjapõhi. Väärtus võib olla kas jada või DELETED. Viimase puhul on kirjapõhi süsteemist kustutatud.

 - id

Kirjapõhja ID.

 - preview_url

Viide kirjapõhja eelvaatele.

tags Siltide nimed.

created_at

Postituse loomiskuupäev. Formaadis AAAA-KK-PP HH:MM:SS.

completed_at

Postituse valmis saamise kuupäev. Väli on täidetud ainult COMPLETED staatust omavatel postitustel. Formaadis AAAA-KK-PP HH:MM:SS.

status

Postituse staatus. Võimalikud väärtused on: DRAFT - mustand; PENDING - postituse saatmine käib; COMPLETED - postitus on kohale toimetatud/valmis.