List Streams with Item¶

This endpoint returns a paginated list of all the streams containing the item, with details of the item within stream.

Request¶

GET https://v2.api.uberflip.com/items/{itemId}/streams

Path Parameters	Description
itemId	The unique identifier of the item

Query Parameters	Description
query	Return only results containing the specified text in one or more of the following fields: title description
type	Return only streams of the specified type (“blogs”, “docs”, “videos”, etc)
service	Return only streams importing items from the specified service (“blogpost”, “uberflip”, “youtube”, “vimeo”, etc)
limit	Number of results to return
page	Page to show
sort	Sort results by one or more of the following fields: id title description item_count created_at modified_at

Response¶

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
service		String	The type of 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
hidden		Boolean	Whether the stream is hidden
paused		Boolean	Whether the stream is paused
excluded_from_search		Boolean	Whether the stream is excluded from search
item_count		Integer	The number of items in the stream
created_at		Date	The stream created date
modified_at		Date	The stream last modified date
item		Object
->	id	Integer	The item identifier
->	ordinal	Integer	The ordinal of the item within the stream
->	featured	Integer	Whether the item is featured

Examples¶

curl -H "Authorization: Bearer [Token]" \
-i https://v2.api.uberflip.com/items/1301812/streams

Sample 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": 61770,
                "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": 62532,
                "ordinal": 0,
                "featured": 0
            }
        }
    ],
    "meta": {
        ...
    }
}