# Yotpo

### Snapshot

| Features                        | Details                                          |
| ------------------------------- | ------------------------------------------------ |
| Release Status                  | Released                                         |
| Source API Version              | v2                                               |
| Table Selection                 | Yes                                              |
| Column Selection                | Yes                                              |
| Edit Integration                | Yes                                              |
| Replication Type Selection      | No                                               |
| Authentication Parameters       | <p>Yotpo Client Id<br>Yotpo Client Secret</p>    |
| Replication Type                | <p>Key based Replication<br>Full Replication</p> |
| Replication Key                 | <p>DATE<br>NA</p>                                |
| Suggested Replication Frequency | 24 hrs                                           |

| Tables/APIs Supported       |                    |
| --------------------------- | ------------------ |
| Overview                    | Reviews            |
| RawData                     | DynamicCouponCodes |
| DynamicCouponCodeStatistics | AllProducts        |
| ProductGroups               | WidgetSiteReviews  |

UnSubscribers

### Integrate Yotpo with Daton

1. Signin to Daton
2. Select Yotpo from Integrations page
3. Provide Integration Name Replication Frequency and History. Integration name would be used in creating tables for the integration and cannot be changed later
4. Provide your yotpo client id and yotpo client secret.
5. After providing the details to authorize Daton to periodically extract data from Yotpo.
6. Post successful authentication you will be prompted to choose from the list of available tables
7. Then select all required fields for each table
8. Submit the integration.

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### Yotpo Data

**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 |
| --------------------- | --------------- |
| email\_type           | STRING          |
| start\_date           | DATE            |
| end\_date             | DATE            |
| 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         |

**Reviews**

Purpose:Reviews are the core content generated using Yotpo. Yotpo helps generating 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: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name            | Target Datatype |
| --------------- | --------------- |
| id              | INTEGER         |
| 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         |
| user\_reference | STRING          |

**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                | STRING          |
| trr\_bundle\_id              | STRING          |
| trr\_bundle\_subject         | STRING          |
| review\_type                 | STRING          |
| coupon\_code                 | STRING          |
| email\_sent\_timestamp       | TIMESTAMP       |
| opened\_timestamp            | TIMESTAMP       |
| clicked\_through\_timestamp  | TIMESTAMP       |
| content\_creation\_timestamp | TIMESTAMP       |
| review\_form                 | STRING          |
| platform                     | STRING          |
| invalid\_address\_timestamp  | TIMESTAMP       |
| failed\_timestamp            | TIMESTAMP       |
| unsubscribed\_timestamp      | TIMESTAMP       |
| marked\_spam\_timestamp      | TIMESTAMP       |
| arrived\_early\_timestamp    | TIMESTAMP       |

**DynamicCouponCodes**

Purpose: Retrieves all Coupons created in yotpo System.

Source API Documentation  <https://apidocs.yotpo.com/reference#introduction-to-coupons>

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         |

**AllProducts**

Purpose: Use this endpoint to retrieves a list of all of your store's products.

Source API Documentation  <https://apidocs.yotpo.com/reference#retrieve-all-products>

Replication: Full Based Replication

Replication Key: NA

**Fields**

| Name                  | Target Datatype |
| --------------------- | --------------- |
| id                    | NUMERIC         |
| created\_at           | TIMESTAMP       |
| updated\_at           | TIMESTAMP       |
| blacklisted           | BOOLEAN         |
| average\_score        | NUMERIC         |
| total\_reviews        | NUMERIC         |
| url                   | STRING          |
| external\_product\_id | INTEGER         |
| name                  | STRING          |
| description           | STRING          |
| product\_specs        | RECORD          |
| category              | RECORD          |
| images                | RECORD          |

**ProductGroups**

Purpose: Retrieve product groups for account

Source API Documentation  <https://apidocs.yotpo.com/reference#retrieve-product-groups-for-account>

Replication: Full Based Replication

Replication Key: NA

**Fields**

| Name          | Target Datatype |
| ------------- | --------------- |
| id            | INTEGER         |
| display\_name | STRING          |
| account\_id   | INTEGER         |

**WidgetSiteReviews**

Purpose: Retrieves all widget site reviews for yotpo system.

Source API Documentation  <https://apidocs.yotpo.com/reference#retrieve-widget-site-reviews>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name            | Target Datatype |
| --------------- | --------------- |
| id              | INTEGER         |
| score           | NUMERIC         |
| votes\_up       | NUMERIC         |
| votes\_down     | NUMERIC         |
| content         | STRING          |
| title           | STRING          |
| sentiment       | NUMERIC         |
| created\_at     | TIMESTAMP       |
| verified\_buyer | BOOLEAN         |
| product\_id     | INTEGER         |
| user            | RECORD          |

**UnSubscribers**

Purpose: Retrieve a List of unsubscribers for yotpo system.

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                     | INTEGER         |
| user\_email            | STRING          |
| email\_type\_id        | NUMERIC         |
| unsubscribed\_by\_name | STRING          |