Feeds

You will access your content via feeds. Available feeds are:

  • feed
  • feed/account_info
  • feed/section_info
  • feed/comments

You will interact with feeds via POST information. Every feed requires at minimum your account API key (api_key), and the section id (section_id) you wish to interact with. Available parameters will differ depending on what type of section you are accessing.

Parameters

The following parameters are available to feeds for all section types.

  • api_key (required)
  • section_id (required)
  • template - define a template for the response. If this is set format will be forced to "custom."
  • limit - limits the number of results
  • order_by - order results. Can be any field available in the section plus "asc" or "desc" (example: "date desc").
  • item_id - match an items id
  • url_title - match a url_title
  • active - get items by active state '0', '1', or 'both'. (By default only active items are returned.)
  • tags - get items by tag. This may be a comma seperated list of tags.
  • flag - get items matching a flag.
  • flag_not - get items that don't have the specified flag
  • search - search the section.
  • search_in - search only the specified fields. Can be a comma seperated list of fields.
  • date_range - get items in a date range. Can be "future", "past", or two dates seperated by comma "Oct 1st 2009,Oct 31st 2009."
  • vars - get only the specified vars from the section. Should be a list of variable keywords seperated by the vars_delimeter parameter
  • vars_delimeter - the delimiter for the vars string. Defaults to a pipe ("|").

Parameters by Section

The following section types have additional parameters available.

Gallery

The gallery section type includes the base set of parameters described above, plus the following.

Optional Parameters

  • sheet - "photos" or "photoalbums".
  • album_id - the id of the album you want to access. Required if the sheet parameter is "photos."
  • fill_albums - '0' or '1'. When photoalbums is set to "photoalbums", whether or not to retrieve an album's photos. (Otherwise just the album information is retrieved).

Feed Methods

Feed

The feed method is used to access the content in your sections.

Feed/comments

This method is used to retrieve comments for an item. The additional parameter item_id is required and should be set to the item in the section you want to retrieve comments for.

Feed/section_info

This method gets useful information about a specified section. The following variables are available through this method.

  • id - the section id
  • name - the name of the section
  • model - the model or type of the section
  • items - the number of items in the section, if applicable
  • active_items - the number of active items in the section, if applicable.
  • vars - a list of the section vars
  • tags - a list of the tags used in the section. This will be a unique list, with no duplicates.
  • flags - a list of the flags used in the section. This will be a unique list, with no duplicates.