For Developers Overview
  • API Basics
    Introduction to the API API Technical Details API Postbacks User Queries for Job and List API Error and Response Codes API Test Page
  • API Endpoints
  • API Client Libraries
    API Client Libraries Overview Java Library JavaScript API Library .NET Library Node.js Library Perl Library PHP5 Library Python Library Ruby Library
  • Zephyr Guide
    Zephyr Overview Common Zephyr Examples Zephyr Examples Library Zephyr Template Variables Zephyr Expressions And Operators Zephyr Control Structures Zephyr Assignment Operator For Variables Single Vs. Double Braces “Profile” Object “Message” Object “Blast” Object “Feed” Object Link Rewriting With Zephyr Set User Vars or List Membership On-Click with URL Parameters Forward To A Friend
  • Zephyr Functions
    Zephyr Functions Index abs ad adinfo api_event api_send api_user append_user_var assert base64_decode base64_encode bucket_list cancel compare contains content_intersect date dedupe distance exp filter filter_content first h horizon_count horizon_interest horizon_select horizon_set_interest int intersect join keys length list(function) lower load_content map md5 message_id number personalize promotion public_share push random range replace round set sha1 sha256 shuffle signup_confirm slice social_share sort split sqrt strip_tags strpos strrpos substr text time title type u upper user_engagement user_geo_home user_geo_select_region values
  • Zephyr Tutorial
    Zephyr Tutorials Lesson 1: Zephyr Basics Lesson 2: Data Basics
  • Content Triggers
    Content Triggers

    • SPM

    Site Recommendations is a personalized area of your site that may exist across any number of pages.

    For each section, you will specify:

    • A content feed and rules written in the Zephyr language to select and prepare content from the feed, for example, to filter by tag and request user-specific content recommendations.
    • A template or JSON object name.
      • If you choose to receive a JSON object of feed items, you can present the content using your own JavaScript code.
      • If you want the system to render the HTML for the section, specify template code (using Zephyr, HTML, CSS, and/or JavaScript) along with the ID of the HTML div on your page where the content will be displayed.
    • One or more optional section audiences, to vary the feed, rules, and/or template based on whether the viewer is part of a particular user list. Each audience is assigned a unique list, chosen from the lists in your account. If no audience is matched, default section parameters are used.
    Each template and set of rules is stored as a string in its own block object. Blocks are referenced by sections and can be reused across multiple sections.

    Personalization Engine Section Data Structure

    Users of my.sailthru.com can configure sections and their attributes through the site. As a developer, you can also do this using Site Personalization Manager’s block and section API endpoints.

    block

    Method Description Parameters Response
    GET Get all blocks’ data (excluding content) required: none Array of block objects: 
    [
  { 
    "id":<string>,
    "name":<string>,
    "type":<string>,
    "create_time":<string>,
    "create_user":<string>,
    "modify_time":<string>,
    "modify_user":<string>
  },
  {...}
]
    GET Get all data for a block required: id: <string> 
    {
  "id":<string>,
  "name":<string>,
  "type":<string>,
  "content":<string>,
  "create_time":<string>,
  "create_user":<string>,
  "modify_time":<string>,
  "modify_user":<string>
}
    204: if the block ID does not exist 404: if client ID does not exist or block ID is malformed
    POST Create a block required: name: <string> type: <string>
    • setup (i.e. rules), html (template), or json
    content: <string>    		 201 (created) 400/500 (on failure)
    PUT Update a block required: id: <string> optional : name: <string> type: <string>
    • setup (i.e. rules), html (template), or json
    content: <string>    		 204 (on success) 400/500 (on failure)
    DELETE Delete a block required: id: <string>
     

    section

    Method Description Parameters Response
    GET Get the array of all sections’ data excluding audience data (list, feed, blocks) required: none 
    {
  "id": ,
  "name": ,
  "create_time": ,
  "create_user": ,
  "modify_time": ,
  "modify_user": 
}
    GET Get all data for a section required: id: <string> 
    {  
  "id":,
  "name":,
  "audiences":[  
    {  
      "list_id":,
      "feed_id":,
      "blocks":[  
        {  
          "block_id":
        },
        {  
          <additional blocks>
        }
      ]
    },
    {  
      <additional audiences>
    }
  ],
  "create_time":,
  "create_user":,
  "modify_time":,
  "modify_user":
}
    POST Create a section required: name: <string> audiences: <array> 201 (created) 400/500 (on failure)
    PUT Update a section required: id: <string>optional : name: <string> audiences: <array> 204 (on success) 400/500 (on failure)
    DELETE Delete a section required: id: <string> 204 (on success; no content returned) 400/500 (on failure with error message(s) returned) 
    {
  "errormsg": <messages>
}
    Top