Jump to Content

Guides API Reference

v1.0

Core API Loyalty API App Developer API Help Center

API Reference

Core API Loyalty API App Developer API Help Center

v1.0

All

Pages

Start typing to search…

General

Welcome
Table of contents
Guidelines & conventions
Changelog
Finding your app key and API secret

Authentication

About authentication
Yotpo authenticationpost

Reviews - Merchant

About reviews (merchant)
Create reviewpost
Create review (synchronous)post
Retrieve all reviewsget
Retrieve a review by review IDget
Retrieve reviews for a user using external user reference IDget
Retrieve bottom line (total reviews and average score) for a specific product
Retrieve bottom line (total reviews and average score) for all products
Retrieve bottom line (total reviews and average score) for all site reviewsget
Update incentivized reviews by review IDput

Reviews - Storefront

About reviews (storefront)
Retrieve reviews for a product
Retrieve widget site reviews
Upvote or downvote reviewspost
Top mentioned topics
Search reviews
Product-Level Data
All-Bottomline

Reviews Metadata

About reviews metadata
Add metadata to an existing reviewpost
Get review metadataget
Retrieve review filters and valuesget
Update existing review metadataput

Static HTML

Retrieve the reviews payload in HTML

Questions and Answers (Q&A)

About Q&A
Retrieve Q&A for a productget
Retrieve the bottom line for Q&Aget
Retrieve all questionsget
Create an answer to a questionpost
Create question (without confirmation email)post
Create question (with confirmation email)post
Vote on answerspost

Dynamic Coupons

About dynamic coupons
Delete a dynamic coupon action's codespost
Retrieve all dynamic coupon codesget
Retrieve dynamic coupon code statisticsget
Upload dynamic coupon codespost

Email Analytics

About analytics
Email analyticsget
Overviewget
Raw dataget
Export email analyticsget

Visual UGC

About Visual UGC
Import imagespost
Import videospost
Get mediaget
Custom albumsget
Photos by albumget
Product imagesget
Video upload errorsget

SEO

About SEO
Find if your yotpo.me Subdomain is availableget
Retrieve your reviews.me URLget

Rich Content

Top Three 5-Star Reviewsget

Unsubscribers

About unsubscribers
Remove a set of email addresses from email distribution listspost
Re-add email addresses to email distribution listsdel
Retrieve a list of unsubscribersget

Privacy

About Privacy API
Data existsget
User dataget

Webhooks

About webhooks
Create webhookpost
Get account webhooksget
Get subscribed webhookget
Get webhook eventsget
Update subscribed webhookput
Delete webhookdel

Insights

About Insights API
Topicspost
Reviews per topicpost
Productspost
Reviews per productpost
Product collectionspost

api-settings

/v3/storefront/stores/{storeId}/products/{productId}/productData?include=topics,reviewsSummary,metadata
- getget

Powered by

get

get https://api.yotpo.com/v3/storefront/stores/{storeId}/products/{productId}/productData?include=topics,reviewsSummary,metadata

Language

URL