> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REVIEWS.io as a data source

> Bring company reviews, product reviews, questions, third-party reviews, review invitations, surveys and review statistics from REVIEWS.io to Nekt.

REVIEWS.io is a platform that collects verified reviews from your customers: it invites buyers to review your company and the products they bought, collects questions about your products, imports reviews from third-party sites, and shows them in widgets on your website. This connector reads your account through the REVIEWS.io API and brings your company reviews, product reviews, product questions and answers, third-party reviews, review statistics, review invitations, unsubscribed e-mails, review nuggets, surveys and their responses, and webhooks.

> [!NOTE]
>
> The connector only reads data. It never creates, changes or deletes anything in REVIEWS.io.

## Configuring REVIEWS.io as a Source

In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the REVIEWS.io option from the list of connectors.

Click **Next** and you'll be prompted to add your access.

### 1. Add account access

The connector uses your **Store ID** and **API Key**. In the REVIEWS.io dashboard, go to **Integrations > API**: both are on that page. API access is available on the REVIEWS.io **Plus** plan or higher.

The following configurations are available:

* **Store ID**: Your REVIEWS.io Store ID (public store key).
* **API Key**: Your REVIEWS.io private API key.
* **Start Date**: Earliest creation date read for company reviews, product reviews, questions and third-party reviews on the first sync and on full syncs. The other tables are always read in full.
* **Lookback Days** (advanced, optional): On each sync, product reviews, questions and third-party reviews created this many days before the last sync are read again, to pick up replies, tags and votes. From 1 to 365. Default: 30.

Once you're done, click **Next**.

### 2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.

> Tip: The stream can be found more easily by typing its name.

Select the streams and click **Next**.

### 3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.

* **Layer**: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
* **Folder**: a folder can be created inside the selected layer to group all tables being created from this new data source.
* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** to all tables at once and make this process faster!
* **Sync Type**: you can choose between INCREMENTAL and FULL\_TABLE.
  * Incremental: every time the extraction happens, we'll get only the new data, which is good if, for example, you want to keep every record ever fetched.
  * Full table: every time the extraction happens, we'll get the current state of the data, which is good if, for example, you don't want to have deleted data in your catalog.

Once you are done configuring, click **Next**.

### 4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters.

