Content

Engage with or moderate any Content item in a Livefyre Collection.

Approve Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/approve/

Approves a pending piece of content so that it is publicly visible.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to approve.

Query Parameters

name	required	type	description
collection_id	true	number	The ID of the Collection that includes the content to approve.
site_id	false	string	The ID of the Collection that holds the content to approve.
lftoken	true	string	A Livefyre Authentication token of the user performing the approval.

Responses

200

Approve

Structure

property	type	description
status	string
code	string
data	object
data.comment_id	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "comment_id": "165439275"
  }
}

Unapprove Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/unapprove/

Reverts approved content to Pending, so that only the author and moderators can see it.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to unapprove.

Query Parameters

name	required	type	description
collection_id	true	number	The ID of the Collection that includes the content to unapprove.
site_id	false	string	The ID of the Collection that holds the content to unapprove.
lftoken	true	string	A Livefyre Authentication token of the user performing the Unapprove.

Responses

200

Unapprove

Structure

property	type	description
status	string
code	string
data	object
data.comment_id	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "comment_id": "165439275"
  }
}

Bozo Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/bozo/

Bozos content so that only the author can see it, but no other users. This allows you to remove content from the stream, without the author's knowledge.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to Bozo.

Query Parameters

name	required	type	description
collection_id	true	number	The ID of the Collection that includes the content to Bozo.
site_id	false	string	The ID of the Collection that holds the content to Bozo.
lftoken	true	string	A Livefyre Authentication token of the user performing the Bozo.

Responses

200

Bozo

Structure

property	type	description
status	string
code	string
data	object
data.comment_id	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "comment_id": "165439275"
  }
}

Get CTA

gethttps://api.livefyre.com/api/v4/{network}:cta/

Read LiveFyre CTA(s)

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
ids	false	array	when given, return CTA identified by ids
parent	false	string	when given returns child CTA where parent is identified by id=parent
enabled	false	boolean

Request Body

property	type	description
paging	object	Paging
paging.since	integer	Starting from matching query record
paging.until	integer	Ending at matching query record
paging.limit	integer	Number of record to fetch
paging.default_sort_order	integer	Sort order (ASC or DESC)

Responses

200

List of CTA

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "ctas": [
      {
        "id": "urn:livefyre:foo.fyre.co:cta=12345",
        "title": "Title",
        "sku": "sku12345",
        "...": null
      },
      "..."
    ],
    "paging": {
      "since": 0,
      "until": 0,
      "limit": 0,
      "default_sort_order": -1
    }
  }
}

Create, Update or Delete CTA

posthttps://api.livefyre.com/api/v4/{network}:cta/

Create, Update or Delete LiveFyre CTA(s)

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
delete	false	array	A list of id of CTA's to be deleted

Request Body

property	type	description
id	string	identifier
text	string	Title
buttonColor	string	A hex string value of color '#f0f0f0'
textColor	string	A hex string value of color '#f0f0f0'
url	string	External link when button is clicked
enabled	boolean	If active CTA, True else False
icon	string	One of the default livefyre.js Icon values (FACEBOOK, TWITTER)
imageURL	string	URL to external icaon image
isFolder	boolean	If True, the CTA would be treated as a Folder
rootId	string	Defines what root folder this CTA exist under
parentId	string	Shared properties of parent CTA

Responses

200

list of CTA either created or updated

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "created": [
      {
        "id": "urn:livefyre:foo.fyre.co:cta=12345",
        "title": "Title",
        "sku": "sku12345",
        "...": null
      },
      "..."
    ],
    "updated": [
      {
        "id": "urn:livefyre:foo.fyre.co:cta=67890",
        "title": "Title2",
        "sku": "sku67890",
        "...": null
      },
      {
        "deleted": 2
      }
    ]
  }
}

Delete Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/delete/

Permanently delete content from the Collection.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to delete.

Query Parameters

name	required	type	description
collection_id	true	number	The ID of the Collection that includes the content to delete.
site_id	false	string	The ID of the Collection that holds the content to delete.
lftoken	true	string	A Livefyre Authentication token of the user who is performing the delete.

Responses

200

Delete

Structure

