Sailthru Docs

api:product-453q4523

Will Farrell — Mon, 14 May 2012 15:34:51 -0500

Overview Push a new piece of content to Sailthru, or update an existing piece of content, triggering any applicable alerts. Specification Base URL https://api.sailthru.com/content POST mode Required Parameters Parameter Description Example url The unique URL of the content Optional Parameters Parameter Description Example title The human-friendly title of the content Name of Product date The created time of the content (if not provided, defa…

syntax:link-rewriting

Danny — Fri, 27 Apr 2012 14:25:50 -0500

If you create a link that contains Zephyr code as part of the link, such as http://example.com/path?email={email} The link is bundled together as a single distinct rewritten link. Therefore you can track the performance of that link across users, rather than have it render and track as thousands or millions of different individual links.

function:social_share

Praj Tuladhar — Sat, 21 Apr 2012 22:07:23 -0500

social_share(string share_mode, string url_text) Returns a URL that contains a link that will allow the user to share url in Twitter or Facebook. For example, you could have separate links to individually "like" each of the articles in your newsletter.

api:technical-details

Ian White — Sat, 21 Apr 2012 17:03:18 -0500

We recommend that you use our pre-existing API Libraries for using our API. These libraries are debugged and in widespread use. But, there are situations where you may need or want to write your own library, or otherwise directly access the API. This document explains the details.

api:job

Ian White — Sat, 21 Apr 2012 17:01:23 -0500

Overview Start, or get the status of, a background job, such as a data import or export. Jobs are asynchronous -- they may take minutes or hours to run, depending on how large they are. Therefore, the job POST call will return a job_id, which you can use later to request the current status of the job with the GET call.

api:user

Ian White — Fri, 20 Apr 2012 11:47:00 -0500

Get or set information about one of your users. This is a more advanced version of the email API call, and can be used even for users who do not have email addresses. Base URL https://api.sailthru.com/user GET mode Get information about one of your users.

function

Ian White — Wed, 18 Apr 2012 22:52:30 -0500

* abs - return the absolute value of a number * ad - return the HTML of an adFlight ad placement * adinfo - return meta information about an adFlight ad placement * contains - return whether a list or string contains an item or substring * bucket_list - move elements of a list into separate "buckets" based on criteria * date - return a formatted date * filter - apply a lambda function to filter out elements of a list * first - get the first word in a string or first element of a l…

horizon:concierge

Will Farrell — Tue, 17 Apr 2012 18:12:36 -0500

The easiest way to set up the Concierge is to use our Concierge Setup Wizard. Alternatively, you can follow the steps below. Step 1: Horizon If you haven't already, you must setup Horizon, Sailthru's behavioral intelligence tool, on your site. Once you've done so, proceed with the following instructions.

function:api_user

Praj Tuladhar — Fri, 13 Apr 2012 15:46:29 -0500

api_user(options, [, email]) Make a user API Request * options A Key/Value Hash containing one or all items * key the key type of id, (see keys) * fields the fields to return (see fields) * keys set some or all of the user keys (see keys) * keysconflict define behavior if keys conflict with existing keys (see keysconflict) * lists key/value hash; each key is the name of a list, and each value is 1 to subscribe the user from that list and 0 to remove the user from the list…

trigger

Praj Tuladhar — Fri, 13 Apr 2012 15:42:08 -0500

Overview A trigger, more specifically a transactional trigger, allows you to execute an action in Sailthru after a specific user action takes place as a result of a sent template. Sending a transactional email with an associated trigger allows automatic updating of lists, sending of transactional emails, and even the execution of custom Zephyr scripts, all which can be set to occur upon send, open, click, or purchase.

horizon:setup

Danny — Thu, 05 Apr 2012 12:36:57 -0500

New to Horizon? Learn more first. Step 1: Contact Us & Horizon CNAME * First of all, email support@sailthru.com to enable your account for Horizon data tracking. * Second, Establish a CNAME in your DNS zonefile HostSubdomainhorizon.yourdomain.comhorizon.sailthru.com * Enter your full horizon subdomain, i.e. horizon.yourdomain.com, under the "Horizon Subdomain" field in your Sailthru Account settings.

function:time

Ian White — Tue, 27 Mar 2012 14:37:02 -0500

time([][,]) When called with no parameters, returns the current UNIX timestamp (the number of seconds since January 1 1970 00:00:00 GMT). When a string input parameter is passed, attempts to convert the string to a timestamp, in a manner similar to (but not identical to) PHP's strtotime function.

function:assert - created

Ian White — Thu, 22 Mar 2012 15:44:09 -0500

