As of Summer 2019, we’ve deprecated the old way of handling article RSS feeds.
Many publishers are integrating RSS syndication as a part of their distribution strategy. With Turnstyle, we’ve tried to make RSS more flexible so that it can work for different use cases. There are several URL parameters that publishers can use to customize and filter their article feeds.
Enabling RSS for Your Title
For security purposes, RSS feeds are disabled by default. We will enable them upon request for any publisher that wishes to use them. Just contact firstname.lastname@example.org and ask to enable RSS.
Linking to Your Feed
Once RSS is enabled, the URL for a title’s feed will be determined by the format you choose (RSS vs ATOM).
RSS example: www.example.com/title/feed/rss
ATOM example: www.example.com/title/feed/atom
Customizing Your Feed
If you don’t add any parameters to your feed URL, all published articles for all issues will be included. However, publishers have the ability to customize the feed in a few different ways:
Change the number of articles per feed
The URL parameter ‘pageSize’ controls how many articles appear in the feed at one time (the default is 30). So, for example, if you wish to show 50 articles in the feed you’d format it as follows: www.example.com/title/feed/rss?pageSize=50
Sort how the articles appear in the feed
The URL parameter ‘sortBy’ controls how the articles appear in the feed (the default is by publish date/descending). The sort parameter is comprised of two sub-elements: sort value and direction. Combined, these two sub-elements will tell the RSS feed what to sort by, and which direction to sort them.
Example of sortBy using both sub-elements: sortBy=[sort value]-[sort-direction]
For example, we know the default sort filer is publishedDate-desc. Let’s say you want to show the oldest articles first. You’d add the parameter publishedDate-asc: www.example.com/title/feed/rss?pageSize=50&sortBy=publishedDate-asc
By default, articles from all categories will be pulled into the feed. If a publisher wishes to only show articles from a specific category or categories, they should use the ‘categories’ parameter. It can be a single category name or a comma-separated list of categories.
For example, say a publisher wants 50 articles from a category titled ‘Featured’. The URL would be formatted as follows: www.example.com/title/feed/rss?pageSize=50&categories=Featured
Or, if they wanted all articles from two categories: Featured and Groups – they’d format the URL as follows: www.example.com/title/feed/rss/?categories=Featured,Groups
Specify an Issue
Publishers can get an article feed from specific issues by using the ‘issue’ parameter.
Example: Get all articles from the October 2019 issue: www.example.com/title/feed/rss/?issueUrl=october_2019
The issue name can be obtained from your publisher dashboard, or by looking at the live issues URL. It is important to remember that the number of articles that appear by default is still 30. So, if the October 2019 issue has more than 30 articles you will need to add the additional pageSize parameter in order to see them all.
Example: Get all 40 articles from the October 2019 issue: www.example.com/title/feed/rss/?issueUrl=october_2019&pageSize=40
Recent Issues Only
The ‘recentIssues’ parameter should be used when a publisher wishes to pull all articles from only the most recent issues. The default number of issues for this parameter is 5. So for example, if a publisher wishes to pull all articles from the 3 latest issues, they’d format their URL as follows: www.example.com/title/feed/rss/?recentIssues=3
Keep in mind the 30 article limit! If each issue has, say, 20 articles, you’ll need to update the feed link with the pageSize parameter.
Filtering Covers and Advertisements
Publishers may not want the cover or advertisements to appear in the feed, as they don’t contain any relevant content. These can be filtered using the ‘excludeContentTypes’ parameter as follows: www.example.com/title/feed/rss?excludeContentTypes=cover,advertisement