Get Stream

Gets the details of a Stream, including its metadata.

Returns

Returns details about the Stream if successful. The response body consists of an object with these properties:

PropertyTypeDescription
idintegerThe Stream's identifier code
hub_idintegerThe Hub's identifier code
titlestringThe title of the Stream
descriptionstringThe Stream's description text
urlstringThe URL of the Stream page
thumbnail_urlstringThe URL for the Stream's thumbnail image
typestringThe type of Stream (“blogs”, “docs”, “videos”, etc.)
servicestringThe service that the Stream imports items from (“blogpost”, “youtube”, etc.)
item_countintegerThe number of Items in the Stream
no_robotsbooleanWhether the Stream's no robots meta tag is enabled
template_dataobjectAn object containing metadata about the status of various options on the Stream
ownerobjectAn object containing metadata about the Stream's owner
hiddenbooleanWhether the Stream is hidden
pausedbooleanWhether updating of the Stream is paused
exclude_from_searchbooleanWhether the Stream is set to be excluded from Hub search
created_atdateThe date the Stream was created
modified_atdateThe date the Stream was last updated/changed

template_data object properties

The template_data object in the response contains these properties:

PropertyTypeDescription
list_viewbooleanWhether this Stream has the List View option enabled
read_morebooleanWhether this Stream has the Read More button enabled
prevent_small_imagesbooleanWhether this Stream will prevent images under a certain size from being imported
canonical_metabooleanWhether this Stream has a canonical meta tag ("rel canonical")
canonical_redirectbooleanWhether this Stream is set to 301 redirect to the canonical URL of Items it contains
comments_disabledbooleanWhether this Stream allows comments

owner object properties

The owner object in the response contains these properties:

PropertyTypeDescription
idintegerThe identifier code of the user who created this Stream
first_namestringThe first name of the user who created this Stream
last_namestringThe last name of the user who created this Stream
avatar_urlstringThe URL for the avatar image of the user who created this Stream
Language
Authentication
OAuth2