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:

Property

Type

Description

id

integer

The Stream's identifier code

hub_id

integer

The Hub's identifier code

title

string

The title of the Stream

description

string

The Stream's description text

url

string

The URL of the Stream page

thumbnail_url

string

The URL for the Stream's thumbnail image

type

string

The type of Stream (“blogs”, “docs”, “videos”, etc.)

service

string

The service that the Stream imports items from (“blogpost”, “youtube”, etc.)

item_count

integer

The number of Items in the Stream

no_robots

boolean

Whether the Stream's no robots meta tag is enabled

template_data

object

An object containing metadata about the status of various options on the Stream

owner

object

An object containing metadata about the Stream's owner

hidden

boolean

Whether the Stream is hidden

paused

boolean

Whether updating of the Stream is paused

exclude_from_search

boolean

Whether the Stream is set to be excluded from Hub search

created_at

date

The date the Stream was created

modified_at

date

The date the Stream was last updated/changed

template_data object properties

The template_data object in the response contains these properties:

Property

Type

Description

list_view

boolean

Whether this Stream has the List View option enabled

read_more

boolean

Whether this Stream has the Read More button enabled

prevent_small_images

boolean

Whether this Stream will prevent images under a certain size from being imported

canonical_meta

boolean

Whether this Stream has a canonical meta tag ("rel canonical")

canonical_redirect

boolean

Whether this Stream is set to 301 redirect to the canonical URL of Items it contains

comments_disabled

boolean

Whether this Stream allows comments

owner object properties

The owner object in the response contains these properties:

Property

Type

Description

id

integer

The identifier code of the user who created this Stream

first_name

string

The first name of the user who created this Stream

last_name

string

The last name of the user who created this Stream

avatar_url

string

The URL for the avatar image of the user who created this Stream

Language
Authentication
OAuth2