Skip links

Livefyre Answers

Livefyre documentation set

Header Right

Main navigation

Importing Ratings and Reviews

Importing ratings and reviews data to Livefyre.

Importing your legacy ratings and reviews data allows you to maintain historic data in your Livefyre Ratings and Reviews Apps.

This section describes processes specific to the Ratings and Reviews import process:

Ratings and Reviews Data Formatting

For Rating and Reviews specific imports, exclude endlines from the JSON record, and make sure that each Rating or Review appears on a single line.

The Reviews JSON schema is described in this Livefyre GitHub gist. Validators can be found in the language of your choice from the json-schema.org > Implementations page.

To import only Ratings and Reviews, and not the associated user profiles, follow the example JSON format below, and specify fields that begin with imported_. In this case, only imported_display_name is required. When using these fields, omit the author_id.

Available Ratings and Reviews Parameters

The following parameters are used in the Ratings and Reviews import process.

 

Required fields

source:
(required) string The site on which the Review originated.
title:
(required) string The title for the Collection to which the Review was posted.
created:
(required) timestamp The ISO-8601 compliant timestamp for the moment the Collection in which the Review was posted was created. For example: “2010-07-05T23:01:15Z”
id (source):
(required) string The article ID you chose to uniquely identify a Collection within your site, encoded using Base64. This parameter is limited to 150 characters.
dimensions:
(required) array An array of strings for each type of dimension that this Collection will use. If this is not specified, only 1 dimension will be allowed.
For example, to allow users to rate your product on ‘design’, ‘features’, and ‘performance’, set the array to: dimensions: [‘design’, ‘features’, ‘performance’]
id (reviews):
(required) string Your system’s internal content identifier, used by the importer to relate children using their parent_id.
imported_display_name:
(required) string The display name of the user. This will be rendered with Livefyre content posted by the user.
title:
(required) string User’s review title.
body_html:
(required) string The text string for the Review. Only tags <p> and <a>, and only the href attribute, are allowed.
created:
(required) timestamp The ISO-8601 compliant timestamp for the Comment’s creation. For example: “2010-07-05T23:01:15Z”
ratings:
(required) array An array of integers (from 1-100) which represent the author’s rating for each of your defined dimensions. The number of items in the array must equal the number of defined dimensions.

 

Optional fields

author_id:
(optional) string The userId of the user in your profile system. This must be unique across all users in your Network, and must never change. Max length = 255 characters.
imported_email:
(optional) string Used for gravatars, and not displayed publicly.
imported_url:
(optional) string A user provided website.

Example Ratings and Reviews Format

Note: The following sample data is for a Reviews Collection with multiple rating dimensions. If your Collection has only one dimension (such as overall/default), the dimensions field must be [‘default’], and the ratings fields in the reviews should only have one score.

Single-dimension review with required fields

Multi-dimension review with required fields

Multi-dimension review with additional fields

Reviews with multiple subparts

Note: Review subparts are used to define one or more customizable fields that you want to include in your reviews in addition to title and body.