property	type	description
status	string
code	string
data	object
data.comment_id	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "comment_id": "165439275"
  }
}

Edit Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/edit/

Replace a Message with a new version. Usually used to edit the Content body. Powers 'Edit' functionality in Livefyre Comments, LiveBlog.

Note: Users without moderation privileges cannot edit Content more than 5 minutes after it was originally posted.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the Message to edit

Query Parameters

name	required	type	description
lftoken	true	string	A Livefyre Authentication Token of the user that you're registering to follow the conversation.
_bi	false	string	A string to uniquely identify the client making the request. This should be the same value for stream requests that come from the same browser or client.

Form Data Parameters

name	required	type	description
body	true	string	A string of HTML that will be the body of the posted content. Allowed HTML tags include: a, span, label, p, br, strong, em, u, blockquote, ul, li, ol, pre.
attachments	false	string	Media to attach to the post. The value should be a JSON string that is an array of oEmbed objects. If the Collection is configured to enable raw HTML attachments, you can add them by including an oEmbed with the following fields: type: rich provider_name: LivefyreRawHTML html: The raw HTML.

name

required

type

description

body

true

string

A string of HTML that will be the body of the posted content. Allowed HTML tags include: a, span, label, p, br, strong, em, u, blockquote, ul, li, ol, pre.

attachments

false

string

Media to attach to the post. The value should be a JSON string that is an array of oEmbed objects. If the Collection is configured to enable raw HTML attachments, you can add them by including an oEmbed with the following fields:

type: rich
provider_name: LivefyreRawHTML
html: The raw HTML.

Responses

200

Edit

Structure

property	type	description
status	string
code	string
data	object
data.messages	array
data.messages.[]	object
data.messages.[].collectionId	string
data.messages.[].content	object
data.messages.[].content.updatedBy	string
data.messages.[].content.bodyHtml	string
data.messages.[].content.id	string
data.messages.[].content.authorId	string
data.messages.[].content.parentId	string
data.messages.[].content.updatedAt	number	The epoch time at which the content was updated.
data.messages.[].content.mentions	array
data.messages.[].content.mentions.[]	string
data.messages.[].content.ancestor	string
data.messages.[].content.annotations	object
data.messages.[].content.createdAt	number	The epoch time at which the content was created.
data.messages.[].vis	number
data.messages.[].source	number
data.messages.[].replies	array
data.messages.[].replies.[]	object
data.messages.[].type	integer
data.messages.[].event	number
data.messages.[].authors	object
data.messages.[].authors.handle	string
data.messages.[].authors.tags	array
data.messages.[].authors.tags.[]	string
data.messages.[].authors.profileUrl	string
data.messages.[].authors.avatar	string
data.messages.[].authors.displayName	string
data.messages.[].authors.type	string
data.messages.[].authors.id	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "messages": [
      {
        "collectionId": "77593267",
        "content": {
          "updatedBy": "_up68318487@livefyre.com",
          "bodyHtml": "<p>Great this is edit</p>",
          "id": "441657640",
          "authorId": "_up68318487@livefyre.com",
          "parentId": "",
          "updatedAt": 1452537513,
          "mentions": [],
          "ancestor": "",
          "annotations": {},
          "createdAt": 1452537493
        },
        "vis": 1,
        "source": 5,
        "replies": [],
        "type": 0,
        "event": 1452537514000000
      }
    ],
    "authors": {
      "_up68318487@livefyre.com": {
        "handle": "",
        "tags": [],
        "profileUrl": "http://www.livefyre.com/profile/68318487/",
        "avatar": "https://secure.gravatar.com/avatar/0d35b6917e697289be21e68da9e0fb3f/?s=50&d=https://dpstvy7p9whsy.cloudfront.net/a/anon/50.jpg",
        "displayName": "bentestapps",
        "type": 1,
        "id": "_up68318487@livefyre.com"
      }
    }
  }
}

Get Imports

gethttps://api.livefyre.com/api/v4/{network}:imports/

Read LiveFyre Imports

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
ids	false	array	returns Imports of given ids
rootIds	false	array	returns Imports on given root folders

Responses

200

Imports object

Structure

