Schema Information
This subtopic provides a structured reference to assist you in working with Daton's Yotpo connector and the associated fields and tables.
Schema Information
This subtopic provides a structured reference to assist you in working with Daton's Yotpo connector and the associated fields and tables.
Tables/APIs
The following is the list of tables or APIs associated with the Yotpo connector:
- Reviews
- Unsubscribers
- DynamicCouponCodes
- DynamicCouponCodeStatistics
- Questions
- WidgetSiteReviews
- ProductGroups
- Collections
- Products
- Overview
- RawData
- ReviewMetadata
- AllCustomers
- RecentCustomers
- ActiveRedemptionOptions
- ActiveCampaign
- VIPTiers
- CustomerDetails
Reviews
Purpose: Reviews are the core content generated using Yotpo. Yotpo helps generate reviews which can then later be displayed on the store's site and published on social networks.
Source API Documentation: https://apidocs.yotpo.com/reference/retrieve-all-reviews
Replication: Full-Based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
NUMERIC |
title |
STRING |
content |
STRING |
score |
NUMERIC |
votes_up |
NUMERIC |
votes_down |
NUMERIC |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
sentiment |
NUMERIC |
sku |
STRING |
name |
STRING |
email |
STRING |
reviewer_type |
STRING |
deleted |
BOOLEAN |
archived |
BOOLEAN |
| escalated | BOOLEAN |
Unsubscribers
Purpose: Retrieve a List of unsubscribers
Source API Documentation: https://apidocs.yotpo.com/reference/retrieve-a-list-of-unsubscribers
Replication: Full-Based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
NUMERIC |
user_email |
STRING |
email_type_id |
NUMERIC |
| unsubscribed_by_name | STRING |
DynamicCouponCodes
Purpose: Retrieves all Coupons created in Yotpo System.
Source API Documentation: https://apidocs.yotpo.com/reference/retrieve-all-unique-coupon-codes
Replication: Full based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
| code | STRING |
DynamicCouponCodeStatistics
Purpose: Retrieves all Coupons with statistics created in Yotpo System.
Source API Documentation: https://apidocs.yotpo.com/reference/retrieve-unique-code-statistics
Replication: Full Based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
map_review |
NUMERIC |
| map_review_share | NUMERIC |
Questions
Purpose: Retrieve all Questions
Source API Documentation: https://apidocs.yotpo.com/reference/retrieve-all-questions
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
id |
NUMERIC |
content |
STRING |
asker |
RECORD |
user_type |
STRING |
created_at |
TIMESTAMP |
archived |
BOOLEAN |
published |
BOOLEAN |
allow_sent |
BOOLEAN |
answers |
RECORD |
| products_app | RECORD |
WidgetSiteReviews
Purpose: Retrieves all widget site reviews
Source API Documentation: https://apidocs.yotpo.com/reference/retrieve-widget-site-reviews
Replication: Full-Based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
NUMERIC |
score |
NUMERIC |
votes_up |
NUMERIC |
votes_down |
NUMERIC |
content |
STRING |
title |
STRING |
created_at |
TIMESTAMP |
deleted |
BOOLEAN |
verified_buyer |
BOOLEAN |
sentiment |
NUMERIC |
product_id |
NUMERIC |
images_data |
RECORD |
user |
RECORD |
| videos_data | RECORD |
AllProducts
Purpose: Retrieves a list of all of your store's products.
Source API Documentation: https://core-api.yotpo.com/v1.0/reference/retrieve-all-products
Replication: Full Based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
NUMERIC |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
average_score |
NUMERIC |
total_reviews |
NUMERIC |
url |
STRING |
external_product_id |
STRING |
name |
STRING |
description |
STRING |
product_specs |
RECORD |
category |
RECORD |
images |
RECORD |
| blacklisted | BOOLEAN |
ProductGroups
Purpose: Retrieve product groups for account
Source API Documentation: https://core-api.yotpo.com/v1.0/reference/retrieve-product-groups-for-account
Replication: Full Based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
id |
NUMERIC |
display_name |
STRING |
| account_id | NUMERIC |
Collections
Purpose: Retrieves a list of all store's collections.
Source API Documentation: https://apidocs.yotpo.com/reference/product-collections
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
yotpo_id |
NUMERIC |
external_id |
STRING |
name |
STRING |
created_at |
TIMESTAMP |
| updated_at | TIMESTAMP |
Products
Purpose: Retrieves a list of all of your store's products
Source API Documentation: https://apidocs.yotpo.com/reference/products
Replication: Full-Based Replication
Replication Key: NA
Fields
Name |
Target Datatype |
|---|---|
yotpo_id |
NUMERIC |
external_id |
STRING |
name |
STRING |
description |
STRING |
status |
STRING |
url |
STRING |
is_valid_url |
BOOLEAN |
image_url |
STRING |
price |
NUMERIC |
compare_at_price |
NUMERIC |
currency |
STRING |
inventory_quantity |
NUMERIC |
is_discontinued |
BOOLEAN |
group_name |
STRING |
brand |
STRING |
sku |
STRING |
mpn |
STRING |
gtins |
RECORD |
custom_properties |
RECORD |
created_at |
DATETIME |
updated_at |
DATETIME |
store_id |
STRING |
is_valid_url_format |
BOOLEAN |
handle |
STRING |
external_created_at |
DATETIME |
| external_updated_at | DATETIME |
Overview
Purpose: View a summary of all metrics as an itemized list for a specified email type. Data can be segmented by email type and grouped by various metrics.
Source API Documentation: https://apidocs.yotpo.com/reference/summary
Replication: Key-Based Replication
Replication Key: lastRunDate
Fields
Name |
Target Datatype |
|---|---|
answers_from_emails |
NUMERIC |
arrived_early |
NuMERIC |
click_throughs |
NUMERIC |
emails_failed |
NUMERIC |
emails_opened |
NUMERIC |
emails_sent |
NUMERIC |
invalid_address |
NUMERIC |
marked_spam |
NUMERIC |
reviews_from_emails |
NUMERIC |
| unsubscribed | NUMERIC |
RawData
Purpose: Use this request to return detailed data about every email sent from Yotpo including the email recipient, when the email was received, order information, delivery success or failure, when the email was opened, clicks, unsubscribe, etc.
Source API Documentation: https://apidocs.yotpo.com/reference/raw-data
Replication: Key-Based Replication
Replication Key: lastRunDate
Fields
Name |
Target Datatype |
|---|---|
email_address |
STRING |
order_id |
STRING |
order_timestamp |
TIMESTAMP |
product_id |
STRING |
sku |
STRING |
email_type |
STRING |
reminder_num |
NUMERIC |
review_type |
STRING |
email_sent_timestamp |
TIMESTAMP |
opened_timestamp |
TIMESTAMP |
review_form |
STRING |
content_creation_timestamp |
TIMESTAMP |
platform |
STRING |
failed_timestamp |
TIMESTAMP |
invalid_address_timestamp |
TIMESTAMP |
coupon_code |
STRING |
clicked_through_timestamp |
TIMESTAMP |
unsubscribed_timestamp |
TIMESTAMP |
marked_spam_timestamp |
TIMESTAMP |
| arrived_early_timestamp | TIMESTAMP |
ReviewMetadata
Purpose: Retrieve a review's order, customer, and product metadata
Fields
NAME |
TARGET DATATYPE |
|---|---|
order |
RECORD |
customer |
RECORD |
| product | RECORD |
AllCustomers
Purpose: Retrieves information about all customers, providing a comprehensive view of the customer base.
Source API Documentation: https://loyaltyapi.yotpo.com/reference/get-all-customer-redemptions
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
external_id |
STRING |
first_name |
STRING |
last_name |
STRING |
account_created_at |
DATETIME |
account_updated_at |
DATETIME |
account_status |
STRING |
default_currency |
STRING |
tags |
STRING |
accepts_email_marketing |
BOOLEAN |
| channels | RECORD |
RecentCustomers
Purpose: Manages data related to recently acquired customers, facilitating insights into recent customer interactions and behavior.
Source API Documentation: https://loyaltyapi.yotpo.com/reference/fetch-all-recently-updated-customers
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
total_spend_cents |
NUMERIC |
total_purchases |
NUMERIC |
perks_redeemed |
NUMERIC |
last_purchase_at |
TIMESTAMP |
first_name |
STRING |
last_name |
STRING |
email |
STRING |
points_balance |
NUMERIC |
points_earned |
NUMERIC |
last_seen_at |
TIMESTAMP |
thirty_party_id |
STRING |
third_party_id |
STRING |
pos_account_id |
STRING |
has_store_account |
BOOLEAN |
credit_balance |
STRING |
credit_balance_in_customer_currency |
STRING |
opt_in |
BOOLEAN |
opted_in_at |
DATE |
points_expire_at |
TIMESTAMP |
vip_tier_name |
STRING |
vip_tier_entry_date |
TIMESTAMP |
vip_tier_maintenance_requirements |
RECORD |
vip_tier_actions_completed |
RECORD |
vip_tier_upgrade_requirements |
RECORD
|
ActiveRedemptionOptions
Purpose: Handles data related to active redemption options for promotions, supporting the management and tracking of promotional campaigns.
Source API Documentation: https://loyaltyapi.yotpo.com/reference/get-redemption-option-data
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
id |
NUMERIC |
icon |
STRING |
cost_text |
STRING |
amount |
NUMERIC |
applies_to_product_type |
STRING |
duration |
STRING |
type |
STRING |
discount_amount_cents |
NUMERIC |
discount_type |
STRING |
name |
STRING |
description |
STRING |
unrendered_name |
STRING |
unrendered_description |
STRING |
cart_greater_than |
STRING |
| discount_with_currency | STRING |
ActiveCampaign
Purpose: Retrieves information about currently active marketing campaigns, aiding in the monitoring and analysis of ongoing promotional efforts.
Source API Documentation: https://loyaltyapi.yotpo.com/reference/get-campaign-data
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
id |
NUMERIC |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
type |
STRING |
question |
STRING |
display_order |
NUMERIC |
reward_text |
STRING |
icon |
STRING |
cta_text |
STRING |
min_actions_required |
NUMERIC |
ask_year |
BOOLEAN |
include_audience_ids |
STRING |
max_completions_per_user |
NUMERIC |
title |
STRING |
details |
STRING |
title_with_multi_currency_template |
STRING |
details_with_multi_currency_template |
STRING |
unrendered_title |
STRING |
unrendered_details |
STRING |
admin_display_name |
STRING |
| url | STRING |
VIPTiers
Purpose: Manages VIP tiers for customer loyalty programs, enabling businesses to implement and monitor tier-based loyalty initiatives.
Source API Documentation: https://loyaltyapi.yotpo.com/reference/get-vip-tier-data
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
id |
NUMERIC |
name |
STRING |
description |
STRING |
points_multiplier |
STRING |
type |
STRING |
points_reward |
NUMERIC |
coupon_reward |
STRING |
entry_threshold |
RECORD |
retain_threshold |
RECORD |
| regain_threshold | RECORD |
CustomerDetails
Purpose: Allows users to retrieve detailed information about individual customers, enabling personalized interactions and analysis.
Source API Documentation: https://loyaltyapi.yotpo.com/reference/customer-details
Replication: Full-Based Replication
Replication Key: NA
Fields
NAME |
TARGET DATATYPE |
|---|---|
total_spend_cents |
NUMERIC |
total_purchases |
NUMERIC |
perks_redeemed |
NUMERIC |
last_purchase_at |
TIMESTAMP |
first_name |
STRING |
last_name |
STRING |
phone_number |
STRING |
email |
STRING |
points_balance |
NUMERIC |
points_earned |
NUMERIC |
last_seen_at |
TIMESTAMP |
thirty_party_id |
STRING |
third_party_id |
STRING |
pos_account_id |
STRING |
has_store_account |
BOOLEAN |
credit_balance |
STRING |
credit_balance_in_customer_currency |
STRING |
opt_in |
BOOLEAN |
opted_in_at |
DATE |
points_expire_at |
TIMESTAMP |
vip_tier_name |
STRING |
vip_tier_entry_date |
TIMESTAMP |
vip_tier_maintenance_requirements |
RECORD |
vip_tier_actions_completed |
RECORD |
| vip_tier_upgrade_requirements | RECORD |
