Content Item

Content item object

KEY VALUE TYPE VALUE DESCRIPTION
id String Identifier of of the content item. This will either be the identifier provided by the social media serivce or an auto generated id.
service String The content service that provided the content item originally.

Supported services: twitter, facebook, youtube, instagram, rss, flickr, vimeo, tumblr, vk, weibo
type String The type of content. One of video, image, link, status, embed, comment.
title String The title of the content item. This might be unavailable in different contexts.
text String The text of the content item. Can contain HTML.

Example: text: "just setting up my twitter."
tags Array of Strings The tags added to the content item.

Example: tags: ["news", "breaking"]
url String The URL pointing to the item where it can be found on the providing social media service or website, if available.
date DateTime The publication date of the item on the providing social media service or website, if available.
author Object The author of the content item. See the author object for more information.
media Array An array of attached images, videos or embeddable HTML. See the media object for more information.
location Object The location where the content item was created, if available. See the location object for more information.
kudos Object Engagement metrics such as likes, shares and more. See the kudos object for more information.
language String The language of the content item in the form of an ISO 639-1 language code.
state String Whether the content item is published or not. Value can be published or unpublished. Only available in queue endpoint.
children Array An array of content items that are children of the current item. These can for example be comments or tweets referencing a URL.

Content item author object

KEY VALUE TYPE VALUE DESCRIPTION
name String The display name of the author.
userid String The identifier of the author on the social media provider.
username String The username of the author.
url String URL pointing to the author on the providing social media service or website.
image String URL pointing to the user avatar.

Content item media object

The media object is a representation of attached images, videos or embeddable HTML. Not all fields appear in all contexts.

KEY VALUE TYPE VALUE DESCRIPTION
type String The type of media. One of image, video or embed.
url String URL pointing to an image or video.
width Integer Width of the video, image or embed in pixels.
height Integer Height of the video, image or embed in pixels.
duration Integer Duration of the video in seconds.
embed String Embeddable HTML.

Content item location object

A location object contains the location where the social media item was created. It follows the Geo JSON specification. Only type Point is supported.

Consumers of the Location object should tolerate the addition of new fields and variance in ordering of fields with ease. Not all fields appear in all contexts.

KEY VALUE TYPE VALUE DESCRIPTION
name String Name of the location

Example: name: "Crowdynews HQ, Groningen"
coordinates Array Coordinates of the location following GeoJSON spec.

Example: coordinates: [ 6.5292373,53.2282014 ]
type String GeoJSON type. At the moment only Point is supported.

Example: type: "Point"

Content item kudos object

The Kudos object is a representation of the social engagement of an item. Not all fields appear in all contexts.

KEY VALUE TYPE VALUE DESCRIPTION
score Float Weighted social engagement score

Example: score: 0.325
{service}_score Float Service specific weighted social engagement score

Example: facebook_score: 0.563
{service}_{metric} Integer Service specific engagement counts. See the list below for the supported service metrics.

Example: twitter_retweets: 10

List of supported {service}_{metric} fields:

  • facebook_comments
  • facebook_likes
  • facebook_shares
  • instagram_comments
  • instagram_likes
  • tumblr_note_count
  • twitter_favorites
  • twitter_retweets
  • vimeo_comments
  • vimeo_plays
  • vimeo_likes
  • vk_likes
  • weibo_attitudes
  • weibo_comments
  • weibo_reposts
  • youtube_comments
  • youtube_dislikes
  • youtube_favorites
  • youtube_likes
  • youtube_rating
  • youtube_views