property	type	description
id	string	Identifier
status	string	Status of Import (IN_QUEUE, IN_PROGRESS, FAILURE, SUCCESS)
current	integer	Number of records imported
total	integer	Total number of records to be imported
rootId	string	Identifier of root folder to be imported in
error	string	In case of failure, error reason
error_msg	string	Detailed explanation of error

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "imports": [
      {
        "id": "urn:livefyre:foo.fyre.co:imports=12345",
        "status": "IN_PROGRESS",
        "current": "1000",
        "total": "20000",
        "...": null
      },
      "..."
    ]
  }
}

Create and Update Imports

posthttps://api.livefyre.com/api/v4/{network}:imports/

Post LiveFyre Imports.

This is a two step process.

Step 1: Upload the file using Upload Media API.

Step 2: Import the uploaded file using Imports API.

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
rootId	true	string	ID of root folder where data is to be imported

Request Body

property	type	description
attachment	object	LiveFyre file upload object
attachment.type	string	Type of upload object (LIVEFYRE, GOOGLE)
attachment.data	string	Encrypted Response from Media Upload API

Responses

200

Imports

Structure

property	type	description
id	string	Identifier
status	string	Status of Import (IN_QUEUE, IN_PROGRESS, FAILURE, SUCCESS)
current	integer	Number of records imported
total	integer	Total number of records to be imported
rootId	string	Identifier of root folder to be imported in
error	string	In case of failure, error reason
error_msg	string	Detailed explanation of error

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "imports": [
      {
        "id": "urn:livefyre:foo.fyre.co:imports=12345",
        "status": "IN_PROGRESS",
        "current": "1000",
        "total": "20000",
        "...": null
      },
      "..."
    ]
  }
}

Like Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/like/

Like a piece of content within a Collection.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to like.

Query Parameters

name	required	type	description
collection_id	true	number	The ID of the Collection that includes the content to like.
lftoken	false	string	A Livefyre Authentication Token for the user wishing to like content.

Responses

200

Structure

property	type	description
status	string
code	string
data	object
data.opinionId	string
data.messageId	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "opinionId": "165439275.apitest@labs.fyre.co.0",
    "messageId": "165439275"
  }
}

Remove Content Like

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/unlike/

Like a piece of content within a Collection.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to unlike.

Query Parameters

name	required	type	description
collection_id	true	number	The ID of the Collection that includes the content to unlike.
lftoken	true	string	A Livefyre Authentication Token for the user wishing to unlike content.

Responses

200

Structure

property	type	description
status	string
code	string
data	object
data.opinionId	string
data.messageId	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "opinionId": "165439275.apitest@labs.fyre.co.0",
    "messageId": "165439275"
  }
}

Get Links

gethttps://api.livefyre.com/api/v4/{network}:links/

Read LiveFyre Link(s)

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
ids	false	array	when given, returns Link's of matching value
sources	false	array	when given returns Link's of matching value

Responses

200

list of links

Structure

property	type	description
id	string	Identifier
source	string	Source of Link (eg UGC, asset)
destination	string	Destination of Link (eg product, tag)
enabled	boolean	True if active

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "links": [
      {
        "id": "urn:livefyre:foo.fyre.co:link=12345",
        "source": "urn:livefyre:livefyre.com:message=abc",
        "destination": "urn:livefyre:livefyre.com:product=pqr"
      },
      "..."
    ]
  }
}

Create and Update Links

posthttps://api.livefyre.com/api/v4/{network}:links/

Create or Update LiveFyre Link(s)

Path Parameters

name	required	type	description
network	true	string

Request Body

property	type	description
id	string	Identifier
source	string	Source of Link (eg UGC, asset)
destination	string	Destination of Link (eg product, tag)
enabled	boolean	True if active

Responses

200

list of links either created or updated

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "created": [
      {
        "id": "urn:livefyre:foo.fyre.co:link=12345",
        "source": "urn:livefyre:livefyre.com:message=abc",
        "destination": "urn:livefyre:livefyre.com:product=pqr"
      },
      "..."
    ],
    "updated": [
      {
        "id": "urn:livefyre:foo.fyre.co:link=111",
        "source": "urn:livefyre:livefyre.com:message=aaa",
        "destination": "urn:livefyre:livefyre.com:product=qqq"
      },
      "..."
    ]
  }
}

