Event Date

event_date

date

The date the review was submitted. Based on the time zone of the shop at the moment of the review submission.

Event Day

event_date.day

date

The day on which the event occurred. Derived from event_date.

Event Week

event_date.week

date

The Sunday of the week during which the event occurred. Derived from event_date.

Event Month

event_date.month

date

The month during which the event occurred. Derived from event_date.

Event Quarter

event_date.quarter

date

The first month of the quarter during which the event occurred. Derived from event_date.

Event Year

event_date.year

date

The year during which the event occurred. Derived from event_date.

Attributes with Rating

attributes_with_rating

record repeated

A list of rating attributes within the review. Set in the reviews platform.

Minimum Rating Label

attributes_with_rating.min_label

string

The label for the minimum rating value.

Example values: Runs small, Disappointing

Mid Label Rating

attributes_with_rating.mid_label

string

The label for the midpoint rating value.

Example values: True to size, As expected

Title

attributes_with_rating.title

string

The title of the rating attribute.

Example values: Size Range, Quality

Type

attributes_with_rating.type

string

The type of the rating attribute.

Example values: range, multi-select, single-select

Value

attributes_with_rating.value

string

The rating value for the attribute.

Example values: -1, 0, 0.5, 2

Maximum Rating Label

attributes_with_rating.max_label

string

The label for the maximum rating value.

Example values: Runs large, Exceeds expectations

Contains Profanity

contains_profanity

boolean

True if the review contains profanity.

Possible values: true, false

Content

content

string

The text content of the review.

Example values: Fits nicely, Better quality than it looked in the pictures

Review ID

id

string

The unique identifier for the review.

Example value: 948f450e-5b38-4a2e-ace6-470b7b5535cf

Is Recommended

is_recommended

boolean

True if the product is recommended by the reviewer.

Possible values: true, false

Marketplace

marketplace

string

The marketplace where the review was submitted.

Example value: shopify

Order ID

order_id

string

The unique identifier for the order associated with the review.

Example value: 4930225799243

Platform

platform

string

The platform through which the review was submitted.

Example values: okendo, yotpo

Product ID

product_id

string

The unique identifier of the reviewed product.

Example value: 3891505496131

Product Name

product_name

string

The name of the reviewed product.

Example values: Green Soft Socks 3-Pack, Paring Knife Travel Case, Gift Subscription

Review Type

review_type

string

The type of review submitted.

Example value: product

Reviewer Attributes

reviewer_attributes

record repeated

Attributes associated with the reviewer.

Reviewer Title

reviewer_attributes.title

string

The title of the reviewer.

Reviewer Type

reviewer_attributes.type

string

The type of the reviewer.

Reviewer Value

reviewer_attributes.value

string

The value of the reviewer.

Reviewer Country Code

reviewer_country_code

string

The country code of the reviewer, according to ISO 3166-1 alpha-2. See list of country codes.

Example value: US

Reviewer Display Name

reviewer_display_name

string

The display name of the reviewer.

Reviewer Email

reviewer_email

string

The email address of the reviewer.

Reviewer Is Verified

reviewer_is_verified

boolean

True if the reviewer is a verified customer.

Possible values: true, false

Reviewer Name

reviewer_name

string

The name of the reviewer.

Reviewer Verified Status

reviewer_verified_status

string

The verification status of the reviewer.

Sentiment

sentiment

string

The sentiment analysis result for the review content.

Example values: positive, mixed, negative

Status

status

string

The status of the review.

Example values: approved, published, unpublished

Title

title

string

The title of the review.

Example values: Almost perfect, Would not recommend, Absolutely beautiful!

Variant ID

variant_id

string

The unique identifier of the reviewed product variant.

Example value: 29275946877001