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 |
---|---|---|
| integer | The Stream's identifier code |
| integer | The Hub's identifier code |
| string | The title of the Stream |
| string | The Stream's description text |
| string | The URL of the Stream page |
| string | The URL for the Stream's thumbnail image |
| string | The type of Stream (“blogs”, “docs”, “videos”, etc.) |
| string | The service that the Stream imports items from (“blogpost”, “youtube”, etc.) |
| integer | The number of Items in the Stream |
| boolean | Whether the Stream's no robots meta tag is enabled |
| object | An object containing metadata about the status of various options on the Stream |
| object | An object containing metadata about the Stream's owner |
| boolean | Whether the Stream is hidden |
| boolean | Whether updating of the Stream is paused |
| boolean | Whether the Stream is set to be excluded from Hub search |
| date | The date the Stream was created |
| date | The date the Stream was last updated/changed |
template_data
object properties
template_data
object propertiesThe template_data
object in the response contains these properties:
Property | Type | Description |
---|---|---|
| boolean | Whether this Stream has the List View option enabled |
| boolean | Whether this Stream has the Read More button enabled |
| boolean | Whether this Stream will prevent images under a certain size from being imported |
| boolean | Whether this Stream has a canonical meta tag ("rel canonical") |
| boolean | Whether this Stream is set to 301 redirect to the canonical URL of Items it contains |
| boolean | Whether this Stream allows comments |
owner
object properties
owner
object propertiesThe owner
object in the response contains these properties:
Property | Type | Description |
---|---|---|
| integer | The identifier code of the user who created this Stream |
| string | The first name of the user who created this Stream |
| string | The last name of the user who created this Stream |
| string | The URL for the avatar image of the user who created this Stream |