BRbrightcovelearning
Syndications

Get a syndication

Changed on

Gets the configuration data for a syndication.

get/accounts/{{account_id}}/mrss/syndications/{syndication_id}

Request

  • Base URL
    https://social.api.brightcove.com/v1
  • URL
    https://social.api.brightcove.com/v1/accounts/{{account_id}}/mrss/syndications/{syndication_id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://oauth.brightcove.com/v4/access_token scopes: video-cloud/social/mrss/read

Path parameters

account_idstring required

ID of the account

syndication_idstring required

ID of the syndication

Response

The specified syndication.

idstring

Id of this syndication

namestring required

Name of this syndication

type'advanced' | 'google' | 'iphone' | 'ipad' | 'mp4' | 'itunes' | 'roku' | 'source' | 'universal' required

The syndication type. Valid values are [advanced, google, iphone, ipad, mp4, itunes, roku, source, universal]. Cannot be changed after syndication creation time.

include_all_contentboolean

If true, all content is included in this syndication. If false, a valid include_filter property must be specified for the syndication.

include_filterstring

A CMS video search filter string used to select the subset of content included in this syndication. The include_all_content field must be set to false if a value is specified for this property.

sortstring

A CMS video sorting specifier indicating the desired feed results return order. CMS-supported values like "name", "reference_id", "created_at", "published_at", "updated_at", "schedule.starts_at", "schedule.ends_at", "state", "plays_total", and "plays_trailing_week" can be specified. To sort in descending order, preface the value with a minus (-) sign, i.e. "-created_at". If no value is specified, the feed will be sorted by most recent updated_at date by default.

titlestring

The title of this feed. Will be included inside of the <channel> tag for some syndication types.

descriptionstring

The description of this feed. Will be included inside of the <channel> tag for some syndication types.

syndication_urlstring

The URL of this syndication's feed. Read-only.

destination_urlstring

The URL to be included inside of the <channel> tag in the feed.

keywordsstring

A comma-separated list of keywords for iTunes

authorstring

iTunes author specification

categorystring

iTunes category specification

album_art_urlstring

iTunes album art url.

explicit'yes' | 'no'

iTunes explicit content indicator, accepts "yes" or "no" values.

owner_namestring

iTunes owner name.

owner_emailstring

iTunes owner email.

languagestring

iTunes or Roku feed language field.

fetch_sourcesboolean

For universal feeds, specifies whether the feed service should fetch video source metadata and make it available to the template. The default value is true. If source metadata is not needed by the template, setting this to false can improve feed generation performance.

fetch_digital_masterboolean

For universal feeds, specifies whether the feed service should fetch digital master metadata and make it available to the template. The default value is false. If digital master metadata is not needed by the template, keeping this setting as false can improve feed generation performance.

fetch_dynamic_renditionsboolean

For universal feeds, specifies whether the feed service should fetch dynamic rendition metadata and make it available to the template. The default value is false. If dynamic rendition metadata is not needed by the template, keeping this setting as false can improve feed generation performance.

content_type_headerstring

Content type header that the syndication's feed will be served with. If not specified, a default that is specific to the syndication type will be used.

Changes