/channels/show

Show all information about a channel.

Parameters

channel_key : string

Key of the channel which information to show.

Example response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <channel key="MrtH04gm">
    <author>JW Platform</author>
    <custom>
      <param1>value 1</param1>
      <param2>value 2</param2>
    </custom>
    <default>False</default>
    <description>Most watched videos on free beer</description>
    <link>http://www.jwplatform.com</link>
    <sort_order>date-asc</sort_order>
    <tags>free, beer</tags>
    <tags_mode>all</tags_mode>
    <title>Top videos</title>
    <type>dynamic</type>
    <videos total="17" max="21" />
  </channel>
</response>

Response parameters

/response/status : string

Call execution status. Set to ok if call executed successfully.

//channel/@key : string

Channel key.

//channel/author : string

Author of the channel.

//channel/custom/param1 : string

User defined parameter.

//channel/title : string

Channel title.

//channel/default : string

True if channel is a default recommendations channel, False otherwise.

//channel/description : string

Channel description.

//channel/link : string

User defined URL.

//channel/type : string

Channel type:

manual

Manual channel.

dynamic

Dynamic channel.

trending

Trending channel.

feed

Feed channel.

search

Search channel.

//channel/pin_slot_1 : string

Key of the playlist channel which will be pinned (promoted) into slot 1. Pinnable feed types include trending, dynamic and manual. The target feed in question (channel key) must be of type Feed or Search.

//channel/pin_slot_2 : string

Key of the playlist channel which will be pinned (promoted) into slot 2. Pinnable feed types include trending, dynamic and manual. The target feed in question (channel key) must be of type Feed or Search.

//channel/tags : string

List of tag(s) used by tags_mode (Include). Multiple tags should be comma separated.

//channel/tags_mode : string

Includes only videos with the tags specified in tags based on the options below. Works with all channels/playlists except Manual.

all

Videos tagged with ALL of the specified tags in ‘tags’ are included in the results set.

any

Videos tagged with ANY of the specified tags in ‘tags’ are included in the results set.

//channel/exclude_tags : string

List of tag(s) used by exclude_tags_mode (Exclude). Multiple tags should be comma separated.

//channel/exclude_tags_mode : string

Excludes videos with tags specified in ‘exclude_tags’ based on the options below. Works with all channels/playlists except Manual.

all

Videos tagged with ALL the specified tags in ‘exclude_tags’ are excluded from the results set.

any

Videos tagged with ANY of the specified tags in ‘exclude_tags’ are excluded from the results set.

//channel/sort_order : string

Videos sort order in a dynamic channel:

date-asc

By date ascending.

date-desc

By date descending.

title-asc

By title ascending.

title-desc

By title descending.

duration-asc

By duration ascending.

duration-desc

By duration descending.

//channel/videos/@total : unsigned integer

Total number of videos in the channel. This is available for manual and dynamic channels only.

Warning

The response from this call will not reflect the behavior of dynamic channels ordered by views. Views is a legacy system metric that has been deprecated since 2016-07-01. Channels ordered by views return results based on 30 day play count.

//channel/videos/@max : unsigned integer

Maximum number of videos in the channel. Dynamic, trending and feed channels only.