content

Push a new piece of content to the Content Library or update the metadata of an existing piece of content.

The content API is the preferred method for passing content for both retailers and publishers, as you're able to update article or item information, such as inventory, in realtime. As an alternative, some publishers opt to enable the spidering functionality of the onsite JavaScript, which logs pages to the Content Library the first time each page is accessed, including metadata from the page. For more information, see Content and Use Feeds and Other Content Data in Templates.

Endpoint URL: https://api.sailthru.com/content

GET Mode

Examples

Get by URL

{
 "url" : "http://example.com/path/product123.html"}

Get by SKU

{
 "id":"123abc",
 "key":"sku"}

Get Most Recent

{
"items":30
}

Optional Parameters

Return Value

Will return a data structure containing the content's metadata. If the url parameter is not provided, returns the 20 most recent pieces of content.

Note: Calls requesting more than 20,000 content items are not supported and may result in an error.

POST Mode

Examples

With URL

{
    "key": "url", //unneeded but supported; default key type is url
    "id": "http://example.com/product",
    [optional parameters e.g. "title" here]
}

Legacy method -future support of this method may be limited:

{
    "url": "http://example.com/product",
    [optional parameters e.g. "title" here]
}

With URL & Additional Keys

{
    "key": "url", //unneeded but supported; default key type is url
    "id": "http://example.com/product",
    "keys": {
        "sku": "123abc"    },
    [optional parameters e.g. "title" here]    
}

Legacy method -future support of this method may be limited:

{
    "url": "http://example.com/product",
    "keys": {
    "sku": "123abc"    },
    [optional parameters e.g. "title" here]
}

Product Example

{
    "id": "http://example.com/product",
    "key": "url",
    "keys": {
        "sku": "123abc"    },
    "title": "Product Name Here",
    "description": "Product info text goes here.",
    "price": 2099,
    "inventory": 42,
    "date": "2016-06-20 14:30:00 -0400",
    "tags": "blue, jeans, size-m",
    "vars": {
        "var1": "var 1 value"    },
    "images": {
        "full": {
            "url": "http://example.com/images/product.jpg"        }
    },
    "site_name": "Store"}

Media Example

{
    "id": "http://example.com/article",
    "key": "url",
    "title": "Belichick named top coach in the NFL",
    "description": "Bill Belichick honored for role leading New England Patriots.",
    "date": "2016-06-20 14:30:00 -0400",
    "tags": "sports, football, nfl, new-england-patriots",
    "images": {
        "full": {
            "url": "http://example.com/images/story.jpg"        }
    },
    "author": "Neil Smith"}

Update a Content Item

By URL

{
    "key": "url", //unneeded but supported; default key type is url
    "id": "http://example.com/product",
    [add/update parameters here]
}

Legacy method -future support of this method may be limited:

{
    "url": "http://example.com/product",
    [add/update parameters here]
}

By URL to Add/Update SKU

{
    "key": "url", //unneeded but supported; default key type is url
    "id": "http://example.com/product",
    "keys": {
        "sku": "123abc"    }
}

By SKU

{
    "key": "sku",
    "id": "123abc",
    [add/update parameters here]
}

Override Content Spidering Rules

By URL

{
     "key": "url",     
     "id": "http://example.com/excluded",
     "title": "Something That Doesn't Pass Spider Rules",
     "override_exclude": 1
}

Conditionally Required Parameters

Optional Parameters

Return Value

Will return a data structure for the content containing all of the fields above. Note: If you push content via this call and it is not restricted by the URL Include/Exclude rules you applied, you can opt in by contacting Support. To override a single request, pass "override_exclude": 1 as part of your request.

DELETE Mode

Remove a content item from the database, including all data associated with that content item. If you have the Personalization Engine JavaScript implemented, the URL will be re-spidered the next time a user accesses that URL.Note: To delete content in bulk, see the Job API endpoint's delete_content method.

Conditionally Required Parameters