> For the complete documentation index, see [llms.txt](https://daton-sarasanalytics.gitbook.io/daton/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/saas-integrations/yotpo-v2/schema-information.md).

# Schema Information

## Tables/APIs 

The following is the list of tables or APIs associated with the Yotpo connector:

1. [Reviews](#reviews) 
2. [Unsubscribers](#unsubscribers) 
3. [DynamicCouponCodes](#dynamiccouponcodes) 
4. [DynamicCouponCodeStatistics](#dynamiccouponcodestatistics) 
5. [Questions](#questions) 
6. [WidgetSiteReviews](#widgetsitereviews) 
7. [AllProducts](#allproducts) 
8. [ProductGroups](#productgroups) 
9. [Collections](#collections) 
10. [Products](#products) 
11. [Overview](#overview) 
12. [RawData](#rawdata) 
13. [ReviewMetadata](#reviewmetadata) 
14. [AllCustomers](#allcustomers) 
15. [RecentCustomers](#recentcustomers) 
16. [ActiveRedemptionOptions](#activeredemptionoptions) 
17. [ActiveCampaign](#activecampaign) 
18. [VIPTiers](#viptiers) 
19. [CustomerDetails](#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&#x20;

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**

<table><thead><tr><th width="379">Name</th><th>Target Datatype</th></tr></thead><tbody><tr><td>answers_from_emails</td><td>NUMERIC</td></tr><tr><td>arrived_early</td><td>NuMERIC</td></tr><tr><td>click_throughs</td><td>NUMERIC</td></tr><tr><td>emails_failed</td><td>NUMERIC</td></tr><tr><td>emails_opened</td><td>NUMERIC</td></tr><tr><td>emails_sent</td><td>NUMERIC</td></tr><tr><td>invalid_address</td><td>NUMERIC</td></tr><tr><td>marked_spam</td><td>NUMERIC</td></tr><tr><td>reviews_from_emails</td><td>NUMERIC</td></tr><tr><td>unsubscribed</td><td>NUMERIC</td></tr></tbody></table>

#### **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

Source API Documentation: <https://apidocs.yotpo.com/reference/get-review-metadata-by-review-id>

Replication: Full-Based Replication

Replication Key: NA

**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**

<table><thead><tr><th width="64">NAME</th><th width="64">TARGET DATATYPE</th></tr></thead><tbody><tr><td>external_id</td><td>STRING</td></tr><tr><td>first_name</td><td>STRING</td></tr><tr><td>last_name</td><td>STRING</td></tr><tr><td>account_created_at</td><td>DATETIME</td></tr><tr><td>account_updated_at</td><td>DATETIME</td></tr><tr><td>account_status</td><td>STRING</td></tr><tr><td>default_currency</td><td>STRING</td></tr><tr><td>tags</td><td>STRING</td></tr><tr><td>accepts_email_marketing</td><td>BOOLEAN</td></tr><tr><td>channels</td><td>RECORD</td></tr></tbody></table>

#### 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**

<table><thead><tr><th width="64">NAME</th><th width="64">TARGET DATATYPE</th></tr></thead><tbody><tr><td>total_spend_cents</td><td>NUMERIC</td></tr><tr><td>total_purchases</td><td>NUMERIC</td></tr><tr><td>perks_redeemed</td><td>NUMERIC</td></tr><tr><td>last_purchase_at</td><td>TIMESTAMP</td></tr><tr><td>first_name</td><td>STRING</td></tr><tr><td>last_name</td><td>STRING</td></tr><tr><td>email</td><td>STRING</td></tr><tr><td>points_balance</td><td>NUMERIC</td></tr><tr><td>points_earned</td><td>NUMERIC</td></tr><tr><td>last_seen_at</td><td>TIMESTAMP</td></tr><tr><td>thirty_party_id</td><td>STRING</td></tr><tr><td>third_party_id</td><td>STRING</td></tr><tr><td>pos_account_id</td><td>STRING</td></tr><tr><td>has_store_account</td><td>BOOLEAN</td></tr><tr><td>credit_balance</td><td>STRING</td></tr><tr><td>credit_balance_in_customer_currency</td><td>STRING</td></tr><tr><td>opt_in</td><td>BOOLEAN</td></tr><tr><td>opted_in_at</td><td>DATE</td></tr><tr><td>points_expire_at</td><td>TIMESTAMP</td></tr><tr><td>vip_tier_name</td><td>STRING</td></tr><tr><td>vip_tier_entry_date</td><td>TIMESTAMP</td></tr><tr><td>vip_tier_maintenance_requirements</td><td>RECORD</td></tr><tr><td>vip_tier_actions_completed</td><td>RECORD</td></tr><tr><td>vip_tier_upgrade_requirements</td><td>RECORD</td></tr></tbody></table>

#### 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**

<table><thead><tr><th width="64">NAME</th><th width="64">TARGET DATATYPE</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>icon</td><td>STRING</td></tr><tr><td>cost_text</td><td>STRING</td></tr><tr><td>amount</td><td>NUMERIC</td></tr><tr><td>applies_to_product_type</td><td>STRING</td></tr><tr><td>duration</td><td>STRING</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>discount_amount_cents</td><td>NUMERIC</td></tr><tr><td>discount_type</td><td>STRING</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>description</td><td>STRING</td></tr><tr><td>unrendered_name</td><td>STRING</td></tr><tr><td>unrendered_description</td><td>STRING</td></tr><tr><td>cart_greater_than</td><td>STRING</td></tr><tr><td>discount_with_currency</td><td>STRING</td></tr></tbody></table>

#### 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**

<table><thead><tr><th width="64">NAME</th><th width="64">TARGET DATATYPE</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>created_at</td><td>TIMESTAMP</td></tr><tr><td>updated_at</td><td>TIMESTAMP</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>question</td><td>STRING</td></tr><tr><td>display_order</td><td>NUMERIC</td></tr><tr><td>reward_text</td><td>STRING</td></tr><tr><td>icon</td><td>STRING</td></tr><tr><td>cta_text</td><td>STRING</td></tr><tr><td>min_actions_required</td><td>NUMERIC</td></tr><tr><td>ask_year</td><td>BOOLEAN</td></tr><tr><td>include_audience_ids</td><td>STRING</td></tr><tr><td>max_completions_per_user</td><td>NUMERIC</td></tr><tr><td>title</td><td>STRING</td></tr><tr><td>details</td><td>STRING</td></tr><tr><td>title_with_multi_currency_template</td><td>STRING</td></tr><tr><td>details_with_multi_currency_template</td><td>STRING</td></tr><tr><td>unrendered_title</td><td>STRING</td></tr><tr><td>unrendered_details</td><td>STRING</td></tr><tr><td>admin_display_name</td><td>STRING</td></tr><tr><td>url</td><td>STRING</td></tr></tbody></table>

#### 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**

<table><thead><tr><th width="64">NAME</th><th width="64">TARGET DATATYPE</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>description</td><td>STRING</td></tr><tr><td>points_multiplier</td><td>STRING</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>points_reward</td><td>NUMERIC</td></tr><tr><td>coupon_reward</td><td>STRING</td></tr><tr><td>entry_threshold</td><td>RECORD</td></tr><tr><td>retain_threshold</td><td>RECORD</td></tr><tr><td>regain_threshold</td><td>RECORD</td></tr></tbody></table>

#### 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**

<table><thead><tr><th width="64">NAME</th><th width="64">TARGET DATATYPE</th></tr></thead><tbody><tr><td>total_spend_cents</td><td>NUMERIC</td></tr><tr><td>total_purchases</td><td>NUMERIC</td></tr><tr><td>perks_redeemed</td><td>NUMERIC</td></tr><tr><td>last_purchase_at</td><td>TIMESTAMP</td></tr><tr><td>first_name</td><td>STRING</td></tr><tr><td>last_name</td><td>STRING</td></tr><tr><td>phone_number</td><td>STRING</td></tr><tr><td>email</td><td>STRING</td></tr><tr><td>points_balance</td><td>NUMERIC</td></tr><tr><td>points_earned</td><td>NUMERIC</td></tr><tr><td>last_seen_at</td><td>TIMESTAMP</td></tr><tr><td>thirty_party_id</td><td>STRING</td></tr><tr><td>third_party_id</td><td>STRING</td></tr><tr><td>pos_account_id</td><td>STRING</td></tr><tr><td>has_store_account</td><td>BOOLEAN</td></tr><tr><td>credit_balance</td><td>STRING</td></tr><tr><td>credit_balance_in_customer_currency</td><td>STRING</td></tr><tr><td>opt_in</td><td>BOOLEAN</td></tr><tr><td>opted_in_at</td><td>DATE</td></tr><tr><td>points_expire_at</td><td>TIMESTAMP</td></tr><tr><td>vip_tier_name</td><td>STRING</td></tr><tr><td>vip_tier_entry_date</td><td>TIMESTAMP</td></tr><tr><td>vip_tier_maintenance_requirements</td><td>RECORD</td></tr><tr><td>vip_tier_actions_completed</td><td>RECORD</td></tr><tr><td>vip_tier_upgrade_requirements</td><td>RECORD</td></tr></tbody></table>