Featured Content

APIs to feature the best Content in your community, and retrieve it later for display or analysis.

Feature Content

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

Features content (and posts it above the comment editor).

Path Parameters
namerequiredtypedescription
collectionIdtruenumber

The Collection ID for which content will be featured. For example: '10633838'.

messageIdtruestring

The ID of the content to feature.

Query Parameters
namerequiredtypedescription
lftokentruestring

A Livefyre Authentication token for the user featuring content. This is returned from the Auth endpoint.

Responses

200

Feature

Example application/json
{
  "status": "ok",
  "code": 200,
  "data": null
}

Unfeature Content

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

Unfeatures content (and removes it from above the comment editor, and returns it to the stream).

Path Parameters
namerequiredtypedescription
collectionIdtruenumber

The Collection ID for which content will be unfeatured. For example: '10633838'.

messageIdtruestring

The ID of the content to unfeature.

Query Parameters
namerequiredtypedescription
lftokentruestring

A Livefyre Authentication token for the user unfeaturing content. This is returned from the Auth endpoint.

Responses

200

Unfeature

Example application/json
{
  "status": "ok",
  "code": 200,
  "data": null
}

Featured (Collection)

gethttps://{networkName}.bootstrap.fyre.co/bs3/v3.1/{network}/{siteId}/{b64articleId}/featured

Retrieves the most recent 50 pieces of featured content (and its authors) for the input Collection. (Use paging to return all content, rather than only the most recent 50.)

Path Parameters
namerequiredtypedescription
networktruenumber

Your Livefyre provided network. For example: labs.fyre.co.

b64articleIdtruestring

The article ID you chose to uniquely identify a Collection in your site, encoded using Base64.

siteIdtruestring

The Livefyre-provided ID for the website or application from which featured content will be pulled. For example: 303617.

Responses

200

Featured

Example application/json
{
  "paging": {
    "hasPrev": false,
    "limit": null
  },
  "data": {
    "content": [
      {
        "source": 19,
        "collectionId": "132677714",
        "collection": null,
        "content": {
          "attachments": [
            {
              "provider_url": "http://instagram.com",
              "title": "just got our cupcakes in, vanilla chocolate chip & double chocolate chip. #yummy #vegancupcake #dairyfree #crueltyfree #delicious #parkslope #brooklyn #theVspot @mrcarabano @alexcarabano @ziostefano",
              "url": "https://scontent.cdninstagram.com/hphotos-xaf1/t51.2885-15/s640x640/sh0.08/e35/11909349_493164437532074_903287131_n.jpg",
              "type": "photo",
              "thumbnail_width": 150,
              "height": 640,
              "width": 640,
              "version": "1.0",
              "link": "https://instagram.com/p/7qL_8gmDN8/",
              "author_name": "thevspotrestaurant",
              "provider_name": "Instagram",
              "thumbnail_url": "https://scontent.cdninstagram.com/hphotos-xfa1/t51.2885-15/s150x150/e35/c6.0.1068.1068/11950556_841625375936809_874759990_n.jpg",
              "thumbnail_height": 150,
              "author_url": "http://www.instagram.com/thevspotrestaurant"
            }
          ],
          "generator": {
            "id": "instagram.com"
          },
          "bodyHtml": "just got our cupcakes in, vanilla chocolate chip & double chocolate chip. #yummy #vegancupcake #dairyfree #crueltyfree #delicious #parkslope #brooklyn #theVspot @mrcarabano @alexcarabano @ziostefano",
          "annotations": {
            "featuredmessage": {
              "authorId": "TEMP-0b93dcdb2472d860@sales.fyre.co",
              "value": 1442337134,
              "collectionId": "132677714"
            },
            "geocode": {
              "latitude": 40.678052687,
              "longitude": -73.979415828
            }
          },
          "authorId": "414661547@instagram.com",
          "parentId": "",
          "updatedAt": 1442337155,
          "id": "instagram-1074724233891296124_414661547@instagram.com",
          "createdAt": 1442337134
        },
        "vis": 1,
        "type": 0,
        "event": 1442337845033953
      },
      {
        "erefs": [
          "M2KJJs0fxNKa5ZoxMg+kNqYWTacF76bsUMrJc7VazNlJknYymBP/EbSIe/Zrcgl7GbkbBoty/t7PfncMKTUCZzcIPk/TT9uV5XIXB3l9EZGb2I0588+cMNmL4NMjpiNUwkJY7w==",
          "u5xVwcUvddADfY2jrhqmgkETi4XzXOomas2646EX4m6k1tEQO0JcNgg5nQ5TKSXMYDG0AbfSf78kPhuKySQojfNiPLt4q+QutVdMam6r1u2EUfLYdNO3ZpB9bep1/4sGedS2Bg=="
        ],
        "source": 19,
        "collectionId": "132677714",
        "collection": null,
        "content": {
          "id": "instagram-987755210109869306_6402294@instagram.com",
          "createdAt": 1431969618,
          "parentId": ""
        },
        "vis": 3,
        "type": 0,
        "event": 1432053769522037
      }
    ],
    "authors": {
      "414661547@instagram.com": {
        "displayName": "Restaurant/Comedy Club",
        "tags": [],
        "profileUrl": "http://www.instagram.com/thevspotrestaurant",
        "avatar": "https://igcdn-photos-f-a.akamaihd.net/hphotos-ak-xfa1/t51.2885-19/11375249_171656349833669_472241260_a.jpg",
        "type": 8,
        "id": "414661547@instagram.com"
      }
    }
  }
}

