younifyd
Menu

Get Data Reviews Json

Retrieve Reviews

GET/data/reviews.json

Use it in a workflow

  1. Add a step and choose the Bazaarvoice connector.
  2. Pick the Get Data Reviews Json action (under display).
  3. Fill in the fields below, then reference the result from later steps as {{getDataReviewsJson.response.data}}.

Request

Query parameters

apiversionnumberrequired

The API version

passkeystringrequired

API key is required to authenticate API user and check permission to access particular client's data.

Attributesstring

Attributes to be included when returning content. For example, if includes are requested along with the &attributes=ModeratorCodes parameter, both the includes and the results will contain moderator codes. In order to filter by ModeratorCode, you must request the ModeratorCodes attribute parameter.

Callbackstring

Callback function name used with JSONP. Value is a string consisting of the following characters: a-z,A-Z,0-9,_ (excluding comma)

ExcludeFamilyboolean

Boolean flag indicating whether to exclude content from other products in the same family as the requested product.

Filterarray<string>

Filter criteria for primary content of the query. Multiple filter criteria are supported. Here you can find few of many options we can use the filter parameter - Each filter argument specifies the attribute to filter on followed by a comma-separated list of values. For instance, "Filter=Rating:eq:3,4" will match all reviews with rating values 3 OR 4. - Advanced operators can be used to define filters. For instance, "Filter=Rating:lt:3" will match all reviews with a rating value less than 3. All advanced operators are documented on the Conversations API page. - If a filter value contains a comma or a colon, that character needs to be escaped with a backslash (\, or \:). If a filter value contains an ampersand (&), the ampersand must be encoded in the filter value by replacing & with %26. - Multiple filters are allowed as URL parameters in which case filters are AND'ed. For instance, "Filter=Rating:gte:4&Filter=IsFeatured:eq:true" will match all featured reviews with a rating of 4-star or higher. - Time-based filters can be used for SubmissionTime, LastModificationTime and LastModeratedTime. Dates in time-based filters are calculated as the number of seconds since January 1, 1970, 00:00:00 UTC. In a future version, we will be adding support for comparing date/time string values. The following example returns content that was submitted on November 9, 2009: &filter=SubmissionTime:gt:1257746400&filter=SubmissionTime:lt:1257832800 Below we will be stating few examples of the filter parameter - Single Filter value: &filter=Id:47950830 - Comma Seperated Multiple Filter values: &filter=Id:eq:47938933,47950830,47645686 - Multiple Filter AND'ed value: &filter=ProductId:155590400&filter=HasPhotos:eq:false&SubmissionTime:gt:1694629800000&filter=.....

Filter_[TYPE]string

Filtering option for included nested content. TYPE can be any included nested content. i.e. Comments for Reviews.

FilteredStatsstring

Statistics based on the filters used to perform queries. The filtered statistics are returned in their own block and can be returned any place that a regular statistics block can be currently returned. Available content types are: Reviews, Questions, Answers. Note: FilteredStats must be used in conjunction with "Include=Products". The filtered stats block will be identical to a regular stats block if a filtered stat is requested but a filter has not been specified for the particular type of stat being requested.

IncentivizedStatsboolean

If set to true, displays the number of incentivized reviews for each product or author returned in the response within an IncentivizedReviewCount element. This parameter must be used in conjunction with the Include parameter to include authors or products in the response, and also with the FilteredStats or Stats parameters to include statistics for reviews in the response.

Includestring

Related subjects to be included (e.g. Products, Categories, Authors, or Comments).

Limitinteger

Max number of records returned. An error is returned if the value passed exceeds 100.

Limit_[TYPE]integer

Limit option for the nested content type returned. TYPE can be any nested content. i.e. Comments for Reviews. An error is returned if the value passed exceeds 20.

Localestring

Locale to display Labels, Configuration, Product Attributes and Category Attributes in. The default value is the locale defined in the display associated with the API key.