Delete Links

deletehttps://api.livefyre.com/api/v4/{network}:links/

Delete LiveFyre Product(s)

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
ids	false	array

Responses

200

Number of deleted links

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "removed": 2
  }
}

Upload Media

posthttps://api.livefyre.com/{network}/media/uploads/

Upload Media to Livefyre so that it can referenced as an attachment in subsequent "Post to Collection" API calls.

Request body should be the bytes of the image or video you want to upload. Specify the mimetype in the request's Content-Type header. Maximum file size is 256 MB.

Path Parameters

name	required	type	description
network	true	string	Your organization's Livefyre Network, e.g. something.fyre.co

Responses

200

Media uploaded. The response is an opaque 'attachment' JSON object. You can use this in the attachment parameter of the "Post to Collection" API.

Example application/json

{
  "type": "LivefyreMediaUpload",
  "data": "d7891ebc43c865d0:arUYEybvyeZmmqbpOcWQJEe3pwmDaKynqw2A8FFkYxJarTV39+Nw+JWCyUHCjm9ICjdUWOEIF1EEYBpxoQ1OcduM2Q7OkTMZCZM55RJVAEAiCbhkUfi9Vp+wBZpAhFkQPA4gSPmItmVPNsWeUvcYKYJe8qhfk1ZQ8ZxNF8JVeBNmOYjJHXVR5Uwryxy9LKeMqRjo482kW129W3uW9kpSudm0Zj2GbhNAcx3gGw5G5OTrlPv3/D5Aja12ATI0UktoSe97S3X5/Nh6BHCdvHPSHaso6z5ahCJ82sMtxC7VZwBNeOsG20N2/xCSK70aoVT14vs2BZzvXR3Q1lnB+1FbD84fgMoIYHVCp9RwKtIWzN9aHnXyt0FUPcO+E4bqyFlcG8sv2LNQiK7cBmu+3PX3ybSPKVmNvM1hPdvUXcGTjhkaJN04s9eIXshT4voXIRjdq/hESpBiGx35yW8z5NA="
}

Post Content to Collection

posthttps://{networkName}.quill.fyre.co/api/v3.0/collection/{collectionId}/post/

Adds content to the input Collection.

Note: If you have Custom HTML enabled for your network, this API may be used to post raw HTML into the Collection. In this case, the attachments parameter is required.

Path Parameters

name	required	type	description
collectionId	true	string	The ID of the Collection to which the content will be added.

Request Body

Content-Type: application/json

property	type	description
body	string	A string of HTML that will be the body of the posted content. Allowed HTML tags include: a, span, label, p, br, strong, em, u, blockquote, ul, li, ol, pre.
attachments	array	Media to attach to the post. The value should be a JSON string that is an array of oEmbed objects. If the Collection is configured to enable raw HTML attachments, you can add them by including an oEmbed with the following fields: type: rich provider_name: LivefyreRawHTML html: The raw HTML. To post with attached Media Uploads, include an object with the following fields: type: LivefyreMediaUpload data: The URL of the Media Upload
attachments.[]	object
attachments.[].type	string

Responses

200

Post

Structure