Featured (Site)

gethttps://{networkName}.bootstrap.fyre.co/bs3/v3.1/{network}/{siteId}/featured

Retrieves the most recent 50 pieces of featured content (and its authors) for the input site. (Use paging to return all content, rather than only the most recent 50.)

Path Parameters
namerequiredtypedescription
networktruenumber

Your Livefyre provided network. For example: labs.fyre.co.

siteIdtruestring

The Livefyre-provided ID for the website or application from which featured content will be pulled. For example: 303617.

Responses

200

Featured

Example application/json
{
  "paging": {
    "hasPrev": false,
    "limit": null
  },
  "data": {
    "content": [
      {
        "source": 19,
        "collectionId": "132677714",
        "collection": null,
        "content": {
          "attachments": [
            {
              "provider_url": "http://instagram.com",
              "title": "Take modern technique and improvisation class with Artistic Director, Taylor Donofrio! Class is held every Tuesday at 6:30pm in #ParkSlope #Brooklyn. Today marks the first class of the session! We hope to see you there! www.donofriodanceco.com/events  #class #moderntechnique #inthestudio #dance #Brooklyndance #sweat #move #learn #mindandbody #vscocam #spacefordance #Fallishere #livealive",
              "url": "https://scontent.cdninstagram.com/hphotos-xaf1/t51.2885-15/s640x640/sh0.08/e35/11820585_1495140967475672_1192251690_n.jpg",
              "type": "photo",
              "thumbnail_width": 150,
              "height": 640,
              "width": 640,
              "version": "1.0",
              "link": "https://instagram.com/p/7qNEiuiIlG/",
              "author_name": "donofriodanceco",
              "provider_name": "Instagram",
              "thumbnail_url": "https://scontent.cdninstagram.com/hphotos-xaf1/t51.2885-15/s150x150/e35/11820585_1495140967475672_1192251690_n.jpg",
              "thumbnail_height": 150,
              "author_url": "http://www.instagram.com/donofriodanceco"
            }
          ],
          "generator": {
            "id": "instagram.com"
          },
          "bodyHtml": "Take modern technique and improvisation class with Artistic Director, Taylor Donofrio! Class is held every Tuesday at 6:30pm in #ParkSlope #Brooklyn. Today marks the first class of the session! We hope to see you there! www.donofriodanceco.com/events  #class #moderntechnique #inthestudio #dance #Brooklyndance #sweat #move #learn #mindandbody #vscocam #spacefordance #Fallishere #livealive",
          "annotations": {
            "featuredmessage": {
              "authorId": "TEMP-0b93dcdb2472d860@sales.fyre.co",
              "value": 1442337695,
              "collectionId": "132677714"
            },
            "geocode": {
              "latitude": 40.6753387,
              "longitude": -73.9783783
            }
          },
          "authorId": "497670545@instagram.com",
          "parentId": "",
          "updatedAt": 1442337710,
          "id": "instagram-1074728947851757894_497670545@instagram.com",
          "createdAt": 1442337695
        },
        "vis": 1,
        "type": 0,
        "event": 1442337838589493
      },
      {
        "erefs": [
          "M2KJJs0fxNKa5ZoxMg+kNqYWTacF76bsUMrJc7VazNlJknYymBP/EbSIe/Zrcgl7GbkbBoty/t7PfncMKTUCZzcIPk/TT9uV5XIXB3l9EZGb2I0588+cMNmL4NMjpiNUwkJY7w==",
          "u5xVwcUvddADfY2jrhqmgkETi4XzXOomas2646EX4m6k1tEQO0JcNgg5nQ5TKSXMYDG0AbfSf78kPhuKySQojfNiPLt4q+QutVdMam6r1u2EUfLYdNO3ZpB9bep1/4sGedS2Bg=="
        ],
        "source": 19,
        "collectionId": "132677714",
        "collection": null,
        "content": {
          "id": "instagram-987755210109869306_6402294@instagram.com",
          "createdAt": 1431969618,
          "parentId": ""
        },
        "vis": 3,
        "type": 0,
        "event": 1432053769522037
      }
    ],
    "authors": {
      "497670545@instagram.com": {
        "displayName": "Donofrio Dance Company",
        "tags": [],
        "profileUrl": "http://www.instagram.com/donofriodanceco",
        "avatar": "https://igcdn-photos-e-a.akamaihd.net/hphotos-ak-xaf1/t51.2885-19/11856814_802209839897652_651365056_a.jpg",
        "type": 8,
        "id": "497670545@instagram.com"
      }
    }
  }
}

