RSS Feed Resource

The RSS feed resources provide RSS 2.0 feeds for stream and component data, and support aggregating external RSS feeds into GroveStreams.

Stream RSS feeds return data formatted as RSS 2.0 XML with each data point represented as an item in the feed. Component RSS feeds aggregate all streams within a component into a single feed.

The RSS reader endpoints allow GroveStreams to consume and parse external RSS feeds, extracting time-value pairs for ingestion into streams.

GET component/{compUid}/stream/{streamUid}/feed/rss.xml

---

Returns an RSS 2.0 XML feed for a single stream. Each data point in the stream is represented as an item in the RSS feed with the timestamp as the publication date and the value as the item description.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible?	Yes

Parameters

none

Example Requests

/component/d251a8f2-f7b9-4df7-886d-b24c7f4929d4/stream/a3b1c8e0-1234-5678-abcd-ef0123456789/feed/rss.xml

Response Body
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
   <channel>
     <title>Stream Feed</title>
     <item>
       <title>Value</title>
       <description>72.5</description>
       <pubDate>Mon, 01 Jan 2024 12:00:00 GMT</pubDate>
     </item>
   </channel>
</rss>

GET component/{compUid}/feed/rss.xml

---

Returns an RSS 2.0 XML feed for all streams within a component. Each stream's data points are represented as items in the RSS feed.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible?	Yes

Parameters

none

Example Requests

/component/d251a8f2-f7b9-4df7-886d-b24c7f4929d4/feed/rss.xml

GET rss/reader

---

Aggregates one or more external RSS feeds. Fetches and parses the specified RSS feed URLs and returns the combined feed content. Multiple feeds can be aggregated by repeating the url parameter.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible?	Yes

Parameters

url

required

The URL of an external RSS feed to aggregate. Must be URL encoded. Can be repeated for multiple feeds. Example: /rss/reader?url=http%3A%2F%2Fexample.com%2Ffeed.xml&url=http%3A%2F%2Fexample2.com%2Ffeed.xml

Example Requests

/rss/reader?url=http%3A%2F%2Fexample.com%2Ffeed.xml

PUT rss/reader/test

---

Tests RSS feed parsing. Accepts a JSON request body containing an RSS reader configuration, fetches the configured RSS feed, parses it, and returns extracted time-value pairs. Use this endpoint to validate RSS reader settings before saving them.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible?	Yes

Parameters

none

Example Requests

/rss/reader/test

Request Body
{
   "rss_reader": {
     "url": "http://example.com/feed.xml",
     "titlePath": "title",
     "valuePath": "description"
   }
}

Response Body
{
   "success": true,
   "message": "",
   "time_value_pairs": [
     {
       "time": 1704067200000,
       "value": "72.5"
     },
     {
       "time": 1704070800000,
       "value": "73.1"
     }
   ]
}