property	type	description
status	string
code	string
data	object
data.messages	array	The newly created Message
data.messages.[]	object	A snapshot of a Content item
data.messages.[].source	integer
data.messages.[].type	integer
data.messages.[].vis	integer	Enum indicating the visibility of the Content. Not all content is visible to everyone. For example, moderators can see content that has yet to be approved, and “bozod” content is visible only to their trollish authors. 0: None 1: Everyone. The Content is public. 2: Owner. Only the author of the Content can see the Content. 3: Group. Content is visible to the author of the Content and any moderators of the Collection that it is contained in.
data.messages.[].content	object
data.messages.[].content.bodyHtml	string	The main message of the Content, as an HTML string.
data.messages.[].content.authorId	string	ID of the Author of this Content
data.messages.[].content.parentId	string	If this Content is in reply to or a part of some other Content, then this will be the ID of that other Content. Otherwise, it will be an empty string or null.
data.messages.[].content.updatedAt	number	Unix Epoch time of when this Content item was last updated
data.messages.[].content.createdAt	number	Unix Epoch time of when this Content was first created
data.messages.[].content.id	string	ID of this Content item
data.messages.[].content.attachments	array
data.messages.[].content.attachments.[]	object	http://oembed.com/
data.messages.[].content.attachments.[].provider_url	string
data.messages.[].content.attachments.[].title	string
data.messages.[].content.attachments.[].url	string
data.messages.[].content.attachments.[].type	string
data.messages.[].content.attachments.[].thumbnail_width	number
data.messages.[].content.attachments.[].height	number
data.messages.[].content.attachments.[].width	number
data.messages.[].content.attachments.[].version	string
data.messages.[].content.attachments.[].link	string
data.messages.[].content.attachments.[].author_name	string
data.messages.[].content.attachments.[].provider_name	string
data.messages.[].content.attachments.[].thumbnail_url	string
data.messages.[].content.attachments.[].thumbnail_height	number
data.messages.[].content.attachments.[].author_url	string
data.authors	object
data.authors.[]	object	A Livefyre Author
data.authors.[].profileUrl	string
data.authors.[].displayName	string
data.authors.[].id	string
data.authors.[].avatar	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "messages": [
      {
        "content": {
          "source": 0,
          "authorId": "_u2012@livefyre.com",
          "replaces": null,
          "parentId": null,
          "bodyHtml": "&lt;p&gt;442842&lt;/p&gt;",
          "id": "25802542",
          "createdAt": 1337819934
        },
        "vis": 1,
        "type": 0,
        "event": null,
        "source": 0
      }
    ],
    "authors": {
      "_u2012@livefyre.com": {
        "profileUrl": "http://admin.t405.livefyre.com/profile/5011/",
        "displayName": "ben",
        "id": "_u2012@livefyre.com",
        "avatar": "http://livefyre-avatar.s3.amazonaws.com/a/1/d627b1ba3fce6ab0af872ed3d65278fd/50.jpg"
      }
    }
  }
}

Get Products

gethttps://api.livefyre.com/api/v4/{network}:products/

Read LiveFyre Product(s)

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
ids	false	array	when given, return products identified by ids
parent	false	string	when given returns child products where parent is identified by id=parent
enabled	false	boolean

Request Body

property	type	description
paging	object	Paging
paging.since	integer	Starting from matching query record
paging.until	integer	Ending at matching query record
paging.limit	integer	Number of record to fetch
paging.default_sort_order	integer	Sort order (ASC or DESC)

Responses

200

List of products

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "products": [
      {
        "id": "urn:livefyre:foo.fyre.co:product=12345",
        "title": "Title",
        "sku": "sku12345",
        "...": null
      },
      "..."
    ],
    "paging": {
      "since": 0,
      "until": 0,
      "limit": 0,
      "default_sort_order": -1
    }
  }
}

Create, Update or Delete Products

posthttps://api.livefyre.com/api/v4/{network}:products/

Create, Update or Delete LiveFyre Product(s)

Path Parameters

name	required	type	description
network	true	string

Query Parameters

name	required	type	description
delete	false	array	A list of id of Product's to be deleted

Request Body

property	type	description
id	string	identifier
oembed	object	Image attachment Oembed
oembed.provider_url	string
oembed.title	string
oembed.url	string
oembed.type	string
oembed.thumbnail_width	number
oembed.height	number
oembed.width	number
oembed.version	string
oembed.link	string
oembed.author_name	string
oembed.provider_name	string
oembed.thumbnail_url	string
oembed.thumbnail_height	number
oembed.author_url	string
title	string	Title
price	string	Value in dollars '$23.36'
sku	string	stock keeping unit
summary	string
url	string	Link to Product page
enabled	boolean	If active Product, True else False
attributes	array
attributes.[]	object	Properties of Product color, size, etc
attributes.[].type	string	Color, Size
attributes.[].value	string	Green, XS
rootId	string	Defines what root folder this Product exist under
parentId	string	Shared properties of parent Product
tags	array	Tags defines categories of products (ex cars, shoes)
tags.[]	string
isFolder	boolean	If True, the Product would be treated as a Folder (Mens, Womens)