To define your [Trigger](https://docs.nekt.com/runs/scheduling-and-triggers.md), consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).

Optionally, you can define some additional settings:

* Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource [here](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync)**. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

Once you are ready, click **Next** to finalize the setup.

### 5. Check your new source

You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

> [!WARNING]
>
> For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.

## How the data is kept up to date

* **Company Reviews**: the first sync (and every full sync) reads the reviews created since the **Start Date**. After that, each sync reads the reviews changed since the last sync, so new reviews and changes to older ones (a reply, a tag, a moderation) always arrive.
* **Product Reviews**, **Questions** and **Third Party Reviews** are read by creation date: each sync reads what was created since the last sync, plus the **Lookback Days** before it. REVIEWS.io only filters these by creation date, so a change made to an older item (for example, an answer to a question asked months ago) is picked up only within the lookback period, or by a full sync.
* **Review Statistics**, **Company Invitations**, **Product Invitations**, **Unsubscribed Users**, **Review Nuggets**, **Surveys**, **Survey Responses** and **Webhooks** are read in full on every sync.

> [!TIP]
>
> Schedule an **Additional Full Sync** (for example, once a week) in step 4. It brings the latest state of older product reviews and questions and removes from your tables the reviews deleted in REVIEWS.io.

> [!NOTE]
>
> Every table uses the same API key, but some depend on features of your REVIEWS.io plan (for example **Surveys**, **Survey Responses**, **Review Nuggets** and **Third Party Reviews**). If the key cannot read some tables, those tables are skipped and named in the sync log, and the other tables keep syncing. Enable the feature on your REVIEWS.io account, or deselect those tables. If the Store ID or the API key is wrong, the sync fails and asks you to check them.

> [!NOTE]
>
> REVIEWS.io sends dates and times without a time zone. They are stored as they are sent, as UTC.

## Fields by stream

Nested objects sent by REVIEWS.io are split into columns where they are small (reviewer, author, statistics) and kept as JSON text where they are lists or larger objects (replies, photos, attributes, survey answers). Any field REVIEWS.io sends that has no column of its own is kept in `extra_fields`.

> [accordion] Company Reviews
>
> Reviews of your company (service and buying experience), with the rating, text, reviewer, sub-ratings, photos, tags and the replies your team posted.
>
> Table: `company_reviews` · Primary key: `store_review_id` · Sync: Incremental (by `date_created`)
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `store_review_id` | Integer | Unique REVIEWS.io identifier of the company review. |
> | `rating` | Integer | Rating the customer gave the company, from 1 to 5. |
> | `title` | String | Title of the review, when the customer wrote one. |
> | `comments` | String | Text of the review. |
> | `date_created` | Datetime | When the review was submitted (REVIEWS.io sends no time zone; stored as UTC). Replication key: the bookmark is the start of the last successful run. |
> | `order_number` | String | Order reference the review invitation was sent for ('0' when there is none). |
> | `user_id` | Integer | REVIEWS.io identifier of the reviewer. |
> | `reviewer_first_name` | String | First name of the reviewer. |
> | `reviewer_last_name` | String | Last name of the reviewer. |
> | `reviewer_email` | String | E-mail address of the reviewer (private data, sent with the API key). |
> | `reviewer_verified_buyer` | Boolean | Whether REVIEWS.io verified the reviewer as a buyer. |
> | `reviewer_address` | String | Address or location the reviewer gave, as sent by REVIEWS.io. |
> | `store_branch_id` | Integer | Identifier of the store branch the review belongs to (0 when none). |
> | `branch` | String (JSON) | Store branch the review belongs to, as sent by REVIEWS.io. |
> | `ratings` | String (JSON) | Sub-ratings the customer gave (rating attributes such as delivery or service). |
> | `images` | String (JSON) | Photos attached to the review. |
> | `tags` | String (JSON) | Tags attached to the review. |
> | `replies` | String (JSON) | Public replies the store posted on the review. |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Product Reviews
>
> Reviews of your products, with the rating, text, product, author, review attributes, photos, videos, tags and replies.
>
> Table: `product_reviews` · Primary key: `id` · Sync: Incremental (by `date_created`)
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique REVIEWS.io identifier of the item, prefixed by its type (for example 'product\_review-123456'). |
> | `type` | String | Type of the item: store\_review, product\_review, store\_third\_party\_review or questions. |
> | `type_label` | String | Human-readable type (Company, Product, Third Party or Question). |
> | `source` | String | Where the review came from (for example 'Reviews', or the third-party site). |
> | `rating` | Integer | Rating out of 5 (0 or empty for questions). |
> | `title` | String | Title of the review or question. |
> | `comments` | String | Text of the review or question. |
> | `nps` | Integer | Net Promoter Score answer given with the review, when collected. |
> | `author_name` | String | Name of the author. |
> | `author_location` | String | City and/or country of the author. |
> | `author_attributes` | String (JSON) | Reviewer attributes (for example age range or usual size) the author gave. |
> | `date_created` | Datetime | When the item was submitted (REVIEWS.io sends no time zone; stored as UTC). Replication key: the bookmark is the start of the last successful run. |
> | `order_id` | String | Order reference of the review. |
> | `sku` | String | SKU of the reviewed product (product reviews and questions). |
> | `product_name` | String | Name of the reviewed product. |
> | `helpful_count` | Integer | Number of times the review was marked as helpful. |
> | `verified` | Boolean | Whether the review is from a verified buyer. |
> | `detected_language` | String | Language REVIEWS.io detected in the text. |
> | `store_branch` | String (JSON) | Store branch of the review, as sent by REVIEWS.io. |
> | `attributes` | String (JSON) | Review attributes (sub-ratings such as fit or quality) with their values. |
> | `product_options` | String (JSON) | Product options (variant attributes) of the reviewed product. |
> | `photos` | String (JSON) | Photos submitted with the review. |
> | `unpublished_photos` | String (JSON) | Photos on the review that are not published. |
> | `videos` | String (JSON) | Videos submitted with the review (thumbnail and video links). |
> | `tags` | String (JSON) | Tags attached to the review. |
> | `replies` | String (JSON) | Public replies posted on the review (for questions: the answers). |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Questions
>
> Questions shoppers asked about your products, with the answers posted on them.
>
> Table: `questions` · Primary key: `id` · Sync: Incremental (by `date_created`)
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique REVIEWS.io identifier of the item, prefixed by its type (for example 'product\_review-123456'). |
> | `type` | String | Type of the item: store\_review, product\_review, store\_third\_party\_review or questions. |
> | `type_label` | String | Human-readable type (Company, Product, Third Party or Question). |
> | `source` | String | Where the review came from (for example 'Reviews', or the third-party site). |
> | `rating` | Integer | Rating out of 5 (0 or empty for questions). |
> | `title` | String | Title of the review or question. |
> | `comments` | String | Text of the review or question. |
> | `nps` | Integer | Net Promoter Score answer given with the review, when collected. |
> | `author_name` | String | Name of the author. |
> | `author_location` | String | City and/or country of the author. |
> | `author_attributes` | String (JSON) | Reviewer attributes (for example age range or usual size) the author gave. |
> | `date_created` | Datetime | When the item was submitted (REVIEWS.io sends no time zone; stored as UTC). Replication key: the bookmark is the start of the last successful run. |
> | `order_id` | String | Order reference of the review. |
> | `sku` | String | SKU of the reviewed product (product reviews and questions). |
> | `product_name` | String | Name of the reviewed product. |
> | `helpful_count` | Integer | Number of times the review was marked as helpful. |
> | `verified` | Boolean | Whether the review is from a verified buyer. |
> | `detected_language` | String | Language REVIEWS.io detected in the text. |
> | `store_branch` | String (JSON) | Store branch of the review, as sent by REVIEWS.io. |
> | `attributes` | String (JSON) | Review attributes (sub-ratings such as fit or quality) with their values. |
> | `product_options` | String (JSON) | Product options (variant attributes) of the reviewed product. |
> | `photos` | String (JSON) | Photos submitted with the review. |
> | `unpublished_photos` | String (JSON) | Photos on the review that are not published. |
> | `videos` | String (JSON) | Videos submitted with the review (thumbnail and video links). |
> | `tags` | String (JSON) | Tags attached to the review. |
> | `replies` | String (JSON) | Public replies posted on the review (for questions: the answers). |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Third Party Reviews
>
> Reviews REVIEWS.io collected from third-party sites connected to your account.
>
> Table: `third_party_reviews` · Primary key: `id` · Sync: Incremental (by `date_created`)
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique REVIEWS.io identifier of the item, prefixed by its type (for example 'product\_review-123456'). |
> | `type` | String | Type of the item: store\_review, product\_review, store\_third\_party\_review or questions. |
> | `type_label` | String | Human-readable type (Company, Product, Third Party or Question). |
> | `source` | String | Where the review came from (for example 'Reviews', or the third-party site). |
> | `rating` | Integer | Rating out of 5 (0 or empty for questions). |
> | `title` | String | Title of the review or question. |
> | `comments` | String | Text of the review or question. |
> | `nps` | Integer | Net Promoter Score answer given with the review, when collected. |
> | `author_name` | String | Name of the author. |
> | `author_location` | String | City and/or country of the author. |
> | `author_attributes` | String (JSON) | Reviewer attributes (for example age range or usual size) the author gave. |
> | `date_created` | Datetime | When the item was submitted (REVIEWS.io sends no time zone; stored as UTC). Replication key: the bookmark is the start of the last successful run. |
> | `order_id` | String | Order reference of the review. |
> | `sku` | String | SKU of the reviewed product (product reviews and questions). |
> | `product_name` | String | Name of the reviewed product. |
> | `helpful_count` | Integer | Number of times the review was marked as helpful. |
> | `verified` | Boolean | Whether the review is from a verified buyer. |
> | `detected_language` | String | Language REVIEWS.io detected in the text. |
> | `store_branch` | String (JSON) | Store branch of the review, as sent by REVIEWS.io. |
> | `attributes` | String (JSON) | Review attributes (sub-ratings such as fit or quality) with their values. |
> | `product_options` | String (JSON) | Product options (variant attributes) of the reviewed product. |
> | `photos` | String (JSON) | Photos submitted with the review. |
> | `unpublished_photos` | String (JSON) | Photos on the review that are not published. |
> | `videos` | String (JSON) | Videos submitted with the review (thumbnail and video links). |
> | `tags` | String (JSON) | Tags attached to the review. |
> | `replies` | String (JSON) | Public replies posted on the review (for questions: the answers). |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Review Statistics
>
> One row with the average rating and number of reviews of your account, per review type.
>
> Table: `review_statistics` · Primary key: `store_id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `store_id` | String | REVIEWS.io Store ID the statistics belong to. |
> | `product_average_rating` | Number | Average rating of the product reviews. |
> | `product_total_reviews` | Integer | Number of product reviews. |
> | `company_average_rating` | Number | Average rating of the company reviews. |
> | `company_total_reviews` | Integer | Number of company reviews. |
> | `third_party_average_rating` | Number | Average rating of the third-party reviews. |
> | `third_party_total_reviews` | Integer | Number of third-party reviews. |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Company Invitations
>
> Company review invitations: who is invited, for which order, when it is sent and whether it was sent.
>
> Table: `company_invitations` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique REVIEWS.io identifier of the invitation. |
> | `order_id` | String | Order reference the invitation was created for. |
> | `customer_name` | String | Name of the customer invited to review. |
> | `customer_email` | String | E-mail address of the customer invited to review. |
> | `email_sent` | Boolean | Whether the invitation e-mail was already sent. |
> | `status` | String | Status of the invitation: active, or paused (an inactive invitation will not be sent). |
> | `date_send` | Datetime | When the invitation is (or was) scheduled to be sent (REVIEWS.io sends no time zone; stored as UTC). |
> | `resent` | Integer | Number of times the invitation was resent manually. |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Product Invitations
>
> Product review invitations, with the products the customer is asked to review.
>
> Table: `product_invitations` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique REVIEWS.io identifier of the invitation. |
> | `order_id` | String | Order reference the invitation was created for. |
> | `customer_name` | String | Name of the customer invited to review. |
> | `customer_email` | String | E-mail address of the customer invited to review. |
> | `email_sent` | Boolean | Whether the invitation e-mail was already sent. |
> | `status` | String | Status of the invitation: active, or paused (an inactive invitation will not be sent). |
> | `date_send` | Datetime | When the invitation is (or was) scheduled to be sent (REVIEWS.io sends no time zone; stored as UTC). |
> | `resent` | Integer | Number of times the invitation was resent manually. |
> | `product` | String (JSON) | Products the customer is asked to review: SKU, name, image, description and brand. |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Unsubscribed Users
>
> E-mail addresses that unsubscribed from REVIEWS.io invitation e-mails.
>
> Table: `unsubscribed_users` · Primary key: `email` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `email` | String | E-mail address that unsubscribed from REVIEWS.io invitation e-mails. |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Review Nuggets
>
> Short highlights REVIEWS.io extracted from your company and product reviews.
>
> Table: `review_nuggets` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique REVIEWS.io identifier of the review nugget. |
> | `type` | String | Type of review the nugget was taken from: store\_review or product\_review. |
> | `text` | String | Text of the nugget. |
> | `rating` | Integer | Rating of the review the nugget was taken from. |
> | `review_id` | String | Identifier of the review the nugget was taken from. |
> | `date_created_nugget` | Datetime | When the nugget was created (REVIEWS.io sends no time zone; stored as UTC). |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Surveys
>
> Your surveys, active and inactive.
>
> Table: `surveys` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique REVIEWS.io identifier of the survey. |
> | `title` | String | Title of the survey. |
> | `question_count` | Integer | Number of questions in the survey. |
> | `responses_count` | Integer | Number of responses submitted for the survey. |
> | `active` | Boolean | Whether the survey is active. |
> | `date_created` | Datetime | When the survey was created (REVIEWS.io sends no time zone; stored as UTC). |
> | `date_updated` | Datetime | When the survey was last changed (REVIEWS.io sends no time zone; stored as UTC). |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Survey Responses
>
> Every response submitted to every survey, with the answers given.
>
> Table: `survey_responses` · Primary key: `survey_id`, `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `survey_id` | Integer | Identifier of the survey the response belongs to. |
> | `id` | Integer | Unique REVIEWS.io identifier of the survey response. |
> | `user_id` | Integer | REVIEWS.io identifier of the respondent. |
> | `completion_time` | Integer | Time the respondent took to complete the survey, in seconds. |
> | `href` | String | Page where the survey was answered. |
> | `browser` | String | Browser (user agent) of the respondent. |
> | `ip_address` | String | IP address of the respondent. |
> | `date_created` | Datetime | When the response was started (REVIEWS.io sends no time zone; stored as UTC). |
> | `date_updated` | Datetime | When the response was last changed (REVIEWS.io sends no time zone; stored as UTC). |
> | `country_code` | String | Country code of the respondent. |
> | `total_price` | Number | Total price of the respondent's order, when linked to one. |
> | `order_count` | Integer | Number of orders of the respondent. |
> | `tags` | String (JSON) | Tags of the response (name, e-mail, order id...) as label/value pairs. |
> | `responses` | String (JSON) | Answers given, one per question: question id and response. |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |

> [accordion] Webhooks
>
> Webhooks registered on your REVIEWS.io account.
>
> Table: `webhooks` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique REVIEWS.io identifier of the webhook. |
> | `type` | String | Event that triggers the webhook (for example a positive product review). |
> | `url` | String | URL the webhook posts to. |
> | `extra_fields` | String (JSON) | Fields the API returned that this connector does not map to a column, keyed by their original names (nested ones as parent.field). |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.