Featured items

GET
/sites/site-id/featured-item-containers

List all the featured item containers on this site.

Query parameters

fields Return only requested fields in the response (ex. ?fields=id,name)
GET https://api.flockler.com/v1/sites/609/featured-item-containers
{
  "meta": {
    "count": 1
  },
  "featured_item_containers": [
    {
      "id": 36,
      "identifier": "top5",
      "link": "http://example.com/",
      "name": "Top 5",
      "order_number": 1,
      "type_restriction": "Article"
    }
  ]
}
Field Data type Description values
id integer Unique ID for fetching single category
identifier string Non-unique identifier, used to filter out certain containers
link string URL associated with the container (e.g. where to see more items like this)
name string Name of the featured item container
order_number integer Order number for sorting the containers and their contents
type_restriction string If set, specifies what content is allowed into container (e.g. Article, Book, Recipe, ...)
GET
/sites/site-id/featured-item-containers/featured-item-container-id/articles

Get articles in a featured item container.

Query parameters

count Set the number of articles to return per response
fields Return only requested fields in the response (ex. ?fields=id,title,body)
GET https://api.flockler.com/v1/sites/609/featured-item-containers/36/articles
{
  "meta": {
    "total_count": 2,
    "count": 2
  },
  "articles": [
    {
      "article_url": "yourfry-a-digital-storytelling-project-for-everyone",
      "author_ids": [

      ],
      "body": "<p><img alt=\"\" src=\"https://flockler.com/thumbs/1156/flockler-case-yourfry--j3qp3kniao_s600x0_q80_noupscale.jpg\" /></p>\n\n<p><a href=\"http://yourfry.com\" target=\"_blank\">YourFry</a>&nbsp;is a fascinating project site by&nbsp;<a href=\"http://global.penguinrandomhouse.com/\" target=\"_blank\">Penguin Random House</a>&nbsp;and&nbsp;<a href=\"https://www.wetransfer.com\" target=\"_blank\">WeTransfer</a>. Stephen Fry invites the planet of creative and tech minds, to deconstruct and repurpose the words and themes from his last two books. Create text, data visualization, interactive web format, app, film, photographic, animation, 3D-models or live and experiential creations&hellip; You decide.</p>\n\n<p>YourFry site is designed together with Penguin&#39;s team and powered by&nbsp;<a href=\"http://flockler.com\">Flockler</a>&nbsp;platform. Platform enables visitors to&nbsp;<a href=\"http://yourfry.com/submit\">submit their creations</a>&nbsp;as video and Penguin team to review videos before publishing to&nbsp;<a href=\"http://yourfry.com/interpretations\" target=\"_blank\">Interpretations</a>.&nbsp;<a href=\"http://yourfry.com/news\">News section</a>&nbsp;of the site combines editorial and curated social content posted with #yourfry hashtag.</p>\n\n<p><a href=\"http://yourfry.com\">http://yourfry.com</a></p>\n",
      "canonical_url": null,
      "category_id": null,
      "cover_pos_x": 50,
      "cover_pos_y": 0,
      "cover_url": "https://flockler.com/thumbs/1156/flockler-case-yourfry--j3qp3kniao_s600x0_q80_noupscale.jpg",
      "display_style": "article",
      "full_url": "http://sites.flockler.com/api-demo/projects/yourfry-a-digital-storytelling-project-for-everyone",
      "id": 878404,
      "pinned_index": null,
      "published_at": "2015-03-03T13:22:00Z",
      "published_at_l10n": "2015-03-03T13:22:00+00:00",
      "section_id": 3909,
      "site_id": 609,
      "site_pinned_index": null,
      "source": "newsroom",
      "summary": "",
      "tags": [

      ],
      "title": "YourFry – A digital storytelling project for everyone",
      "type": "article",
      "url": null,
      "author_credit": "ajk"
    },
    {
      "article_url": "teknavi",
      "author_ids": [

      ],
      "body": "<p><img alt=\"\" src=\"https://flockler.com/thumbs/1156/flockler-case-teknavi--kopdm8gism_s600x0_q80_noupscale.jpg\" /></p>\n\n<p>Teknavi is a media, that writes about cars and latest technology. They publish articles, videos and other great content for web and social media. With Flockler, Teknavi can combine those into one.</p>\n\n<p>TV shows season nine&nbsp;starts rolling on MTV3 Finland during next months. And they also publish every two weeks the iOS/Android App with&nbsp;latest and greatest content.</p>\n\n<p>With Flockler, they can save time. Every editor can now publish their own articles, and all the visual elements are forced to be used, so the articles are inline.</p>\n\n<p><a href=\"http://www.teknavi.fi\">www.teknavi.fi</a></p>\n",
      "canonical_url": null,
      "category_id": 358,
      "cover_pos_x": 50,
      "cover_pos_y": 0,
      "cover_url": "https://flockler.com/thumbs/1156/flockler-case-teknavi--kopdm8gism_s600x0_q80_noupscale.jpg",
      "display_style": "article",
      "full_url": "http://sites.flockler.com/api-demo/projects/teknavi",
      "id": 878405,
      "pinned_index": null,
      "published_at": "2015-03-03T13:22:19Z",
      "published_at_l10n": "2015-03-03T13:22:19+00:00",
      "section_id": 3909,
      "site_id": 609,
      "site_pinned_index": null,
      "source": "newsroom",
      "summary": "",
      "tags": [

      ],
      "title": "Teknavi",
      "type": "article",
      "url": null,
      "author_credit": "ajk"
    }
  ],
  "categories": [
    {
      "category_url": "in-finnish",
      "color": null,
      "id": 358,
      "name": "In Finnish",
      "order_number": 2
    }
  ],
  "sections": [
    {
      "brand_color": null,
      "category_id": null,
      "cover_url": null,
      "description": "",
      "full_url": "http://sites.flockler.com/api-demo/projects",
      "id": 3909,
      "locale": "en",
      "name": "Projects",
      "name_in_menus": null,
      "order_number": 3,
      "real_time": false,
      "section_url": "projects",
      "show_in_menu": true,
      "site_id": 609,
      "state": "public",
      "title_text": null
    }
  ]
}
Field Data type Description values
article_url string Slug of the article
author_ids array of integers ID's of the sideloaded authors of this article. For fields description, see authors endpoint
body string Article text in HTML format
category_id integer ID of the category article belongs to. Category is sideloaded in the response and for fields description, see categories endpoint.
cover_pos_x integer Cover's X position in percentage without the %, easy to use with "background-position" CSS attribute
cover_pos_y integer Cover's Y position in percentage without the %, easy to use with "background-position" CSS attribute
cover_url string Url to the full size version of the cover image, see Image resizing
display_style string Article display style (on Flockler magazine layout) article, text, video, image, facebook-post, tweet, instagram
full_url string Full URL of this article
id integer ID of this article
pinned_index integer Section articles endpoint only! Index where this article is pinned at starting from 0 in section
published_at datetime Article publish time
published_at_l10n datetime Article publish time with localization
section_id integer ID of the section article belongs to. Section is sideloaded in the response and for fields description, see section endpoint.
site_id integer ID of the section article belongs to. Section is sideloaded in the response and for fields description, see section endpoint.
site_pinned_index integer Site articles endpoint only! Index where this article is pinned at starting from 0 on frontpage
source string Source of the article newsroom, guest_api, feed, email, upload_form, media_tracker
summary string Article summary
tags string Keywords that article is tagged with. Notice that you can filter with these by using tag-parameter.
title string Article title
type string Type of the article article, video, image, facebook_post, tweet, instagram, link, pinterest
url string Source URL for article if it's a "link" article
attachments embedded Hash containing the attachments that the article has (e.g. a tweet). See also, field descriptions of attachments. facebook_post, instagram_item, tweet, video
author_credit string Author(s) of article as a easily representable string