/rssfeed GET

Overview

Consumes an RSS feed as a proxy and returns the feed up to a certain number of entries.

Request Arguments

Name	Type	Description	Required
feed_url	String	A fully qualified URL to an RSS feed.	True
limit	Integer	Maximum number of entries to fetch. If not provided, the API will return up to `$sugar_config['rss_feed_max_entries']` or 20 if no config option is set.	False

Request

http://{site_url}/rest/v10/rssfeed?feed_url=http%3A%2F%2Ffqd.rssfeed.url%2F&limit=10

Note: GET endpoint parameters are passed in the form of a query string.

Response Arguments

Name	Type	Description
title	String	The title of the RSS Feed. This can be blank.
link	String	The URL to the source of the RSS Feed. This can be blank.
description	String	A description of the feed. This can be blank.
publication_date	Timestamp	A timestamp of when the feed was published.
entries	Array	An array of entries, each of which will contain the following values: title description link publication_date source author

Response

{
    "feed":{
        "title":"Sample Feed Title",
        "link":"http:\/\/www.samplefeed.com\/feed-link-url.htm",
        "description":"A sample of a feed description",
        "publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
        "entries":[
            {
                "title":"First entry title",
                "description":"A blurb about the first entry. This will be HTML encoded on return.",
                "link":"http:\/\/www.samplefeed.com\/feed-entry-1.htm",
                "publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
                "source":"Reuters",
                "author":"John Doe"
            },
            {
                "title":"Second entry title",
                "description":"A blurb about the Second entry. This will be HTML encoded on return.",
                "link":"http:\/\/www.samplefeed.com\/feed-entry-2.htm",
                "publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
                "source":"BBC",
                "author":""
            }
        ]
    }
}

Change Log

Version	Change
v10	Added `/<rssfeed>` GET endpoint.