assert(mixed expression[, string failuremessage]) Assert that expression is true. If expression evaluates to false, null, 0, or "", terminates execution of the Zephyr script. Terminating execution via a failed assert() will have the following consequences:

horizon:content-spider

David Studinski — Wed, 14 Mar 2012 17:14:47 -0500

Note: This page discusses content relating to Horizon, Sailthru's behavioral intelligence feature. Overview When Sailthru detects a new URL on your site that it has not seen before, it will automatically spider that URL. The spider does not "crawl" through pages automatically following links. It simply will hit new URLs once.

faq

Ben Bartholomew — Tue, 13 Mar 2012 10:22:15 -0500

* Q. What is a smart list? * A. Smart Lists are live segments. You can generate a smart list using specific criteria (such as openers, or people located in New York City) and each time a user comes on to the source list with matching criteria, they are added to the appropriate smart lists.

function:list

Ian White — Fri, 02 Mar 2012 12:34:56 -0500

list(mixed value) Converts value to a list, according to the following rules: * If passed a list, returns that list * If passed null, returns null * If passed anything else, returns list with exactly one item in it (value) Example {list([1,2,3])} ----> [1,2,3] {list("test")} ----> ["test"] {list(null)} ---->

api:purchase

David Studinski — Thu, 01 Mar 2012 15:42:05 -0500

Overview Record that a user has made a purchase, or has added items to their purchase total. You should call this when a user adds an item to their shopping cart (if you want to send abandoned-shopping-cart emails) with the incomplete parameter. Otherwise, you should call this whenever a user completes final purchase.

api

Ian White — Tue, 28 Feb 2012 17:06:54 -0500

The purpose of the sailthru API is to allow you to take full advantage of all the features of your Sailthru service as efficiently as possible. * Step 1 - Download one of our pre-built libraries for your chosen programming language - review the list at client libraries. * Step 2 - Install and configure your chosen pre-built library - for details see "Getting Started". * Step 3 - Write code inside your application to directly perform the desired Sailthru action. For example, this can oft…

api:horizon

Ian White — Tue, 28 Feb 2012 16:59:05 -0500

This API call is deprecated. You can use the user API call instead.

function:adinfo

Ian White — Sat, 25 Feb 2012 17:56:56 -0500

adinfo(string zonename) Given a zone name, returns a data structure containing information about the banner scheduled that particular zone, Ad Plan, and day of send. Will return null if no banner has been scheduled in that particular zone on that particular day, or if no Ad Plan has been set.

api:list

Danny — Fri, 24 Feb 2012 18:30:53 -0500

Overview Get information about a list, or create a list. Use of the POST method of this call to add/remove users is deprecated in favor of the job call. Specification Base URL https://api.sailthru.com/list GET mode Get information about a list. This currently includes the email addresses on the list, but this will be deprecated -- use the job call instead to export data.

data-feeds

David Studinski — Tue, 21 Feb 2012 14:22:06 -0500

Overview When sending a campaign email, it can be convenient to pull content from your site. This can help you: * Automate your email production process by designing a template once and automatically populating it with content * Schedule a daily email in advance without even knowing what the content will be * Use Sailthru Horizon personalization to deliver custom content to users

api:blast

David Studinski — Thu, 16 Feb 2012 13:40:34 -0500

Overview Schedule a mass mail blast (see "Campaign overview"), or check on the status of a previously scheduled blast. See . Specification Base URL https://api.sailthru.com/blast GET mode Get data on a single blast Parameter Description Example blast_id blast ID 34463 = Optional Parameters =

api:ad:plan

Ian White — Sun, 12 Feb 2012 17:32:21 -0500

Update, or get information about, an adFlight Plan. Base URL https://api.sailthru.com/ad/plan GET mode Get information about the plan. Required Parameter Description Example name Plan Name New York Weekdays Return Value Will return a data structure including some or all of the following information:

function:first

Ian White — Tue, 07 Feb 2012 12:28:19 -0500

first(mixed value) If passed a list, returns the first element of that list. If passed a string, returns the first word in that string (using spaces as the separator). This can be useful for extracting a user's first name from the name property.

syntax:basics

Ian White — Tue, 07 Feb 2012 12:02:07 -0500

Replacement Variables A template is normally HTML or text, with replacement variables and syntax enclosed in {curly braces} or {{double curly braces}} For example,

Your email address is: {email}!

You can pass in replacement variables as part of a send call, or set them on the email address via an email call.

api:blast_repeat

David Studinski — Fri, 03 Feb 2012 15:40:35 -0500

Repeating Blast GET mode Get data on a repeating campaign, or all repeating campaigns. Optional parameters Parameter Description Example repeat_id Repeating campaign ID 34463 If you do not pass a repeat_id, you will get a list of all repeating campaign.