Items Index

/api/[version]/items.[json|xml|rss]

Attributes

bold = required

  • id(number) - Internal Media Magnet ID
  • link(string) - Canonical URL of item from source system
  • href(string) - Absolute URL of item in Media Magnet (defaults to html)
  • channel_type(string) - Twitter, Facebook page, Instagram, etc.
  • channel_id(number) - ID of the channel that produced this item
  • source_identifier(string) - An identifier used in the source system
  • excerpt(string) - ~140 character title, summary, or excerpt of item
  • content(string) - HTML content associated with the item
  • tags(array of strings) - array of strings with tags
  • keywords(array of objects) - array of objects representing keywords (name and category)
  • title(string) - Source systems that have explicit titles will be returned here. This may be same as excerpt without 140 character limit
  • description(string) - Used for channel_types that have explicit plain-text descriptions (RSS, Events, YouTube)
  • published_at(datetime) - The date this item was published
  • assets(array of objects) - mime, url, and size for media assets (Instagram Photos/Videos, twitpic, RSS enclosures). NOTE: YouTube videos are not assets as YouTube does not provide access to the source files

Filters

Check out the items page for an interactive query builder.

  • search - /api/v1/items.json?search=urban%20meyer
  • entity_id - /api/v1/items.json?entity_id=1
  • channel_id - /api/v1/items.json?channel_id[]=1&channel_id[]=2
  • channel_type - /api/v1/items.xml?channel_type=twitter
  • tags - /api/v1/items.json?tags[]=mytag&tags[]=audience-alumni
  • audience - /api/v1/items.json?audience=audience-alumni
  • location - /api/v1/items.json?location=campus-lima
  • college - /api/v1/items.json?college=college-medicine
  • format - /api/v1/items.json?format=photo

Options

The results can be modified by the following optional parameters:

  • exclude_events - Excludes any item with attached event data

RSS

The items index is also available as an RSS feed. This allows easy integration with feed readers. The item attributes listed above are transformed conform to the RSS spec.


Items Show

/api/[version]/items/[id].[json|xml]

Attributes

bold = required

  • id(number) - Internal Media Magnet ID
  • guid(string) - Globally unique identifier as provided by source system
  • link(string) - Canonical URL of item from source system
  • href(string) - Absolute URL of item in Media Magnet (defaults to html)
  • channel_type(string) - Twitter, Facebook page, Instagram, etc.
  • channel_id(number) - ID of the channel that produced this item
  • source_identifier(string) - An identifier used in the source system
  • excerpt(string) - ~140 character title, summary, or excerpt of item
  • content(string) - HTML content associated with the item
  • tags(array of strings) - array of strings with tags
  • keywords(array of objects) - array of objects representing keywords (name and category)
  • title(string) - Source systems that have explicit titles will be returned here. This may be same as excerpt without 140 character limit
  • description(string) - Used for channel_types that have explicit plain-text descriptions (RSS, Events, YouTube)
  • published_at(datetime) - The date this item was published
  • assets(array of objects) - mime, url, and size for media assets (Instagram Photos/Videos, twitpic, RSS enclosures)
  • channel(object) - The item's channel
  • entity(object) - The item's entity
  • links(array of strings) - Any URLs or links included in this item's content
  • events(array of objects) - Events associated with this item

Item attributes by content type

The following elements are available on items based on type:

Service Excerpt (140 Chars) Title Description Content Assets Links Events
Web RSS Feed Title or Truncated Description *Optional *Optional Required Optional Optional Optional
Twitter Tweet (Plain) Blank Tweet (Plain) Tweet (Marked Up) Pictures Resolved Links Blank
Instagram Caption or Generated Blank Caption (Plain) Caption (Marked Up) Picture Resolved Caption Links Blank
Facebook Truncated post or Generated Blank Post (Plain) Caption (Marked Up) Picture Resolved Post Links Blank
YouTube Truncated Title Blank Description Video iFrame Video Still Resolved Links from Description Blank
Fund Name Name Description ?? Blank Blank Blank
iCalendar Title *Optional *Optional Required Blank Optional Required