Featured (Network)

gethttps://{networkName}.bootstrap.fyre.co/bs3/v3.1/{network}/featured

Retrieves the most recent 50 pieces of featured content (and its authors) for the input network. (Use paging to return all content, rather than only the most recent 50.)

Path Parameters
namerequiredtypedescription
networktruenumber

Your Livefyre provided network. For example: labs.fyre.co.

Responses

200

Featured

Example application/json
{
  "paging": {
    "hasPrev": false,
    "limit": null
  },
  "data": {
    "content": [
      {
        "source": 19,
        "collectionId": "115007930",
        "collection": null,
        "content": {
          "attachments": [
            {
              "provider_url": "http://instagram.com",
              "title": "Harry Potter and the Goblet of Fire.",
              "url": "https://scontent.cdninstagram.com/hphotos-xaf1/t51.2885-15/s640x640/e15/11820456_903218793066632_2018970577_n.jpg",
              "type": "photo",
              "thumbnail_width": 150,
              "height": 640,
              "width": 640,
              "version": "1.0",
              "link": "https://instagram.com/p/6NyBUxyMuK/",
              "author_name": "koraliene",
              "provider_name": "Instagram",
              "thumbnail_url": "https://scontent.cdninstagram.com/hphotos-xaf1/t51.2885-15/s150x150/e15/11820456_903218793066632_2018970577_n.jpg",
              "thumbnail_height": 150,
              "author_url": "http://www.instagram.com/koraliene"
            }
          ],
          "generator": {
            "id": "instagram.com"
          },
          "bodyHtml": "Harry Potter and the Goblet of Fire.\n#harrypotter #thegobletoffire #trimagischesturnier #voldemort #liebe #avadakedavra #quidditch #KRUM! #todesser #deatheater #hermionegranger #ronweasley #darklord #eristwiederda #bartycrouchjr #madeye #dracomalfoy",
          "annotations": {
            "featuredmessage": {
              "authorId": "TEMP-58445cd4e57c1e76@sales.fyre.co",
              "value": 1439236506,
              "collectionId": "115007930"
            }
          },
          "authorId": "1716944657@instagram.com",
          "parentId": "",
          "updatedAt": 1439236535,
          "id": "instagram-1048714281602304906_1716944657@instagram.com",
          "createdAt": 1439236506
        },
        "vis": 1,
        "type": 0,
        "event": 1439236744110663
      },
      {
        "source": 0,
        "collectionId": "117213121",
        "collection": null,
        "content": {
          "attachments": [
            {
              "provider_url": "http://www.youtube.com/",
              "title": "GoPro: Shotgun Balloon Drop",
              "url": "http://www.youtube.com/watch?v=_hYC-ukmlU0",
              "type": "video",
              "html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=http%3A%2F%2Fwww.youtube.com%2Fembed%2F_hYC-ukmlU0%3Fwmode%3Dtransparent%26feature%3Doembed&wmode=transparent&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3D_hYC-ukmlU0&image=http%3A%2F%2Fi.ytimg.com%2Fvi%2F_hYC-ukmlU0%2Fhqdefault.jpg&key=9a490b23ba72460b82aa369e9dfb1234&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" frameborder=\"0\" allowfullscreen></iframe>",
              "author_name": "GoPro",
              "height": 480,
              "width": 854,
              "version": "1.0",
              "link": "https://www.youtube.com/watch?v=_hYC-ukmlU0",
              "thumbnail_width": 480,
              "provider_name": "YouTube",
              "thumbnail_url": "http://i.ytimg.com/vi/_hYC-ukmlU0/hqdefault.jpg",
              "thumbnail_height": 360,
              "author_url": "http://www.youtube.com/user/GoProCamera"
            }
          ],
          "generator": {
            "id": "livefyre.com"
          },
          "bodyHtml": "<p>This is awesome <a href=\"https://www.youtube.com/watch?v=_hYC-ukmlU0\" target=\"_blank\" rel=\"nofollow\">https://www.youtube.com/watch?v=_hYC-ukmlU0</a></p>",
          "annotations": {
            "featuredmessage": {
              "authorId": "TEMP-2423f811d093a14f@sales.fyre.co",
              "value": 1428334500,
              "collectionId": "117213121"
            }
          },
          "authorId": "371505-jonkish21@sales.fyre.co",
          "parentId": "",
          "updatedAt": 1426798902,
          "id": "284414041",
          "createdAt": 1426798887
        },
        "vis": 1,
        "type": 0,
        "event": 1428334501094017
      }
    ],
    "authors": {
      "1716944657@instagram.com": {
        "displayName": "Karoline",
        "tags": [],
        "profileUrl": "http://www.instagram.com/koraliene",
        "avatar": "https://igcdn-photos-g-a.akamaihd.net/hphotos-ak-xfa1/t51.2885-19/11377913_116078835392886_1656868764_a.jpg",
        "type": 8,
        "id": "1716944657@instagram.com"
      },
      "371505-jonkish21@sales.fyre.co": {
        "displayName": "JonKish21",
        "tags": [],
        "profileUrl": "",
        "avatar": "https://dpstvy7p9whsy.cloudfront.net/a/anon/50.jpg",
        "type": 1,
        "id": "371505-jonkish21@sales.fyre.co"
      }
    }
  }
}

