Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": 61770,
            "hub_id": 4003,
            "title": "Another title",
            "description": null,
            "url": null,
            "service": "custom",
            "thumbnail_url": "http://i.cbc.ca/1.3573789.1462817111!/cpImage/httpImage/image.jpg_gen/derivatives/16x9_460/alberta-wildfire-20160508.jpg",
            "no_robots": true,
            "template_data": {
                "list_view": false,
                "canonical_meta": true,
                "canonical_redirect": false,
                "read_more": false,
                "share_original": false,
                "auto_expand_issue": false,
                "download_pdf": false,
                "disable_video_ctas": false,
                "disable_autoplay": false,
                "pseudo_links": false,
                "comments_disabled": false
            },
            "hidden": false,
            "paused": false,
            "exclude_from_search": false,
            "item_count": 1,
            "created_at": "2016-06-27T11:33:07-0400",
            "modified_at": "2016-09-15T15:01:18-0400",
            "item": {
                "id": 1301812,
                "ordinal": 0,
                "featured": 0
            }
        },
        {
            "id": 62532,
            "hub_id": 4003,
            "title": "Top Stories News",
            "description": "Top stories",
            "url": null,
            "service": "blogpost",
            "thumbnail_url": "http://i.cbc.ca/1.3845528.1478801078!/cpImage/httpImage/image.jpg_gen/derivatives/16x9_460/obama-trump.jpg",
            "no_robots": false,
            "template_data": {
                "list_view": false,
                "read_more": false,
                "prevent_small_images": true,
                "canonical_meta": true,
                "canonical_redirect": false,
                "comments_disabled": false
            },
            "hidden": false,
            "paused": false,
            "exclude_from_search": false,
            "item_count": 1,
            "created_at": "2016-07-29T11:26:05-0400",
            "modified_at": "2016-11-10T14:45:54-0500",
            "item": {
                "id": 1301812,
                "ordinal": 0,
                "featured": 0
            }
        }
    ],
    "meta": {
        ...
    }
}

The response will contain a streams collection:

Body Parameters

Type

Description

data

Array

The collection of Streams

meta

Object

See: Pagination

Each stream in the collection will have properties:

Body Parameters

Properties

Type

Description

id

Integer

The stream identifier

hub_id

Integer

The hub identifier

title

String

The stream title

description

String

The stream description

url

String

The stream URL

thumbnail_url

String

The stream thumbnail URL

type

String

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

service

String

The service that the stream imports items from (“blogpost”, “uberflip”, “youtube”, “vimeo”, etc)

item_count

Integer

The number of items in the stream

no_robots

Boolean

Whether the stream allows robots

template_data

Object

->

list_view

Boolean

Whether the stream is in list view

->

read_more

Boolean

Whether the stream has the read more button

->

prevent_small_images

Boolean

Whether the stream allows small images

->

canonical_meta

Boolean

Whether the stream has canonical meta

->

canonical_redirect

Boolean

Whether the stream has canonical redirect

->

comments_disabled

Boolean

Whether the stream allows comments

owner

->

id

Integer

Id of the user that created this stream

->

first_name

String

First name of the user that created this stream

->

last_name

String

Last Name of the user that created this stream

->

avatar_url

String

Url of this user’s avatar image

hidden

Boolean

Whether the stream is hidden

paused

Boolean

Whether the stream is paused

exclude_from_search

Boolean

Whether the stream is excluded from search

created_at

Date

The stream created date

modified_at

Date

The stream last modified date