Search

GET
/sites/site-id/search/articles

Search for articles.

Query parameters

count Set the number of articles to return per response
fields Return only requested fields in the response (ex. ?fields=id,name)
q Search query (ex. ?q=cars)
section_id Filter results by a section (ex. ?section_id=23)
GET https://api.flockler.com/v1/sites/609/search/articles?q=test
{
  "meta": {
    "count": 0
  },
  "articles": [

  ]
}
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