Introduction

In other documents we have looked at how to use APIs to pull content into your client-side environment. Feed Builder allows you to specify in advance the criteria that are used to pull in and update your web pages or app automatically whenever those criteria are fulfilled. It effectively moves a number of the API query parameters into the Cortex CMS interface, giving more control to the administrator. In practice, a developer could create an API call for articles which includes all the query parameters to do the job of Feed Builder; however, building the feed within Cortex is intuitive and simple for an administrator.

Using Feed Builder in API calls

Below are the common API calls you are most likely to need in working with Feed Builder.

1. To return a list of all articles specified by a feed:

💻

GET {environment-id}/v1/feeds/{feedId}/execute

In which:

{environment-id} is the URL for stage (test) or production (live).

• Stage: https://stage-article-cms.cortextech.io
• Production: https://article-cms.cortextech.io
• Production (US environment): https://article-cms.cortextech.us

{feedId} is the feed ID, assigned when the feed is created. It can be found in the Feed Builder section of the Cortex platform.

So, for example, the following call fetches a list of all the articles in the feed with feed ID: 66bcbd7bf3c88b846af52d5b. The current settings for this feed in Feed Builder are such that it will return a list of articles that are in the category News.

💻

GET https://article-cms.cortextech.io/v1/feeds/66bcbd7bf3c88b846af52d5b/execute

API Call Options

A developer calling a feed can paginate, specify page size, and sort, as well as specify a language and set of fallback languages. This can be done in the following format.

💻

GET {environment-id}/v1/feeds/{feedId}/execute?page={page}&size={size}&sort={sortField}&language={language}&?fallbackLanguages={fallbackLanguages}

{page} is the index of the page to return. The default is page=0, meaning only one page - the first page - should be returned.

{size} is the page size. To limit and manage the size of the data, it is recommended never to exceed a value greater than 1000 items. The default is 100. For example, by default the API call includes singlePage=false&page=0&size=100. This means the call is requesting articles, it is requesting one page of articles - the first page - and that each page comprises 100 content items.

{sortField} is a string representing the sort options. Possible values are slug, Technically it is possible to sort on any field, however in practical terms, the most commonly used are publishDate and pinned. Putting a '-' in front of the parameter will sort in descending order. The default sort option is to sort, firstly, by whether the article is pinned or not, and then by publication date (in descending order); so: -pinned,-publishDate

{language} is a code for the declared language for the article, set from a drop-down list in Cortex, and following the BCP-47 standard.

{fallbackLanguages} is the list of fallback languages, to be used if there is no version of a given article available in the primary language. Fallback languages should be comma separated, and specified in the order in which they should be prioritised.

For example, the following call will return the second page, at ten items-per-page, of articles or pages from the feed with ID 66bcbd7bf3c88b846af52d5b where the locale is set to either Spanish or Spanish (Spain).

💻

GET https://article-cms.cortextech.io/v1/feeds/66bcbd7bf3c88b846af52d5b/execute?page=1&size=10&language=es&fallbackLanguages=es-ES