Live API

Summary:

This how-to contains details about using the Marketpath CMS Live API to consume and distribute data within the same website or to external channels.

Marketpath CMS provides a Live site API that allows published content to be pulled and distributed to other channels and platforms. At this time, the Live API returns only JSON results and there is no authentication required.

Live API calls are simple GET actions. Here is the standard format:

http(s)://<domain>/mputils/<SiteGUID>/api/json/<object_type>/<ObjectGUID | "collection">?<filters...>

Examples

Retrieve a list of datastore items

In this example, we'll query for a list of datastore items from a sample datastore of vacation destinations:

https://help.marketpath.com/mputils/a894178f-28ad-4b08-947e-15c08f642963/api/json/datastore_item/collection?datastore_guid=22b7083d-d1f1-416f-8435-e5940c8c85e2&limit=10&page=1

Retrieve a list of articles

In this example we query for a list of articles with the tag "How-To":

http://help.marketpath.com/mputils/a894178f-28ad-4b08-947e-15c08f642963/api/json/article/collection?tag=How-To

Retrieve a snippet

Here we retrieve a specific snippet:

http://help.marketpath.com/mputils/a894178f-28ad-4b08-947e-15c08f642963/api/json/snippet/7c0b6497-a271-49f5-89bd-594ff0b9ed99

Object list and query parameters

Objects

article
author
blog
blog_post
calendar
calendar_entry
datastore
datastore_item
document
entity
folder
form
gallery
image
javascript
menu
snippet
stylesheet
tag
template

Query Parameters

has_url values: true | false
start_date

values: date

end_date

values: date

template_guid(s)  
template(s)  
include_in_search values: true | false
ssl_mode values: "none" | "allow" | "require"

none = http only
allow = either
require = https only
tag_guid(s)  
tag(s)  
author_guid(s)  
author(s)  
folder_guid(s)  
folder(s)  
sort_by value: text

miscellaneous fields of the specific object type (e.g. title, url, name, random, browser_title, date_created, etc)
sort_direction values: "asc" | "desc"
limit value: number

The number of results to return in the query
start value: number

The starting row number of the query results
page value: number

The results page to return