RSS Feed API Documentation

Endpoint

GET https://content.api.sandbox.sportal365.com/editorial-content/rss

Description

This endpoint provides an RSS feed of editorial content, allowing you to retrieve and filter various types of content such as articles, videos, galleries, and liveblogs.

Note: This endpoint is versatile and can be used to create RSS feeds for different purposes:

A general feed for all editorial content on your website
A specific feed for a particular category or section of your site
A targeted feed based on tags or other criteria

By adjusting the query parameters, you can customize the feed to match the content structure of your website.

Important: For most use cases, you should include status=active&published_at=active in your query parameters to filter out content that is not meant to appear publicly.

Required Headers

Project: Your project identifier (string)

Required Query Parameters

title: The title for the RSS feed (string)
link: The link to the section on your website (string)
description: A brief description of the RSS feed (string)

Example:

https://content.api.sandbox.sportal365.com/editorial-content/rss?title=Sportal365%20Sports%20News&link=https://demo.sportal365.com/football/&description=Latest%20sports%20news%20and%20updates&status=active&published_at=active

Optional Query Parameters

Content Filtering

entity_type: Filter by content types (array of strings)
- Possible values: ARTICLE, VIDEO, GALLERY, LIVEBLOG
- Default: Returns all types
- Example: entity_type=ARTICLE,VIDEO
category_ids: Filter by category IDs (string, comma-separated)
- Example: category_ids=123,456,789
tag_type: Filter by tag type (string)
- Must be used in conjunction with tag_ids
- Example: tag_type=EDITORIAL_TAG
tag_ids: Filter by tag IDs (string, comma-separated)
- Must be used in conjunction with tag_type
- Example: tag_ids=101,102,103

Other Filters

limit: Number of items to return (string, default: "10")
page: Page number for pagination (string, default: "1")
sort_order: Sort order (string, default: "DESC")
team_ids: Filter by team IDs (string, comma-separated)
coach_ids: Filter by coach IDs (string, comma-separated)
player_ids: Filter by player IDs (string, comma-separated)
competition_ids: Filter by competition IDs (string, comma-separated)
sport_event_ids: Filter by sport event IDs (string, comma-separated)
author_ids: Filter by author IDs (string, comma-separated)
from: Retrieve content with start_time after this date (string)
to: Retrieve content with start_time before this date (string)
updated_after: Retrieve content updated after this time (string)
language: Filter by language (string)
status: Filter by status (string, comma-separated, e.g., "active,inactive")
published_at: Filter by publish date (string, currently only supports 'active')
type: Filter by content type (string, comma-separated, e.g., "SPORT_EVENT,news,Tennis")

Examples

General feed for all active and published editorial content:

https://content.api.sandbox.sportal365.com/editorial-content/rss?title=Sportal365%20All%20News&link=https://demo.sportal365.com/&description=All%20the%20latest%20news%20and%20updates&status=active&published_at=active

Filtering by category IDs (for a category page feed):

https://content.api.sandbox.sportal365.com/editorial-content/rss?title=Sportal365%20Football&link=https://demo.sportal365.com/football/&description=Football%20news&category_ids=123,456&status=active&published_at=active

Filtering by tag type and tag IDs (for a tag page feed):

https://content.api.sandbox.sportal365.com/editorial-content/rss?title=Sportal365%20Tagged%20Content&link=https://demo.sportal365.com/tagged/&description=Tagged%20content&tag_type=EDITORIAL_TAG&tag_ids=101,102,103&status=active&published_at=active

Response

The API returns an RSS 2.0 feed with the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
  <channel>
    <title>Your specified title</title>
    <link>Your specified link</link>
    <description>Your specified description</description>
    <lastBuildDate>Thu, 01 Aug 2024 06:48:42 +0000</lastBuildDate>
    <language>en-US</language>
    <item>
      <title>Article Title</title>
      <description><![CDATA[<img src="IMAGE_URL" alt="IMAGE_DESCRIPTION"/> Article subtitle or excerpt]]></description>
      <link>https://your-site.com/article-url</link>
      <guid>unique-content-id</guid>
      <pubDate>Wed, 21 Aug 2024 09:56:33 GMT</pubDate>
      <author>Author Name</author>
    </item>
    <!-- More items... -->
  </channel>
</rss>

Note: The feed is updated every 5 minutes.

Error Responses

400: Invalid request parameters (e.g., limit out of range)