Offsetinteger

Index at which to return results. By default, indexing begins at 0 when you issue a query. Using Limit=100, Offset=0 returns results 0-99. When changing this to Offset=1, results 1-100 are returned. The maximum supported value is 300000.

Searchstring

Full-text search string used to find UGC. Results can not be sorted when using Search. Search is only available to requests filtered by one product ID.

Sortarray<string>

Ways to sort reviews - Sort criteria for primary content type of the query. Sort order is required (asc or desc). - Multi-attribute sorting for each content/subject type is supported (except for contentLocale). Below we will be stating few examples of the sort parameter - Single Sort value: &sort=Rating:desc - Multiple Sort values AND'ed: &sort=Rating:desc&sort=TotalCommentCount:desc

Sort_[TYPE]string

Sorting option for nested content. Sort order is required (asc or desc). TYPE can be any nested content. i.e. Comments for Reviews.

Statsstring

The type of statistics that will be calculated on included subjects. Available content types are: Reviews, Questions, Answers. Note: Not all statistical content types apply to every possible include.

Response

Returns 200 with an object. Read it in later steps with {{getDataReviewsJson.response.data.<field>}}.

Limitnumber
Offsetnumber
TotalResultsnumber
Localestring
Resultsarray<object>
Idstring
CIDstring
SourceClientstring
Badgesobject3 fields
BadgesOrderarray<string>
LastModeratedTimestring
LastModificationTimestring
ProductIdstring
ContextDataValuesOrderarray<string>
ClientResponsesarray<object>7 fields
UserLocationstring
AuthorIdstring
ContentLocalestring
IsFeaturedboolean
TotalInappropriateFeedbackCountnumber
TotalClientResponseCountnumber
TotalCommentCountnumber
Photosarray<object>4 fields
Ratingnumber
IsRatingsOnlyboolean
IsRecommendedboolean
Helpfulnessnumber
TotalFeedbackCountnumber
TotalNegativeFeedbackCountnumber
TotalPositiveFeedbackCountnumber
ModerationStatusstring
SubmissionTimestring
ReviewTextstring
Titlestring
UserNicknamestring
ContextDataValuesobject2 fields
Prosobject
RatingRangenumber
CommentIdsarray<object>
SubmissionIdobject
Consobject
AdditionalFieldsOrderarray<object>
AdditionalFieldsobject
InappropriateFeedbackListarray<object>
SecondaryRatingsOrderarray<object>
Includesobject
HasErrorsboolean
Errorsarray<object>
json
{
  "Limit": 0,
  "Offset": 0,
  "TotalResults": 0,
  "Locale": "string",
  "Results": [
    {
      "Id": "string",
      "CID": "string",
      "SourceClient": "string",
      "Badges": {
        "incentivizedReview": {
          "ContentType": "string",
          "Id": "string",
          "BadgeType": "string"
        },
        "Expert": {
          "ContentType": "string",
          "Id": "string",
          "BadgeType": "string"
        },
        "Staff": {
          "ContentType": "string",
          "Id": "string",
          "BadgeType": "string"
        }
      },
      "BadgesOrder": [
        "string"
      ],
      "LastModeratedTime": "string",
      "LastModificationTime": "string",
      "ProductId": "string",
      "ContextDataValuesOrder": [
        "string"
      ],
      "ClientResponses": [
        {
          "Department": "string",
          "Response": "string",
          "ResponseType": "string",
          "ResponseSource": "string",
          "Name": "string",
          "Date": "string",
          "SourceClientName": "string"
        }
      ],
      "UserLocation": "string",
      "AuthorId": "string"
    }
  ],
  "Includes": {},
  "HasErrors": false,
  "Errors": [
    {}
  ]
}

Need more? See the Bazaarvoice guide for connection setup and behaviour shared by every action.

Get Data Reviews Json — Bazaarvoice — Documentation