younifyd
Menu

Get Data Reviewcomments Json

Retrieve Comments

GET/data/reviewcomments.json

Use it in a workflow

  1. Add a step and choose the Bazaarvoice connector.
  2. Pick the Get Data Reviewcomments Json action (under display).
  3. Fill in the fields below, then reference the result from later steps as {{getDataReviewcommentsJson.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=TotalFeedbackCount:eq:3,4" will match all content with TotalFeedbackCount values equal to 3 OR 4. - Advanced operators can be used to define filters. For instance, "Filter=TotalFeedbackCount:lte:10" will match all content with a rating value less than or equal to 10. 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.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.Multiple filters are allowed as URL parameters in which case filters are AND'ed. For instance, "Filter=TotalFeedbackCount:gt:10&Filter=IsFeatured:true" will match all featured content with a TotalFeedbackCount value of greater than 10. - 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=TotalFeedbackCount:lt:5 - Comma Seperated Multiple Filter values: &filter=Id:eq:4723748,4723746 - Multiple Filter AND'ed value: &filter=SubmissionTime:gt:1610649000000&filter=SubmissionTime:lt:1610908200000&filter=IsFeatured:eq:false&filter=.....

Includestring

Related subjects to be included in the response. Can be one or more (comma-separated) of Reviews, Products, Categories, or Authors.

Limitinteger

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

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.

Sortarray<string>

Ways to sort comments - Sort criteria is specified as <sort option>:asc for ascending and <sort option>:desc for descending. - Sort order is required (asc or desc).Multi-attribute sorting is supported by using a comma separated list of sort criteria for a content/subject type. For instance Sort=TotalFeedbackCount:desc,TotalPositiveFeedbackCount:asc sorts by number of feedbacks received descending, then number of positive feedbacks received ascending. 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

Response

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

Limitnumber
Offsetnumber
TotalResultsnumber
Localestring
Resultsarray<object>
Idstring
CIDstring
SourceClientstring
LastModeratedTimestring
LastModificationTimestring
ReviewIdstring
Badgesobject1 fields
BadgesOrderarray<string>
AuthorIdstring
UserLocationstring
ContentLocalestring
IsFeaturedboolean
TotalInappropriateFeedbackCountnumber
TotalFeedbackCountnumber
TotalNegativeFeedbackCountnumber
TotalPositiveFeedbackCountnumber
ModerationStatusstring
SubmissionTimestring
CommentTextstring
Titlestring
UserNicknamestring
StoryIdobject
InappropriateFeedbackListarray<object>
Photosarray<object>
SubmissionIdobject
Videosarray<object>
CampaignIdobject
IsSyndicatedboolean
ProductRecommendationIdsarray<object>
Includesobject
HasErrorsboolean
Errorsarray<object>
json
{
  "Limit": 0,
  "Offset": 0,
  "TotalResults": 0,
  "Locale": "string",
  "Results": [
    {
      "Id": "string",
      "CID": "string",
      "SourceClient": "string",
      "LastModeratedTime": "string",
      "LastModificationTime": "string",
      "ReviewId": "string",
      "Badges": {
        "top25": {
          "ContentType": "string",
          "Id": "string",
          "BadgeType": "string"
        }
      },
      "BadgesOrder": [
        "string"
      ],
      "AuthorId": "string",
      "UserLocation": "string",
      "ContentLocale": "string",
      "IsFeatured": false
    }
  ],
  "Includes": {},
  "HasErrors": false,
  "Errors": [
    {}
  ]
}

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