Featured (Head)

gethttps://{networkName}.bootstrap.fyre.co/bs3/{network}/{siteId}/{b64articleId}/featured-head.json

Retrieves the featured content presented in the top of a Collection.

Path Parameters
namerequiredtypedescription
networktruenumber

Your Livefyre provided network. For example: labs.fyre.co.

b64articleIdtruestring

The article ID you chose to uniquely identify a Collection in your site, encoded using Base64.

siteIdtruestring

The Livefyre-provided ID for the website or application from which featured content will be pulled. For example: 303617.

Responses

200

Featured

Example application/json
{
  "content": [
    {
      "source": 19,
      "collectionId": "132677714",
      "collection": null,
      "content": {
        "attachments": [
          {
            "provider_url": "http://instagram.com",
            "title": "Take modern technique and improvisation class with Artistic Director, Taylor Donofrio! Class is held every Tuesday at 6:30pm in #ParkSlope #Brooklyn. Today marks the first class of the session! We hope to see you there! www.donofriodanceco.com/events  #class #moderntechnique #inthestudio #dance #Brooklyndance #sweat #move #learn #mindandbody #vscocam #spacefordance #Fallishere #livealive",
            "url": "https://scontent.cdninstagram.com/hphotos-xaf1/t51.2885-15/s640x640/sh0.08/e35/11820585_1495140967475672_1192251690_n.jpg",
            "type": "photo",
            "thumbnail_width": 150,
            "height": 640,
            "width": 640,
            "version": "1.0",
            "link": "https://instagram.com/p/7qNEiuiIlG/",
            "author_name": "donofriodanceco",
            "provider_name": "Instagram",
            "thumbnail_url": "https://scontent.cdninstagram.com/hphotos-xaf1/t51.2885-15/s150x150/e35/11820585_1495140967475672_1192251690_n.jpg",
            "thumbnail_height": 150,
            "author_url": "http://www.instagram.com/donofriodanceco"
          }
        ],
        "generator": {
          "id": "instagram.com"
        },
        "bodyHtml": "Take modern technique and improvisation class with Artistic Director, Taylor Donofrio! Class is held every Tuesday at 6:30pm in #ParkSlope #Brooklyn. Today marks the first class of the session! We hope to see you there! www.donofriodanceco.com/events  #class #moderntechnique #inthestudio #dance #Brooklyndance #sweat #move #learn #mindandbody #vscocam #spacefordance #Fallishere #livealive",
        "annotations": {
          "featuredmessage": {
            "authorId": "TEMP-0b93dcdb2472d860@sales.fyre.co",
            "value": 1442337695,
            "collectionId": "132677714"
          },
          "geocode": {
            "latitude": 40.6753387,
            "longitude": -73.9783783
          }
        },
        "authorId": "497670545@instagram.com",
        "parentId": "",
        "updatedAt": 1442337710,
        "id": "instagram-1074728947851757894_497670545@instagram.com",
        "createdAt": 1442337695
      },
      "vis": 1,
      "type": 0,
      "event": 1442337838589493
    },
    {
      "erefs": [
        "M2KJJs0fxNKa5ZoxMg+kNqYWTacF76bsUMrJc7VazNlJknYymBP/EbSIe/Zrcgl7GbkbBoty/t7PfncMKTUCZzcIPk/TT9uV5XIXB3l9EZGb2I0588+cMNmL4NMjpiNUwkJY7w==",
        "u5xVwcUvddADfY2jrhqmgkETi4XzXOomas2646EX4m6k1tEQO0JcNgg5nQ5TKSXMYDG0AbfSf78kPhuKySQojfNiPLt4q+QutVdMam6r1u2EUfLYdNO3ZpB9bep1/4sGedS2Bg=="
      ],
      "source": 19,
      "collectionId": "132677714",
      "collection": null,
      "content": {
        "id": "instagram-987755210109869306_6402294@instagram.com",
        "createdAt": 1431969618,
        "parentId": ""
      },
      "vis": 3,
      "type": 0,
      "event": 1432053769522037
    }
  ],
  "isComplete": true,
  "size": 3,
  "authors": {
    "414661547@instagram.com": {
      "displayName": "Restaurant/Comedy Club",
      "tags": [],
      "profileUrl": "http://www.instagram.com/thevspotrestaurant",
      "avatar": "https://igcdn-photos-f-a.akamaihd.net/hphotos-ak-xfa1/t51.2885-19/11375249_171656349833669_472241260_a.jpg",
      "type": 8,
      "id": "414661547@instagram.com"
    },
    "497670545@instagram.com": {
      "displayName": "Donofrio Dance Company",
      "tags": [],
      "profileUrl": "http://www.instagram.com/donofriodanceco",
      "avatar": "https://igcdn-photos-e-a.akamaihd.net/hphotos-ak-xaf1/t51.2885-19/11856814_802209839897652_651365056_a.jpg",
      "type": 8,
      "id": "497670545@instagram.com"
    }
  }
}