younifyd
Menu

Get Review Preview

Preview Review Form

GET/data/submitreview.json

Use it in a workflow

  1. Add a step and choose the Bazaarvoice connector.
  2. Pick the Get Review Preview action (under submission).
  3. Fill in the fields below, then reference the result from later steps as {{getReviewPreview.response.data}}.

Request

Query parameters

ApiVersionnumberrequired

The API version, e.g. 5.4.

PassKeystringrequired

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

ProductIdstringrequired

The id of the product for which submission form is requested.

Actionstring

The submission action to take

Ratinginteger

Value is positive integer between 1 and 5, and represents review overall rating.

ReviewTextstring

Value is review body text.The minimum length is configurable, default is 50 but can be lower.

Titlestring

Value is content title text. The minimum and maximum lengths are configurable. The current default is 50 characters, but can be lower to 1 or higher to 255.

UserNicknamestring

User nickname display text.

agreedtotermsandconditionsboolean

Boolean indicating whether or not the user agreed to the terms and conditions. Required depending on the client's settings.

Response

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

Localestring

The locale of the review.

Errorsarray<object>
Typestring
Idstring
Formarray<object>
Typestring
Idstring
FormErrorsobject
SubmissionIdstring

The submission ID.

Dataobject
Fieldsobject
Groupsobject
FieldsOrderarray<string>
GroupsOrderarray<string>
TypicalHoursToPostnumber

The typical number of hours it takes for a submission to be posted

Reviewobject
SendEmailAlertWhenCommentedboolean

Flag indicating whether to send an email alert when the review is commented on.

Ratingnumber

The rating of the review.

SubmissionTimestring

The submission time of the review.

ReviewTextstring

The text content of the review.

SubmissionIdstring

The submission ID of the review.

Titlestring

The title of the review.

IsRecommendedboolean

Flag indicating whether the review is recommended.

TypicalHoursToPostnumber

The typical number of hours it takes for the review to be posted.

Idstring

The ID of the review.

SendEmailAlertWhenPublishedboolean

Flag indicating whether to send an email alert when the review is published.

AuthorSubmissionTokenstring
HasErrorsboolean
json
{
  "Locale": "string",
  "Errors": [
    {
      "Type": "string",
      "Id": "string"
    }
  ],
  "Form": [
    {
      "Type": "string",
      "Id": "string"
    }
  ],
  "FormErrors": {},
  "SubmissionId": "string",
  "Data": {
    "Fields": {},
    "Groups": {},
    "FieldsOrder": [
      "string"
    ],
    "GroupsOrder": [
      "string"
    ]
  },
  "TypicalHoursToPost": 0,
  "Review": {
    "SendEmailAlertWhenCommented": false,
    "Rating": 0,
    "SubmissionTime": "string",
    "ReviewText": "string",
    "SubmissionId": "string",
    "Title": "string",
    "IsRecommended": false,
    "TypicalHoursToPost": 0,
    "Id": "string",
    "SendEmailAlertWhenPublished": false
  },
  "AuthorSubmissionToken": "string",
  "HasErrors": false
}

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