SmartEmailing API Popis způsobu používání služby
1 Historie dokumentu 1 Historie dokumentu Datum 05.01.2010 17.06.2011 18.06.2011 Doplnění metody pro hromadné vložení kontak tů Popis Průběžný vývoj 27.06.2011 Doplnění informací o zabezpečení spojení a.net třídě HttpWebRequest 26.09.2011 Doplnění parametru notmatchingcontacts do synchronizace seznamu 08.11.2011 Doplnění metody Smazání vlastního pole Získání základních informací doplnění newsletterid a viewurl Získaní pokročilých statistických informací doplnění viewurl 16.11.2011 Doplnění metody Vytvoření emailové kampaně 17.11.2011 Doplnění metody Změna evidovaných vlastních polí v seznamu 30.12.2011 Získání základních informací doplnění lastopentime a lastopensubscriber Získaní pokročilých statistických informací doplnění lastopentime a lastopensubscriber 07.03.2012 Získání detailních informací o kontaktu podle Id doplnění dalších informací 09.03.2012 20.03.2012 Doplnění metody Hromadné smazání kontaktů Získání všech kontaktů v seznamu - doplnění možnosti získání všech informací o kontaktech Oprava chyby v popisu metody Získání všech kontaktů v seznamu ID seznamu je definováno v poli mailinglist Doplnění ID uživatele a ID seznamu do odpovědi metody Získaní statistiky vrácených zpráv 27.03.2012 Získání všech kontaktů v seznamu - doplnění možnosti získání informací ve formátu JSON 24.04.2012 Oprava parametru z mailinglistid na mailinglist v přehledu uzlů v metodě Přidání kontaktu do seznamu kontaktů Oprava parametru pro příznak, zda vracet detaily o kontaktech ve formátu JSON v popisu metody Získání všech kontaktů v seznamu 05.05.2012 V metodě Získání všech kontaktů v seznamu lze seznam definovat pomocí jeho jména 11.05.2012 Doplnění metody Získání událostí kontaktu 15.05.2012 V metodě Získání všech kontaktů v seznamu doplněn volitelný parametr skipemptycustomfields 18.05.2012 Doplnění parametru updated a návratových hodnot confirmed a updated do metody Získání všech kontaktů v seznamu 10.06.2012 Doplnění funkce Získaní statistiky doručených, ale neotevřených emailů 18.06.2012 Doplnění funkce Získaní statistiky doručených, ale neotevřených emailů v CSV souboru nahraného na FTP 24.07.2012 Doplnění ID události do odpovědi metody Získání událostí kontaktu 2
1 Historie dokumentu Obsah 1 Historie dokumentu...2 2 Základní informace...5 2.1 Požadavky na klientský systém...5 2.2 Zasílání XML requestů...5 2.3 Zabezpečení spojení...5 2.4 Získávání XML odpovědí ze systému...6 2.5 Odpověď po neúspěšném zpracování...6 2.6 Vzorový příklad připojení z PHP...6 3 Přehled podporovaných operací...8 3.1 Ověření přihlašovacích údajů...8 3.2 Přidání kontaktu do seznamu kontaktů...8 3.3 Hromadné přidání kontaktů...10 3.4 Smazání kontaktu ze seznamu kontaktů...12 3.5 Hromadné smazání kontaktů...12 3.6 Update kontaktu...13 3.7 Hromadný update kontaktů...15 3.8 Získání všech kontaktů v seznamu...18 3.9 Získání událostí kontaktu...19 3.10 Získaní informací o vlastních polích...20 3.11 Získaní informací o dostupných seznamech kontaktů...21 3.12 Získaní informace, zda se kontakt nachází v seznamu...22 3.13 Získání detailních informací o kontaktu podle Id...23 3.14 Získání detailních informací o kontaktu podle e-mailu...24 3.15 Získaní základních statistických informací...25 3.16 Získaní pokročilých statistických informací...27 3.17 Získaní statistiky otevřených zpráv...29 3.18 Získaní statistiky vrácených zpráv...30 3.19 Získaní statistiky kliknutí na odkazy...32 3.20 Získaní statistiky odhlášení e-mailů...33 3.21 Získaní statistiky doručených, ale neotevřených emailů...34 3.22 Získaní statistiky otevřených zpráv v CSV souboru nahraného na FTP...35 3.23 Získaní statistiky vrácených zpráv v CSV souboru nahraného na FTP...36 3.24 Získaní statistiky kliknutí na odkazy v CSV souboru nahraného na FTP...38 3.25 Získaní statistiky odhlášení e-mailů v CSV souboru nahraného na FTP...39 3.26 Získaní statistiky doručených, ale neotevřených emailů v CSV souboru nahraného na FTP...41 3.27 Získání Id uživatele...42 3.28 Založení nového seznamu...43 3
1 Historie dokumentu 3.29 Smazání seznamu...45 3.30 Založení segmentu...45 3.31 Vytvoření vlastního pole...47 3.32 Smazání vlastního pole...48 3.33 Změna evidovaných vlastních polí v seznamu...49 3.34 Synchronizace kontaktů v seznamu...50 3.35 Vytvoření emailové kampaně...53 4 Vlastní pole...55 4.1 Formáty vlastních polí...55 4.2 Předdefinovaná vlastní pole...55 4
2 Základní informace 2 Základní informace SmartEmailing API je služba umožňující uživatelům pomocí zasílaných XML požadavků vzdáleně spouštět funkce systému SmartEmailing. SmartEmailing poskytuje možnost automaticky aktualizovat a používat systém bez nutnosti fyzického přístupu. Použitím obecného a ve většině programovacích jazyků podporovaného značkovacího jazyka můžete propojit SmartEmailing s prakticky každou aplikací. Následují obecné poznámky týkající se celého systému: systém standardně pracuje s kódováním UTF-8 jednotlivé kontakty a seznamy kontaktů jsou na sobě nezávislé - kontakt na jeden subjekt v jednom se může lišit od kontaktu na stejný subjekt v jiném seznamu 2.1 Požadavky na klientský systém Použitý programovací jazyk musí mít podporu pro přenos dat s podporou protokolu HTTP. Nejznámější knihovnou tohoto druhu je pravděpodobně curl. Alternativou na platformě.net je například třída HttpWebRequest. 2.2 Zasílání XML requestů Veškerá komunikace je realizovaná pomocí HTTP protokolu. Žádosti jsou odesílány na předem určenou adresu jako POST požadavek obsahující XML feed s potřebnými údaji. Uživatelské jméno pro XML API je stejné jako přihlašovací jméno do webového prostředí, XML token Vám bude zaslán po objednání služby. URL API je https://admin.smartemailing.cz/xml.php, v případě jiné adresy vám bude URL sdělena samostatně. V příkladech v tomto dokumentu budou jako autentizační údaje použity fiktivní přístupy: URL: https://admin.smartemailing.cz/xml.php Username: mycroft Usertoken: c0d646874b2153d236a4d1816e3501176c69c5ce Není-li uvedeno jinak, jsou všechny uvedené položky v zasílané XML žádosti povinné. U těchto položek také záleží na pořadí, ve kterém jsou zaslány. Je-li u daného uzlu uvedeno, že je vyžadováno, znamená to, že systém očekává neprázdnou hodnotu (tedy např. i 0). 2.3 Zabezpečení spojení Pro komunikaci s API je možné využít jak nešifrované, tak šifrované spojení (doporučujeme). Podle typu spojení se řídí adresa, na kterou se zasílají API požadavky: https://admin.smartemailing.cz/xml.php šifrované spojení http://admin.smartemailing.cz/xml.php nešifrované spojení Při použití zabezpečeného kanálu pak šifrování komunikace probíhá automaticky (viz kapitola 5
2.3 Zabezpečení spojení Princip na stránce http://cs.wikipedia.org/wiki/ssl). Naše společnosti používá certifikáty podepsané certifikační autoritou Network Solutions, LLC. 2.4 Získávání XML odpovědí ze systému XML odpovědi systému jsou: v návratové hodnotě funkce odesílající XML žádost (v případě PHP se jedná o funkci curl_exec() při použití PHP knihoven SmartEmailing získáte XML odpověď voláním metody getresponse() příslušného objektu 2.5 Odpověď po neúspěšném zpracování Pokud byla zaslána neplatná XML žádost (důvodem mohou být např. neplatné přihlašovací údaje, chybějící povinné pole, neplatná hodnota, nepovolený znak, nevalidní XML atd.), systém vrací stavovou zprávu ve formátu XML, která má následující formát: status - stav, v případě neúspěchu bude mít hodnotu ERROR errormessage - textová zpráva vysvětlující, proč se operace nezdařila 2.6 Vzorový příklad připojení z PHP Následující příklad demonstruje připojení k XML API pomocí PHP. Jedná se o přidání kontaktu do seznamu (jednotlivé parametry jsou uvedeny v příslušné kapitole). S ostatními podporovanými operacemi se pracuje obdobně. <?php $xml = ' <requesttype>subscribers</requesttype> <requestmethod>addsubscribertolist</requestmethod> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> <format>html</format> <confirmed>yes</confirmed> <status>active</status> <customfields> <item> <fieldid>2</fieldid> <value>marek</value> </item> <item> <fieldid>3</fieldid> <value>šudák</value> </item> <item> <fieldid>33</fieldid> <value>http://www.smartemailing.cz/</value> </item> </customfields> 6
2.6 Vzorový příklad připojení z PHP '; $ch = curl_init('https://admin.smartemailing.cz/xml.php'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result = @curl_exec($ch); if($result === false) { echo "Chyba v zasilani XML requestu!"; } else { $xml_doc = simplexml_load_string($result); echo 'Status is ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { echo 'Operace uspesna, Id uzivatele je '. $xml_doc->data; } else { echo 'Operace neuspesna, chybova hlaska: '. $xml_doc->errormessage; } }?> 7
3 Přehled podporovaných operací 3 Přehled podporovaných operací 3.1 Ověření přihlašovacích údajů 3.1.1 Základní informace Struktura XML dokumentu pro přidání kontaktu je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_users) requestmethod název volané funkce (TestCredentials) 3.1.2 Odpověď po úspěšném zpracování Po úspěšném uložení kontatku do databáze SmartEmailing systém vrací XML s následující data - zpráva o úspěšné autentizaci ( Authentication successful. ) 3.1.3 Vzorový XML požadavek <requesttype>sm_users</requesttype> <requestmethod>testcredentials</requestmethod> 3.2 Přidání kontaktu do seznamu kontaktů 3.2.1 Základní informace Struktura XML dokumentu pro přidání kontaktu je následující: requesttype název komponenty mající na starosti příslušnou oblast (subscribers) 8
3.2 Přidání kontaktu do seznamu kontaktů requestmethod název volané funkce (AddSubscriberToList) emailaddress e-mailová adresa kontaktu (vyžadováno) mailinglist Id seznamu kontaktů, kam je nový kontakt přidáván (vyžadováno) confirmed stav potvrzení. Možné hodnoty jsou [1 0]. Pole není vyžadováno, standardně nastaveno na stav nepotvrzen. format formát podporovaných e-mailových zpráv. Možné hodnoty jsou [html text]. Pole není vyžadováno, standardně nastaveno na text. status status kontaktu (active bounced unsunscribed). Pole není vyžadováno, standardně nastaveno na active. customfields - vlastní pole item fieldid id vlastního pole (vyžadováno) value - hodnota vkládáná do vlastního pole (vyžadováno) Pokud zadáváte hodnotu typu zaškrtávací pole, pro zaškrtnutí zadejte její slovní reprezentaci (např. ano nebo souhlasím aj.). Pro případ nezaškrtnutí nechte uzel value bez hodnoty. Pro přidání každého uživatele musí být zaslán samostatný požadavek. 3.2.2 Odpověď po úspěšném zpracování Po úspěšném uložení kontatku do databáze SmartEmailing systém vrací XML s následující data Id kontaktu v systému SmartEmailing 3.2.3 Vzorový XML požadavek <requesttype>subscribers</requesttype> <requestmethod>addsubscribertolist</requestmethod> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> <format>html</format> <confirmed>yes</confirmed> <status>active</status> <customfields> <item> <fieldid>2</fieldid> <value>marek</value> </item> 9
3.2 Přidání kontaktu do seznamu kontaktů <item> <fieldid>3</fieldid> <value>šudák</value> </item> <item> <fieldid>33</fieldid> <value>http://www.smartemailing.cz/</value> </item> </customfields> 3.3 Hromadné přidání kontaktů 3.3.1 Základní informace Metoda slouží pro rychlejší naplnění seznamů kontakty nemusí se pro každý kontakt posílat samostatný request. Struktura XML dokumentu pro přidání kontaktu je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_subscribers) requestmethod název volané funkce (AddSubscribers) contacts details emailaddress e-mailová adresa kontaktu (vyžadováno) mailinglistid Id seznamu kontaktů, kam je nový kontakt přidáván (vyžadováno) confirmed stav potvrzení. Možné hodnoty jsou [1 0]. Pole není vyžadováno, standardně nastaveno na stav nepotvrzen. format formát podporovaných e-mailových zpráv. Možné hodnoty jsou [html text]. Pole není vyžadováno, standardně nastaveno na text. status status kontaktu (active bounced unsunscribed). Pole není vyžadováno, standardně nastaveno na active. customfields - vlastní pole item fieldid id vlastního pole (vyžadováno) value - hodnota vkládáná do vlastního pole (vyžadováno) Pokud zadáváte hodnotu typu zaškrtávací pole, pro zaškrtnutí zadejte její slovní reprezentaci (např. ano nebo souhlasím aj.). 10
3.3 Hromadné přidání kontaktů Pro případ nezaškrtnutí nechte uzel value bez hodnoty. 3.3.2 Odpověď po úspěšném zpracování Po úspěšném uložení kontatku do databáze SmartEmailing systém vrací XML s následující data 1 3.3.3 Vzorový XML požadavek <requesttype>sm_subscribers</requesttype> <requestmethod>addsubscribers</requestmethod> <contacts> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> <format>html</format> <confirmed>1</confirmed> <status>active</status> <customfields> <item> <fieldid>2</fieldid> <value>marek</value> </item> <item> <fieldid>3</fieldid> <value>šudák</value> </item> </customfields> <emailaddress>david@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> <format>html</format> <confirmed>1</confirmed> <status>active</status> <customfields> <item> <fieldid>2</fieldid> <value>david</value> </item> <item> <fieldid>3</fieldid> <value>kirš</value> </item> </customfields> </contacts> 11
3.4 Smazání kontaktu ze seznamu kontaktů 3.4 Smazání kontaktu ze seznamu kontaktů 3.4.1 Základní informace Struktura XML dokumentu pro přidání kontaktu je následující: requesttype název komponenty mající na starosti příslušnou oblast (subscribers) requestmethod název volané funkce (DeleteSubscriber) emailaddress e-mailová adresa kontaktu (vyžadováno) mailinglistid Id seznamu kontaktů, odkud je kontakt mazán (vyžadováno) 3.4.2 Odpověď po úspěšném zpracování Po úspěšném uložení kontatku do databáze SmartEmailing systém vrací XML s následující data item - Počet smazaných záznamů 3.4.3 Vzorový XML požadavek Tento požadavek smaže ze seznamu kontaktů s Id 50 uživatele s e-mailem marek@smartemailing.cz. <requesttype>subscribers</requesttype> <requestmethod>deletesubscriber</requestmethod> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> 3.5 Hromadné smazání kontaktů 3.5.1 Základní informace Struktura XML dokumentu pro přidání kontaktu je následující: 12
3.5 Hromadné smazání kontaktů requesttype název komponenty mající na starosti příslušnou oblast (sm_subscribers) requestmethod název volané funkce (DeleteSubscribers) subscribers (vyžadováno) emailaddress e-mailová adresa kontaktu (vyžadováno) mailinglistid Id seznamu kontaktů, odkud je kontakt mazán (vyžadováno) 3.5.2 Odpověď po úspěšném zpracování Po úspěšném uložení kontatku do databáze SmartEmailing systém vrací XML s následující data 1 3.5.3 Vzorový XML požadavek <requesttype>subscribers</requesttype> <requestmethod>deletesubscriber</requestmethod> <subscriber> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> </subscriber> <subscriber> <emailaddress>david@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> </subscriber> 3.6 Update kontaktu 3.6.1 Základní informace Struktura XML dokumentu pro přidání kontaktu je následující: 13
3.6 Update kontaktu requesttype název komponenty mající na starosti příslušnou oblast (sm_subscribers) requestmethod název volané funkce (UpdateSubscriber) notexists_error příznak, zda v případě, že kontakt neexistuje, vracet chybu. Možné hodnoty jsou [1 0]. update_base_data příznak, zda aktualizovat základní data o kontaktu (e-mailová adresa, stav potvrzení, formát zpráv); potlačení aktualizace má pozitivní dopad na rychlost zpracování požadavku. Možné hodnoty jsou [1 0]. update_custom_fields příznak, zda aktualizovat vlastní pole kontaktu; potlačení aktualizace má pozitivní dopad na rychlost zpracování požadavku. Možné hodnoty jsou [1 0]. emailaddress e-mailová adresa kontaktu (vyžadováno) mailinglistid Id seznamu kontaktů, ve kterém je kontakt aktualizován (vyžadováno) newemailaddress nová e-mailová adresa confirmed stav potvrzení. Možné hodnoty jsou [1 0]. Poznámky: format formát podporovaných e-mailových zpráv. Možné hodnoty jsou [html text] status status kontaktu (active bounced unsunscribed). Pole není vyžadováno, standardně nastaveno na active. customfields - vlastní pole item fieldid Id vlastního pole (vyžadováno) value - hodnota vkládáná do vlastního pole (vyžadováno) Pokud zadáváte hodnotu typu zaškrtávací pole, pro zaškrtnutí zadejte její slovní reprezentaci (např. ano nebo souhlasím aj.). Pro případ nezaškrtnutí nechte uzel value bez hodnoty. 1. Pro update každého uživatele musí být zaslán samostatný požadavek. 2. V případě, že některý z údajů necháte nevyplněný, zůstane zachována původní hodnota. 3. Updatem nelze změnit seznam, do kterého je kontakt zařazen. Jeden kontakt zařazen do dvou různých seznamů je v systému považován za dvě různé entity. 3.6.2 Odpověď po úspěšném zpracování Po úspěšném uložení kontaktu do databáze SmartEmailing systém vrací XML s následující 14
3.6 Update kontaktu data Id kontaktu v systému SmartEmailing V případě, že kontakt nebyl v databázi nalezen, ale bylo nastaveno, aby systém jeho existenci neověřoval (pomocí parametru notexists_error), aplikace vrací místo Id kontaktu hodnotu -1. 3.6.3 Vzorový XML požadavek <requesttype>sm_subscribers</requesttype> <requestmethod>updatesubscriber</requestmethod> <update_base_data>1</update_base_data> <update_custom_fields>1</update_custom_fields> <notexists_error>1</notexists_error> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> <format>html</format> <confirmed>yes</confirmed> <status>active</status> <customfields> <item> <fieldid>2</fieldid> <value>marek</value> </item> <item> <fieldid>3</fieldid> <value>šudák</value> </item> <item> <fieldid>33</fieldid> <value>http://www.smartemailing.cz/</value> </item> </customfields> 3.7 Hromadný update kontaktů Pokud aktualizujete informace o více kontaktech zároveň, je možné použít hromadný update, který by měl zkrátit celkovou dobu zpracování (nemusí se stále navazovat síťové spojení + zasílat požadavky/odpovědi). Maximální velikost XML requestu, který můžete zaslat, je 64M, je doporučeno zasílat řádově menší požadavky - pokud bude pro aplikaci zpracování požadavku paměťově příliš náročné, bez varování spojení přeruší. Ostatní informace zůstávají stejné jako v případě jednoduchého updatu kontaktu. Struktura XML dokumentu pro hromadnou aktualizaci kontaktů je následující: 15
3.7 Hromadný update kontaktů requesttype název komponenty mající na starosti příslušnou oblast (sm_subscribers) requestmethod název volané funkce (UpdateSubscribers) notexists_error příznak, zda kontrolovat existenci kontaktů. Možné hodnoty jsou [1 0]. V případě, že bude parametr nastaven na 1 a některý z kontaktů nebude existovat, update se přeruší a aplikace vrátí chybu. V opačném případě se bude kontakt ignorovat a přejde se na update dalšího. contacts (vyžadováno) update_base_data příznak, zda aktualizovat základní data o kontaktu (emailová adresa, stav potvrzení, formát zpráv); potlačení aktualizace má pozitivní dopad na rychlost zpracování požadavku. Možné hodnoty jsou [1 0]. update_custom_fields příznak, zda aktualizovat vlastní pole kontaktu; potlačení aktualizace má pozitivní dopad na rychlost zpracování požadavku. Možné hodnoty jsou [1 0]. emailaddress e-mailová adresa kontaktu (vyžadováno) mailinglistid Id seznamu kontaktů, ve kterém je kontakt aktualizován (vyžadováno) newemailaddress nová e-mailová adresa confirmed stav potvrzení. Možné hodnoty jsou [1 0]. format formát podporovaných e-mailových zpráv. Možné hodnoty jsou [html text] status status kontaktu (active bounced unsunscribed). Pole není vyžadováno, standardně nastaveno na active. customfields - vlastní pole item fieldid Id vlastního pole (vyžadováno) value - hodnota vkládáná do vlastního pole (vyžadováno) Pokud zadáváte hodnotu typu zaškrtávací pole, pro zaškrtnutí zadejte její slovní reprezentaci (např. ano nebo souhlasím aj.). Pro případ nezaškrtnutí nechte uzel value bez hodnoty. 3.7.1 Odpověď po úspěšném zpracování Po úspěšném uložení změn do databáze SmartEmailing systém vrací XML s následující 16
3.7 Hromadný update kontaktů data 1 3.7.2 Vzorový XML požadavek <requesttype>sm_subscribers</requesttype> <requestmethod>updatesubscribers</requestmethod> <notexists_error>1</notexists_error> <contacts> <update_base_data>1</update_base_data> <update_custom_fields>1</update_custom_fields> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> <format>html</format> <confirmed>yes</confirmed> <status>active</status> <customfields> <item> <fieldid>2</fieldid> <value>marek</value> </item> <item> <fieldid>3</fieldid> <value>šudák</value> </item> </customfields> <update_base_data>1</update_base_data> <update_custom_fields>1</update_custom_fields> <emailaddress>david@smartemailing.cz</emailaddress> <mailinglist>50</mailinglist> <format>html</format> <confirmed>yes</confirmed> <status>unsubscribed</status> <customfields> <item> <fieldid>2</fieldid> <value>david</value> </item> <item> <fieldid>3</fieldid> <value>kirš</value> </item> </customfields> </contacts> 17
3.8 Získání všech kontaktů v seznamu 3.8 Získání všech kontaktů v seznamu 3.8.1 Základní informace Struktura XML dokumentu pro získání všech kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_lists) requestmethod název volané funkce (GetSubscribers) mailinglist ID seznamu kontaktů nebo jeho jméno (vyžadováno) fullinfo Příznak, zda vracet kompletní informace o kontaktu (včetně vlastních polí) - [0 1] returndataasjson Příznak, zda vracet detaily o kontaktech ve formátu JSON [0 1] skipemptycustomfields v případě, že je nastaven příznak fullinfo (API vrací i vlastní pole), zapnutí tohoto příznaku způsobí, že budou vynechána vlastní pole neobsahující žádnou hodnotu [0 1]; nevyžadováno standardně nastaveno na 0 updated unixové časové razítko poslední změny; v případě, že je uvedeno, metoda vrátí jen ty kontakty, které byly vytvořeny nebo aktualizovány po tomto čase (včetně) 3.8.2 Odpověď po úspěšném zpracování V případě neexistujícího nebo negativního příznaku fullinfo vrací systém odpověď: data Informace o kontaktechv systému SmartEmailing item subscriberid - Id kontaktu emailaddress - e-mailová adresa kontaktu status stav kontaktu (active = aktivní, bounced = nedostupný, unsubscribed = odhlášený) confirmed příznak, zda je kontakt veden jako potvrzený updated časové razítko poslední změny údajů kontaktu Pokud je příznak fullinfo pozitivní, informace o kontaktu uvnitř uzlu item mají stejnou strukturu jako v případě metody Získání detailních informací o kontaktu podle Id. 18
3.8 Získání všech kontaktů v seznamu 3.8.3 Vzorový XML požadavek <requesttype>sm_lists</requesttype> <requestmethod>getsubscribers</requestmethod> <mailinglist>50</mailinglist> <fullinfo>0</fullinfo> <returndataasjson>0</returndataasjson> <skipemptycustomfields>1</skipemptycustomfields> <updated>1337358871</updated> 3.9 Získání událostí kontaktu 3.9.1 Základní informace Struktura XML dokumentu pro získaní informací o vlastních polích je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_subscribers) requestmethod název volané funkce (GetEvents) subscriberid ID kontaktu emailaddress emailová adresa kontaktu listid ID seznamu Kontakt, o němž chcete získat záznam událostí, je možné definovat buď pomocí jeho ID (subscriberid) nebo kombinací emailové adresy (emailaddress) a ID seznamu (listid). 3.9.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data item eventid ID události subscriberid ID kontaktu 19
3.9 Získání událostí kontaktu eventtype typ události Odeslaná emailová kampaň Otevřená emailová kampaň Odeslaná SmartKampaň Otevřená SmartKampaň Navštívený odkaz z emailu eventsubject popis události eventdate časové razítko události 3.9.3 Vzorový XML požadavek <requesttype>sm_subscribers</requesttype> <requestmethod>getevents</requestmethod> <subscriberid>50</subscriberid> nebo <requesttype>sm_subscribers</requesttype> <requestmethod>getevents</requestmethod> <emailaddress>marek@smartemailing.cz</emailaddress> <listid>50</listid> 3.10 Získaní informací o vlastních polích 3.10.1 Základní informace Struktura XML dokumentu pro získaní informací o vlastních polích je následující: requesttype název komponenty mající na starosti příslušnou oblast (lists) requestmethod název volané funkce (GetCustomFields) 20
3.10 Získaní informací o vlastních polích listids Id seznamu, o jehož vlastních polích jsou vyžadovány informace (vyžadováno) 3.10.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data item fieldid Id vlastního pole name název vlastního pole fieldtype typ pole (text, číslo, atd.). defaultvalue výchozí hodnota pole (pokud byla zadána) required příznak, zda je vyplnění pole povinné (1 nebo 0). fieldsettings serializovaná data o nastavení vlastního polec (minimální délka, maximální délka atd.) ownerid - Id uživatele, který pole vytvořil createdate - datum vytvoření vlastního pole ve formátu unixového časového razítka (počet vteřin od 1.1.1970) 3.10.3 Vzorový XML požadavek <requesttype>lists</requesttype> <requestmethod>getcustomfields</requestmethod> <listids>50</listids> 3.11 Získaní informací o dostupných seznamech kontaktů 3.11.1 Základní informace Struktura XML dokumentu pro získaní informací o dostupných seznamech kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (user) 21
3.11 Získaní informací o dostupných seznamech kontaktů requestmethod název volané funkce (GetLists) - počáteční a koncová značka nesmí být na jednom řádku + sekce musí obsahovat alespoň jeden znak (např. mezeru) 3.11.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data item listid Id seznamu kontaků name název seznamu subscribecount počet aktivních kontaktů unsubscribecount počet neaktivních kontaktů autorespondercount počet autoodpovídačů přiřazených k seznamu 3.11.3 Vzorový XML požadavek <requesttype>user</requesttype> <requestmethod>getlists</requestmethod> 3.12 Získaní informace, zda se kontakt nachází v seznamu 3.12.1 Základní informace Struktura XML dokumentu pro získaní informací o dostupných seznamech kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_lists) requestmethod název volané funkce (IsSubscriberInList) emailaddress e-mailová adresa kontaktu (vyžadováno) mailinglistid Id seznamu, proti kterému je kontakt ověřován (vyžadováno) 22
3.12 Získaní informace, zda se kontakt nachází v seznamu 3.12.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data - v případě, že se kontakt v seznamu nachází, systém vrací jeho Id, v opačném případě vrací 0 3.12.3 Vzorový XML požadavek <requesttype>sm_lists</requesttype> <requestmethod>issubscriberinlist</requestmethod> <emailaddress>marek@smartemailing.cz</emailaddress> <mailinglistid>759</mailinglistid> 3.13 Získání detailních informací o kontaktu podle Id 3.13.1 Základní informace Struktura XML dokumentu pro získaní informací o dostupných seznamech kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_subscribers) requestmethod název volané funkce (GetSubscriber) subscriberid Id kontaktu Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data subscriberid Id kontaktu listid Id seznamu, ve kterém je kontakt zařazen 23
3.13 Získání detailních informací o kontaktu podle Id emailaddress e-mailová adresa format formát podporovaných e-mailových zpráv. Možné hodnoty jsou h pro HTML formát a t pro textový formát. confirmed - příznak, zda je kontakt potvrzen [1 0] confirmcode potvrzovací kód (používaný např. v odhlašovacích odkazech) requestdate - časové razítko zařazení kontaktu do seznamu requestip IP adresa přidání kontaktu do seznamu (přes formulář; v případě doplnění přes webové rozhraní prázdné) confirmdate - časové razítko potvrzení kontaktu (v případě dvojitého opt-in potvrzení) confirmip IP adresa potvrzení kontaktu (v případě dvojitého opt-in potvrzení) subscribedate - časové razítko přidání kontaktu do seznamu bounced - časové razítko označení kontaktu za nedostupného unsubscribed - časové razítko odhlášení kontaktu unsubscribeconfirmed - časové razítko potvrzení odhlášení kontaktu formid ID formuláře, přes který byl kontakt přidán customfields - vlastní pole item fieldid id vlastního pole name - název vlastního pole value - hodnota vlastního pole 3.13.2 Vzorový XML požadavek <requesttype>sm_subscribers</requesttype> <requestmethod>getsubscriber</requestmethod> <subscriberid>5698448</subscriberid> 3.14 Získání detailních informací o kontaktu podle e-mailu 3.14.1 Základní informace Struktura XML dokumentu pro získaní informací o dostupných seznamech kontaktů je následující: 24
3.14 Získání detailních informací o kontaktu podle e-mailu requesttype název komponenty mající na starosti příslušnou oblast (sm_lists) requestmethod název volané funkce (GetSubscriberByEmail) emailaddress E-mailová adresa kontaktu listid - Id seznamu kontaktů Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML se stejnou strukturou jako metoda Získání detailních informací o kontaktu podle Id. 3.14.2 Vzorový XML požadavek <requesttype>sm_subscribers</requesttype> <requestmethod>getsubscriberbyemail</requestmethod> <emailaddress>marek@smartemailing.cz</emailaddress> <listid>1304</listid> 3.15 Získaní základních statistických informací Získané informace, především statid (Id záznamu) můžete použít v dalším dotazu Získaní pokročilých statistických informací. 3.15.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (stats) requestmethod název volané funkce (GetNewsletterStats) listids (vyžadováno) - Id seznamu kontaktů, o němž chcete získat statistiky sortinfo - informace o řazení záznamů; standardně se záznamy řadí podle data a času ukončení kampaně sestupně sortby - název pole, podle kterého se mají záznamy řadit. Možné hodnoty jsou: newsletter - název kampaně 25
3.15 Získaní základních statistických informací list - název kontaktního seznamu startdate - zahájení rozesílání kampaně finishdate - ukončení rozesílání kampaně recipients - počet aktivních kontaktů unsubscribes - počet odhlášených odběratelů bounces - počet nedoručených e-mailů direction - směr řazení (asc desc) countonly - příznak, zda má systém vrátit jen počet záznamů a ne jejich data (1 0) start - stránkovací parametr - od kolikátého záznamu má výpis začít perpage - stránkovací parametr - kolik záznamů má být vráceno 3.15.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující strukturou (jednotlivé záznamy se nachází v uzlech item): data newsletterid - ID kampaně statid - Id statistického záznamu starttime - časové razítko začatku odesílání finishtime - časové razítko konce odesílání htmlrecipients - počet kontaktů, na které byly zaslány e-maily ve formátu HTML textrecipients - počet kontaktů, na který byly zaslány e-maily v textovém formátu multipartrecipients - počet kontaktů, na který byly zaslány e-maily ve formátu plain text i HTML sendsize - Celkový počet odeslaných e-mailů bouncecount_soft - počet vracených zpráv soft - např. plná e-mailová schránka bouncecount_hard - počet vrácených zpráv hard - např. e-maliová adresa neexistuje bouncecount_unknown - počet zpráv vrácených z neznámého důvodu unsubscribercount - počet odhlášených odběratelů newslettername - název kampaně listname - název seznamu kontaktů viewurl adresa náhledu kampaně 26
3.15 Získaní základních statistických informací lastopentime časové razítko posledního otevření kampaně lastopensubscriber - emailová adresa kontaktu, který naposledy otevřel kampaň 3.15.3 Vzorový XML požadavek <requesttype>stats</requesttype> <requestmethod>getnewsletterstats</requestmethod> <listids>50</listids> <sortinfo> <sortby></sortby> <direction></direction> </sortinfo> <countonly></countonly> <start></start> <perpage></perpage> 3.16 Získaní pokročilých statistických informací 3.16.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (stats) requestmethod název volané funkce (FetchStats) statid (vyžadováno) - Id statistiky - dostupné pomocí Získaní základních statistických informací statstype (vyžadováno) - typ vstupu o němž chcete získat statistiku (newsletter autoresponder) 3.16.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data statid - Id záznamu, jehož statistické údaje se mají načíst 27
3.16 Získaní pokročilých statistických informací queueid - Id fronty, do které bylo odesílání zařazeno jobid - Id operace starttime - časové razítko začatku odesílání finishtime - časové razítko konce odesílání htmlrecipients - počet kontaktů, na které byly zaslány e-maily ve formátu HTML textrecipients - počet kontaktů, na který byly zaslány e-maily v textovém formátu multipartrecipients - počet kontaktů, na který byly zaslány e-maily ve formátu plain text i HTML trackopens - počet sledovaných e-mailů tracklinks - počet sledovaných odkazů bouncecount_soft - počet vracených zpráv soft - např. plná e-mailová schránka bouncecount_hard - počet vrácených zpráv hard - např. e-maliová adresa neexistuje bouncecount_unkown - počet zpráv vrácených z neznámého důvodu newsletterid - Id kampaně sendfromname - jméno odesílatele sendfromemail - e-mailová adresa odesílatele bounceemail - emailová adresa přijímající vrácené zprávy replytoemail - e-mailová adresa v hlavičce Odpověď charset - použité kódování e-mailu sendinformation - serializované informace o odeslání sendsize - Celkový počet odeslaných e-mailů sentby - Id odesílatele notifyowner - příznak, zda měl odesílatel dostávat zpětnou vazbu o rozeslání kampaně linkclicks - počet kliknutí na odkazy emailopens - počet otevřených e-mailů emailforwards - počet přeposlaných e-mailů emailopens_unique - počet unikátních otevření htmlopens - počet otevřených HTML e-mailů htmlopens_unique - počet unikátních otevření e-mailů textopens - počet otevřených textových e-mailů textopens_unique - počet unikátních otevření textových e-mailů 28
3.16 Získaní pokročilých statistických informací hiddenby sendtestmode - příznak, zda bylo odeslání kampaně testovací (1 0) sendtype - typ kampaně (newsletter autoresponder) viewurl adresa náhledu kampaně Lists - soupis seznamů kontaktů, na které byl e-mail odeslán item item lastopentime časové razítko posledního otevření kampaně lastopensubscriber - emailová adresa kontaktu, který naposledy otevřel kampaň 3.16.3 Vzorový XML požadavek <requesttype>stats</requesttype> <requestmethod>fetchstats</requestmethod> <statid>967</statid> <statstype>newsletter</statstype> 3.17 Získaní statistiky otevřených zpráv 3.17.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (stats) requestmethod název volané funkce (GetOpens) statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu onlyunique - příznak, zda vracet pouze unikátní ověření (1 0) calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu count_only - Příznak, zda vracet pouze počet záznamů vyhovujícím podmínkám (1 29
3.17 Získaní statistiky otevřených zpráv 0) order_by - řazení záznamů (standardně opentime) order_dir - směr řazení záznamů (standardně DESC) 3.17.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data item emailaddress - emailová adresa kontaktu opentime - časové razítko otevření e-mailu openip - IP adresa otevření e-mailu opentype - formát otevřené zprávy (h pro HTML, t pro text) 3.17.3 Vzorový XML požadavek <requesttype>stats</requesttype> <requestmethod>getopens</requestmethod> <statid>1062</statid> <start>0</start> <perpage>9999</perpage> <only_unique>0</only_unique> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> <order_by>opentime</order_by> <order_dir>desc</order_dir> 3.18 Získaní statistiky vrácených zpráv 3.18.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_stats) requestmethod název volané funkce (GetBouncesLang) 30
3.18 Získaní statistiky vrácených zpráv statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu bounce_type - typ odmítnutí zpráv (hard soft any) calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu count_only - Příznak, zda vrace pouze počet zaznamů vyhovujícím podmínkám (1 0) order_by - řazení záznamů (standardně bouncetime) order_dir - směr řazení záznamů (standardně DESC) lang - jazyk, do kterého mají být přeloženy zprávy o důvodu vrácení (cs) 3.18.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data item emailaddress - emailová adresa kontaktu subscriberid - ID kontaktu listid - ID seznamu bouncetime - časové razítko odmítnutí e-mailu bouncetype - typ odmítnutí zprávy bouncerule - pravidlo, podle kterého byla zpráva odmítnuta bouncemessage - zpráva o důvodu vrácení e-mailů 3.18.3 Vzorový XML požadavek <requesttype>sm_stats</requesttype> <requestmethod>getbounceslang</requestmethod> <statid>967</statid> <start>0</start> <perpage>9999</perpage> <bounce_type>any</bounce_type> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> 31
3.18 Získaní statistiky vrácených zpráv <order_by>bouncetime</order_by> <order_dir>desc</order_dir> 3.19 Získaní statistiky kliknutí na odkazy 3.19.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (stats) requestmethod název volané funkce (GetClicks) statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu linkid - Id odkazu (pro všechny odkazy a) order_by - řazení záznamů (standardně clicktime) order_dir - směr řazení záznamů (standardně DESC) 3.19.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data item emailaddress - emailová adresa kontaktu clicktime - časové razítko kliknutí na odkaz clickip - IP adresa kliknutí na odkaz url - URL odkazu 3.19.3 Vzorový XML požadavek 32
3.19 Získaní statistiky kliknutí na odkazy <requesttype>stats</requesttype> <requestmethod>getclicks</requestmethod> <statid>967</statid> <start>0</start> <perpage>9999</perpage> <linkid>a</linkid> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> <order_by>clicktime</order_by> <order_dir>desc</order_dir> 3.20 Získaní statistiky odhlášení e-mailů 3.20.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (stats) requestmethod název volané funkce (GetUnsubscribes) statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu count_only - Příznak, zda vrace pouze počet zaznamů vyhovujícím podmínkám (1 0) order_by - řazení záznamů (standardně unsubscribetime) order_dir - směr řazení záznamů (standardně DESC) 3.20.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data item 33
3.20 Získaní statistiky odhlášení e-mailů emailaddress - emailová adresa kontaktu unsubscribetime - časové razítko odhlášení unsubscribeip - IP adresa odhlášení url - URL odkazu 3.20.3 Vzorový XML požadavek <requesttype>stats</requesttype> <requestmethod>getunsubscribes</requestmethod> <statid>967</statid> <start>0</start> <perpage>9999</perpage> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> <order_by>unsubscribetime</order_by> <order_dir>desc</order_dir> 3.21 Získaní statistiky doručených, ale neotevřených emailů 3.21.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_stats) requestmethod název volané funkce (GetDeliveredButNotOpened) statid - ID záznamu, jehož statistické údaje se mají načíst newsletterid ID kampaně, jejíž statistické údaje se mají načíst V detailech je nutné uvést jeden z údajů statid, newsletterid. V případě, že je specifikována emailová kampaň pomocí newsletterid, systém vrací statistiku posledního odeslání kampaně (jednu kampaň je možné v aplikaci odeslat vícekrát). 3.21.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující 34
3.21 Získaní statistiky doručených, ale neotevřených emailů data item subscriberid ID kontaktu emailaddress - emailová adresa kontaktu listid ID seznamu, do kterého kontakt patří 3.21.3 Vzorový XML požadavek <requesttype>sm_stats</requesttype> <requestmethod>getdeliveredbutnotopened</requestmethod> <newsletterid>12345</newsletterid> 3.22 Získaní statistiky otevřených zpráv v CSV souboru nahraného na FTP 3.22.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_stats) requestmethod název volané funkce (GetOpensCsv) statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu onlyunique - příznak, zda vracet pouze unikátní ověření (1 0) calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu count_only - Příznak, zda vracet pouze počet záznamů vyhovujícím podmínkám (1 0) order_by - řazení záznamů (standardně opentime) order_dir - směr řazení záznamů (standardně DESC) delimiter - oddělovací znak mezi jednotlivými poli v CSV souboru (standardně ;) 35
3.22 Získaní statistiky otevřených zpráv v CSV souboru nahraného na FTP enclosure - znak pro obalení každého pole, standardně ftp_server - název FTP serveru pro upload statistik ftp_username - přihlašovací jméno k FTP serveru (USER) ftp_password - heslo k FTP serveru (PASS) insert_col_names - Příznak, zda do výsledného CSV souboru vkládat názvy polí (0 1) 3.22.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data file - URL vygenerovaného CSV souboru entries_count - Počet vyexportovaných záznamů 3.22.3 Vzorový XML požadavek <requesttype>sm_stats</requesttype> <requestmethod>getopenscsv</requestmethod> <statid>967</statid> <start>0</start> <perpage>9999</perpage> <only_unique>0</only_unique> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> <order_by>opentime</order_by> <order_dir>desc</order_dir> <delimiter>;</delimiter> <enclosure>"</enclosure> <ftp_server>xxx</ftp_server> <ftp_username>xxx</ftp_username> <ftp_password>xxx</ftp_password> <insert_col_names>1</insert_col_names> 3.23 Získaní statistiky vrácených zpráv v CSV souboru nahraného na FTP 3.23.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: 36
3.23 Získaní statistiky vrácených zpráv v CSV souboru nahraného na FTP requesttype název komponenty mající na starosti příslušnou oblast (sm_stats) requestmethod název volané funkce (GetBouncesCsv) statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu bounce_type - typ odmítnutí zpráv (hard soft any) calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu count_only - Příznak, zda vrace pouze počet zaznamů vyhovujícím podmínkám (1 0) order_by - řazení záznamů (standardně bouncetime) order_dir - směr řazení záznamů (standardně DESC) delimiter - oddělovací znak mezi jednotlivými poli v CSV souboru (standardně ;) enclosure - znak pro obalení každého pole, standardně ftp_server - název FTP serveru pro upload statistik ftp_username - přihlašovací jméno k FTP serveru (USER) ftp_password - heslo k FTP serveru (PASS) lang - jazyk, do kterého mají být přeloženy zprávy o nedoručení e-mailu (cs) insert_col_names - Příznak, zda do výsledného CSV souboru vkládat názvy polí (0 1) 3.23.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data file - URL vygenerovaného CSV souboru entries_count - Počet vyexportovaných záznamů 3.23.3 Vzorový XML požadavek 37
3.23 Získaní statistiky vrácených zpráv v CSV souboru nahraného na FTP <requesttype>sm_stats</requesttype> <requestmethod>getbouncescsv</requestmethod> <statid>967</statid> <start>0</start> <perpage>9999</perpage> <bounce_type>any</bounce_type> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> <order_by>bouncetime</order_by> <order_dir>desc</order_dir> <delimiter>;</delimiter> <enclosure>"</enclosure> <ftp_server>xxx</ftp_server> <ftp_username>xxx</ftp_username> <ftp_password>xxx</ftp_password> <lang>cs</lang> <insert_col_names>1</insert_col_names> 3.24 Získaní statistiky kliknutí na odkazy v CSV souboru nahraného na FTP 3.24.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_stats) requestmethod název volané funkce (GetClicksCsv) statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu linkid - Id odkazu (pro všechny odkazy a) order_by - řazení záznamů (standardně clicktime) order_dir - směr řazení záznamů (standardně DESC) delimiter - oddělovací znak mezi jednotlivými poli v CSV souboru (standardně ;) enclosure - znak pro obalení každého pole, standardně ftp_server - název FTP serveru pro upload statistik ftp_username - přihlašovací jméno k FTP serveru (USER) ftp_password - heslo k FTP serveru (PASS) 38
3.24 Získaní statistiky kliknutí na odkazy v CSV souboru nahraného na FTP insert_col_names - Příznak, zda do výsledného CSV souboru vkládat názvy polí (0 1) 3.24.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data file - URL vygenerovaného CSV souboru entries_count - Počet vyexportovaných záznamů 3.24.3 Vzorový XML požadavek <requesttype>sm_stats</requesttype> <requestmethod>getclickscsv</requestmethod> <statid>967</statid> <start>0</start> <perpage>9999</perpage> <linkid>a</linkid> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> <order_by>clicktime</order_by> <order_dir>desc</order_dir> <delimiter>;</delimiter> <enclosure>"</enclosure> <ftp_server>xxx</ftp_server> <ftp_username>xxx</ftp_username> <ftp_password>xxx</ftp_password> 3.25 Získaní statistiky odhlášení e-mailů v CSV souboru nahraného na FTP 3.25.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_stats) requestmethod název volané funkce (GetUnsubscribesCsv) 39
3.25 Získaní statistiky odhlášení e-mailů v CSV souboru nahraného na FTP statid - Id záznamu, jehož statistické údaje se mají načíst start - počáteční offset záznamu, od kterého se mají výsledky vracet perpage - koncový offset záznamu calendar_restrictions - rozsah datumů, z kterých brát data v SQL formátu count_only - Příznak, zda vrace pouze počet zaznamů vyhovujícím podmínkám (1 0) order_by - řazení záznamů (standardně unsubscribetime) order_dir - směr řazení záznamů (standardně DESC) delimiter - oddělovací znak mezi jednotlivými poli v CSV souboru (standardně ;) enclosure - znak pro obalení každého pole, standardně ftp_server - název FTP serveru pro upload statistik ftp_username - přihlašovací jméno k FTP serveru (USER) ftp_password - heslo k FTP serveru (PASS) insert_col_names - Příznak, zda do výsledného CSV souboru vkládat názvy polí (0 1) 3.25.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data file - URL vygenerovaného CSV souboru entries_count - Počet vyexportovaných záznamů 3.25.3 Vzorový XML požadavek <requesttype>sm_stats</requesttype> <requestmethod>getunsubscribescsv</requestmethod> <statid>967</statid> <start>0</start> <perpage>9999</perpage> <calendar_restrictions></calendar_restrictions> <count_only>0</count_only> <order_by>unsubscribetime</order_by> <order_dir>desc</order_dir> <delimiter>;</delimiter> <enclosure>"</enclosure> 40
3.25 Získaní statistiky odhlášení e-mailů v CSV souboru nahraného na FTP <ftp_server>xxx</ftp_server> <ftp_username>xxx</ftp_username> <ftp_password>xxx</ftp_password> <lang>cs</lang> <insert_col_names>1</insert_col_names> 3.26 Získaní statistiky doručených, ale neotevřených emailů v CSV souboru nahraného na FTP 3.26.1 Základní informace Struktura XML dokumentu pro získaní statistických informací o kontaktů je následující: requesttype název komponenty mající na starosti příslušnou oblast (sm_stats) requestmethod název volané funkce (GetDeliveredButNotOpenedCsv) statid - ID záznamu, jehož statistické údaje se mají načíst newsletterid ID kampaně, jejíž statistické údaje se mají načíst delimiter - oddělovací znak mezi jednotlivými poli v CSV souboru (standardně ;) enclosure - znak pro obalení každého pole, standardně ftp_server - název FTP serveru pro upload statistik ftp_username - přihlašovací jméno k FTP serveru (USER) ftp_password - heslo k FTP serveru (PASS) insert_col_names - Příznak, zda do výsledného CSV souboru vkládat názvy polí (0 1) V detailech je nutné uvést jeden z údajů statid, newsletterid. V případě, že je specifikována emailová kampaň pomocí newsletterid, systém vrací statistiku posledního odeslání kampaně (jednu kampaň je možné v aplikaci odeslat vícekrát). 3.26.2 Odpověď po úspěšném zpracování Po úspěšném zavolání a provedení dotazu systém SmartEmailing vrací XML s následující data file - URL vygenerovaného CSV souboru 41