This endpoint Retrieves Product-level data for a given product by product ID (domain_key). Product-level data can be used within your reviews widget.
For example, you can use it to:
- Retrieve Smart Topics (Ai AI-generated filters) - displayed as smart filters within your reviews widget.
- Retrieve AI review summary (Ai generated reviews summary per product) - displayed as CTA within your reviews widget.
- Retrieve Summary Highlights (Returns the highlights from 3 top reviews - chosen by AI) - displayed as part of the AI summary within your reviews widget.
- Retrieve Countries the product was reviewed from - displayed as smart filters within your reviews widget;
- Retrieve Custom Questions per product - displayed as smart filters within your reviews widget;
- Retrieve Metadata per product - displayed as smart filters within your reviews widget;
- Retrieve Variants per product - displayed as Variant filters within your reviews widget;
{
"status": {
"code": 200,
"message": "OK"
},
"response": {
"pagination": {
"page": 1,
"per_page": 1,
"total": 2
},
"grouping_data": {},
"products": [
{
"id": 70657043,
"domain_key": "95035719697",
"name": "24/7TM Cotton T-Shirt Bra",
"social_links": {
"facebook": "https://yotpo.com/go/akRE3Z9B",
"twitter": "https://yotpo.com/go/ebubSXTt",
"linkedin": "https://yotpo.com/go/y3YrkfjM",
"google_oauth2": "https://yotpo.com/go/pWHrvVTP"
},
"embedded_widget_link": "https://yotpo.com/go/58oL2P53",
"testimonials_product_link": "https://yotpo.com/go/7vv4tQHk",
"product_link": "https://yotpo.com/go/4ZD1E1Ua",
"image_url": null
}
],
"reviews": [
{
"id": 70491279,
"score": 5,
"votes_up": 3,
"votes_down": 0,
"content": "This bra is exactly what I've been waiting for: breathable comfort and a cute, casual style. I love the keyhole cutout and it fits great, too!",
"title": "My New Favorite",
"created_at": "2018-10-10T23:34:46.000Z",
"verified_buyer": false,
"source_review_id": null,
"sentiment": 0.991569,
"topics": {
"comfort": {
"name": "comfort",
"sentence": "This bra is exactly what I've been waiting for: breathable comfort and a cute, casual style."
},
"cutout": {
"name": "cutout",
"sentence": "I love the keyhole cutout and it fits great, too!"
},
"fit": {
"name": "fit",
"sentence": "I love the keyhole cutout and it fits great, too!"
},
"style": {
"name": "style",
"sentence": "This bra is exactly what I've been waiting for: breathable comfort and a cute, casual style."
}
},
"fields_highlights": {},
"custom_fields": null,
"product_id": 70657043,
"user": {
"user_id": 20604665,
"social_image": "https://ddcfq0gxiontw.cloudfront.net/images/anonymous_user.png",
"user_type": "User",
"is_social_connected": 0,
"display_name": "Nicole Y."
}
}
],
"found_filtered_reviews": true
}
}
{
"status": {
"code": 200,
"message": "OK"
},
"response": {
"pagination": {
"page": 1,
"per_page": 5,
"total": 222
},
"grouping_data": {},
"products": [
{
"id": 68701220,
"domain_key": "538465337388",
"name": "Brazilian Bum Bum Cream",
"social_links": {
"facebook": "https://yotpo.com/go/6z8hDc4s",
"twitter": "https://yotpo.com/go/yztUcDk3",
"linkedin": "https://yotpo.com/go/w1i777YD",
"google_oauth2": "https://yotpo.com/go/kZn7yarP"
},
"embedded_widget_link": "https://yotpo.com/go/iu0Civar",
"testimonials_product_link": "https://yotpo.com/go/tWXclTgr",
"product_link": "https://yotpo.com/go/3rrBmmOz",
"image_url": null
}
],
"product_tags": [],
"reviews": [
{
"id": 70598161,
"score": 5,
"votes_up": 0,
"votes_down": 0,
"content": "Amazing lotion",
"title": "LOVE this scent",
"created_at": "2018-10-12T04:28:10.000Z",
"verified_buyer": true,
"source_review_id": null,
"sentiment": 0.984246,
"topics": {
"lotion": {
"name": "lotion",
"sentence": "Amazing lotion"
}
},
"fields_highlights": {
"review_content": [
"lotion"
]
},
"custom_fields": {
"--14860": {
"title": "What I Love",
"form_id": 11849,
"field_type": "MultipleChoice",
"value": "Hydrates Skin, Smells Great, Absorbs Quickly, Not Greasy"
},
"--14856": {
"title": "Skin Hydration",
"form_id": 11849,
"field_type": "Rating",
"value": 5
},
"--14857": {
"title": "Absorption Speed",
"form_id": 11849,
"field_type": "Rating",
"value": 4
},
"--14855": {
"title": "Scent",
"form_id": 11849,
"field_type": "Rating",
"value": 5
},
"--14858": {
"title": "Age",
"form_id": 11849,
"field_type": "SingleChoice",
"value": "55 - 64"
},
"--14859": {
"title": "Skin Type",
"form_id": 11849,
"field_type": "MultipleChoice",
"value": "Dry"
}
},
"product_id": 68701220,
"user": {
"user_id": 113769,
"social_image": "https://ddcfq0gxiontw.cloudfront.net/images/anonymous_user.png",
"user_type": "User",
"is_social_connected": 0,
"display_name": "Carol B."
}
}
],
"found_filtered_reviews": true
}
}
Path params
| Param | Type | Description |
|---|---|---|
| storeID | String | The store ID (App Key) |
| productId | String | The product ID |
The path parameters {storeId} and {productId} are placeholders that need to be replaced with specific values to access data for a particular product in a store.
Query params
| Param | Type | Description |
|---|---|---|
| Include | List | Topics, reviewsSummary, metadata, customQuestions, countries and productVariants |
The endpoint accepts a query parameter called include, which specifies the type of data to retrieve. This parameter is a list that may include as indicated above:
Each of these is case-sensitive and allows you to control which sections of data are returned, helping to limit the size and scope of the response.
Important
The Include query param is required in order for this call to return a 200 result.
Expected Response
When the request is successful, you’ll receive a 200 OK status code, meaning the data retrieval was successful. Here’s what each part of the response data includes:
Results
{
"status": {
"code": 200,
"message": "Product Data Retrieved successfully"
},
"response": {
"storeId": "eRxKnj58u1tO0iFkjWVldkVSymwLydHsg4IKulTB",
"productId": "7456267731157",
"externalId": "7456267731157",
"topics": [
"devices",
"color",
"computers",
"price",
"medium",
"picture",
"shipping",
"selection",
"control",
"solution"
],
"customQuestions": [
{
"questionId": 83663,
"title": "T-shirts size",
"question": "How do you find the size of your T-shirts?",
"options": [
"They run small",
"True to size",
"They run big"
],
"fieldType": "Size",
"mandatory": false
},
{
"questionId": 83665,
"title": "Age",
"question": "What is your age?",
"options": [
"15-35",
"35-55",
"55-75"
],
"fieldType": "SingleChoice",
"mandatory": true
},
{
"questionId": 84696,
"title": "Quality",
"question": "How is the quality?",
"options": [
"Very Weak",
"Weak",
"Okay",
"Good",
"Very Good"
],
"fieldType": "Rating",
"mandatory": true
},
],
"metadata": [
{
"title": "size",
"displayedTitle": "Size",
"options": [
"XXL"
],
"fieldType": "order_product_properties"
},
{
"title": "material",
"displayedTitle": "material",
"options": [
"soft"
],
"fieldType": "order_product_properties"
},
{
"title": "color",
"displayedTitle": "Color",
"options": [
"White"
],
"fieldType": "order_product_properties"
},
{
"title": "vendor",
"displayedTitle": "vendor",
"options": [
"CP"
],
"fieldType": "order_product_properties"
},
{
"title": "model",
"displayedTitle": "Model",
"options": [
"mP2"
],
"fieldType": "order_product_properties"
},
{
"title": "state",
"displayedTitle": "State",
"options": [
"California"
],
"fieldType": "customer_properties"
},
{
"title": "2_3",
"displayedTitle": "2 3",
"options": [
"2",
"3",
],
"fieldType": "order_custom_properties"
},
{
"title": "take",
"displayedTitle": "Take",
"options": [
"on me",
"me on"
],
"fieldType": "order_custom_properties"
},
{
"title": "country",
"displayedTitle": "Country",
"options": [
"IL",
"JP",
"US"
],
"fieldType": "customer_properties"
},
{
"title": "customer_name",
"displayedTitle": "Name",
"options": [
"Goku",
"Dror",
"Shir",
],
"fieldType": "customer_custom_properties"
},
],
"summaryTopics": [
{
"topic": "UPDATE_1",
"summary": "I love it",
"coverage": "100%",
"avgSentiment": 0.9741568
},
{
"topic": "UPDATE_2",
"summary": "Summary",
"coverage": "100%",
"avgSentiment": 0.9489522
}
],
"summaryHighlights": [
{
"reviewId": 416746124,
"reviewerName": "reviewer1",
"highlight": "highlight1"
}
],
"countries": [
{
"code": "IL",
"label": "🇮🇱 Israel",
"count": 219
},
{
"code": "FR",
"label": "🇫🇷 France",
"count": 1
},
{
"code": "US",
"label": "🇺🇸 United States",
"count": 6
}
]
}
}
How to use this endpoint
- Requests for this endpoint are limited to 30,000 requests/minute, per IP address.
- Data is retrieved with a delay of 3 hours.