Responses

200

list of products either created or updated

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "created": [
      {
        "id": "urn:livefyre:foo.fyre.co:product=12345",
        "title": "Title",
        "sku": "sku12345",
        "...": null
      },
      "..."
    ],
    "updated": [
      {
        "id": "urn:livefyre:foo.fyre.co:product=67890",
        "title": "Title2",
        "sku": "sku67890",
        "...": null
      },
      {
        "deleted": 2
      }
    ]
  }
}

Tag Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/collection/{collectionId}/tag/{messageId}/

Tag a piece of content within a Collection.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to tag
collectionId	true	number	The ID of the Collection that includes the content to tag

Query Parameters

name	required	type	description
tag_name	true	string	The tag to associate with the content.
lftoken	true	string	A Livefyre Authentication Token for the user wishing to tagontent.

Responses

200

Structure

property	type	description
status	string
code	string
data	object

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": null
}

Untag Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/collection/{collectionId}/untag/{messageId}/

Remove a tag from a piece of content within a Collection.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to untag.
collectionId	true	number	The ID of the Collection that includes the content to untag.

Query Parameters

name	required	type	description
tag_name	true	string	The tag to disassociate from the content.
lftoken	true	string	A Livefyre Authentication Token for the user wishing to untag content.

Responses

200

Structure

property	type	description
status	string
code	string
data	object

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": null
}

Get Content Thread

gethttps://{networkName}.bootstrap.fyre.co/api/v3.0/content/thread/

Returns a thread of content from a Collection for the provided content_id. A thread is a single content item and all the content items that are its ancestors and descendants (replies and replies to replies).

Query Parameters

name	required	type	description
collection_id	true	string	The ID of the Collection that holds the thread to retrieve. For example: 28211762.
content_id	true	string	The ID of the content to retrieve. For example: 313420.
depth_only	false	boolean	Defines whether to return only ancestors of the provided content_id. true returns only ancestors of the provided content_id; false returns both ancestors and descendants. Default is false.

Responses

200

Thread

Structure

