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


Parameetrid

Esitatud parameetrite väärtused peavad olema URL kodeeritud.



 

Parameeter

Väärtus

start_at

Laetava ajaloo alguskuupäev. Kohustulik. Väärtus peab olema UNIX’i aeg.

end_at

Ajaloo lõppkuupäev. Kohustulik. Väärtus peab olema UNIX’i aeg, ei tohi olla väiksem kui start_at välja väärtus.

offset Nn. lehekülje number, mis algab numbrist 0. Näiteks väärtus 0 annab kontaktid alatest 0-st kuni 10000-ni; 1 annab alates 10001-st kuni 20000-ni. Parameetri puudumisel omistatakse väljale väärtus 0.
limit Kontaktide arv ühel “leheküljel”. Parameetri puudumisel (või väärtuse 0 omistamisel) piirangut ei rakendata, vaid tagastatakse kõik tulemused. Suuremat väärtust kui 10000 veaks ei peeta, vaid kasutatakse vaikimisi maksimaalset lubatud väärtust.

Vastuse väljad

Vastus tagastatakse tegevuste jada, mis sisaldab objekte järgmiste väljadega. Objektid on sorteeritud time välja järgi kasvavalt.



 

Väli

Väärtus

email

Kontakti e-posti aadress.

time

Kontaktiga seotud tegevuse kuupäev.

campaign_id

Postituse ID.

campaign_name

Postituse nimetus.

value

Täiendav lisainfo tegevuse kohta.

action

Tegevuse tüüp. Võimalikud väärtused on - optinmodifyviewsendclickoptoutcomplaint,

 bounce.

Näidispäring:

Kontakide ajaloo laadimine

Esitatakse päring kontaktidega seotud tegevuste laadimiseks ajavahemikus alates 13. detsember 2015 kell 16:45 kuni 15. detsember 2015 kell 16:45.


$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<alamdomeen>.sendsmaily.net/api/history.php';
$query = 'start_at=1450025100&end_at=1450197900';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $location . '?' . $query);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");

$result = curl_exec($ch);
curl_close($ch); 

  

Eduka päringu tulemusena saadud vastus: 


{
  'code': 101,
  'message': 'OK'
}

 

Vaata ka võimalikke vastuseid.


Tegevuse tüübid



   

Tegevus

Kirjeldus

bounce Kirja ebaõnnestunud kohaletoimetamine. Andmeväli value sisaldab serverilt saadud SMTP vastuskoodi. Levinumad veateated

click

Kontakt klõpsas postituse lingil. Andmeväli value sisaldab aadressi, millel kontakt klõpsas.

complaint

Kontakt märkis postituse rämpspostiks.

modify

Kontakti andmeid muudeti. Andmeväli value sisaldab kontakti uusi andmeid.

optin

Kontakt lisati Smaily andmebaasi.

optout

Kontakt lahkus postituse saajate hulgast.

send

Kontaktile saadeti kiri.

view

Kontakt avas uudiskirja. Andmeväli value sisaldab kontakti operatsioonisüsteemi, meilikliendi, IP-aadressi ja riigi infot.