property	type	description
status	string
code	number
data	object
data.content	array
data.content.[]	object	A snapshot of a Content item
data.content.[].source	integer	Content provided by Livefyre can originate from social providers other than Livefyre (e.g. Twitter, Facebook). The sources and the enumerated values that correspond to them are: Livefyre: 0, 4, 5, 8 Twitter: 1, 2, 7, 15, 20 Facebook: 3, 6, 14 Google Plus: 10 YouTube: 12, 16 RSS: 13 Instagram: 19
data.content.[].type	integer	Enum indicating the type of Content that this object is. 0: Message. This is the most common type of content, something posted by an author. 1: Opine. This is an opinion that an author has left about another piece of content. 2: Embed. An embedded image which is part of another Content item.
data.content.[].vis	integer	Enum indicating the visibility of the Content. Not all content is visible to everyone. For example, moderators can see content that has yet to be approved, and “bozod” content is visible only to their trollish authors. 0: None 1: Everyone. The Content is public. 2: Owner. Only the author of the Content can see the Content. 3: Group. Content is visible to the author of the Content and any moderators of the Collection that it is contained in.
data.content.[].collectionId	string	ID of a Collection that contains this Content item
data.content.[].content	object
data.content.[].content.bodyHtml	string	The main message of the Content, as an HTML string.
data.content.[].content.authorId	string	ID of the Author of this Content
data.content.[].content.parentId	string	If this Content is in reply to or a part of some other Content, then this will be the ID of that other Content. Otherwise, it will be an empty string.
data.content.[].content.updatedAt	number	Unix Epoch time of when this Content item was last updated
data.content.[].content.createdAt	number	Unix Epoch time of when this Content was first created
data.content.[].content.id	string	ID of this Content item
data.content.[].content.attachments	array
data.content.[].content.attachments.[]	object	http://oembed.com/
data.content.[].content.attachments.[].provider_url	string
data.content.[].content.attachments.[].title	string
data.content.[].content.attachments.[].url	string
data.content.[].content.attachments.[].type	string
data.content.[].content.attachments.[].thumbnail_width	number
data.content.[].content.attachments.[].height	number
data.content.[].content.attachments.[].width	number
data.content.[].content.attachments.[].version	string
data.content.[].content.attachments.[].link	string
data.content.[].content.attachments.[].author_name	string
data.content.[].content.attachments.[].provider_name	string
data.content.[].content.attachments.[].thumbnail_url	string
data.content.[].content.attachments.[].thumbnail_height	number
data.content.[].content.attachments.[].author_url	string
data.content.[].content.annotations	object
data.content.[].content.annotations.likedBy	array	Present when the Content has been liked
data.content.[].content.annotations.likedBy.[]	string	ID of Author who liked the Message
data.content.[].content.annotations.featuredmessage	object	Present when the Content has been featured
data.content.[].content.annotations.featuredmessage.authorId	string	ID of Author who featured the Content
data.content.[].content.annotations.featuredmessage.value	string	When featured from Livefyre Apps, this is the UNIX epoch time of when it was featured
data.content.[].content.annotations.featuredmessage.collectionId	string	ID of Livefyre Collection in which this Content is featured
data.content.[].content.annotations.geocode	object	Describes a location associated with the Content
data.content.[].content.annotations.geocode.latitude	number	latitude
data.content.[].content.annotations.geocode.longitude	number	longitude
data.meta	object
data.meta.page	number
data.authors	object
data.authors.[]	object
data.authors.[].displayName	string
data.authors.[].tags	array
data.authors.[].tags.[]	string
data.authors.[].profileUrl	string
data.authors.[].type	number
data.authors.[].id	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "content": [
      {
        "source": 0,
        "collectionId": "131560603",
        "content": {
          "generator": {
            "id": "livefyre.com"
          },
          "bodyHtml": "<p><a vocab=\"http://schema.org\" typeof=\"Person\" rel=\"nofollow\" resource=\"acct:5235fb08bc6bf31f900003bf@engadget.fyre.co\" data-lf-handle=\"\" data-lf-provider=\"livefyre\" property=\"url\" target=\"_blank\" class=\"fyre-mention fyre-mention-livefyre\">@<span property=\"name\">romkyns</span></a> Big deal.  That's not much extra too pay for a smartphone most people will have for a couple of years.<br/></p>",
          "annotations": {
            "likedBy": [
              "54c1e33eb841b37995000d5d@engadget.fyre.co"
            ]
          },
          "authorId": "50782a81bc6bf341d3002b97@engadget.fyre.co",
          "createdAt": 1431144598,
          "parentId": "307291329",
          "updatedAt": 1431144598,
          "id": "307477931",
          "ancestorId": "307291329"
        },
        "vis": 1,
        "type": 0,
        "event": 1431269111210110
      }
    ],
    "meta": {
      "page": 0
    },
    "authors": {
      "50782a81bc6bf341d3002b97@engadget.fyre.co": {
        "displayName": "I._M._Wright",
        "tags": [],
        "profileUrl": "",
        "avatar": "https://lfavatar-a.akamaihd.net/a/72/1b477d19fdad913bd0c1f7ae0bfc884e/50.jpg",
        "type": 1,
        "id": "50782a81bc6bf341d3002b97@engadget.fyre.co"
      }
    }
  }
}

Trash Content

posthttps://{networkName}.quill.fyre.co/api/v3.0/message/{messageId}/hide/

Hides the content from users. This is the same as "Trash" in Studio.

Path Parameters

name	required	type	description
messageId	true	string	The ID of the content to hide.

Query Parameters

name	required	type	description
collection_id	true	number	The ID of the Collection that includes the content to hide.
site_id	false	string	The ID of the Collection that holds the content to hide.
lftoken	true	string	A Livefyre Authentication token of the user performing the action.

Responses

200

Hide

Structure

property	type	description
status	string
code	string
data	object
data.comment_id	string

Example application/json

{
  "status": "ok",
  "code": 200,
  "data": {
    "comment_id": "165439275"
  }
}