The connector only reads data. It never creates, changes or deletes anything in REVIEWS.io.
Configuring REVIEWS.io as a Source
In the 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.
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.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, 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.
- Determine when to execute an 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.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.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.
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.
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 inextra_fields.
Company Reviews
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)Product Reviews
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)Questions
Questions
Questions shoppers asked about your products, with the answers posted on them.Table:
questions · Primary key: id · Sync: Incremental (by date_created)Third Party Reviews
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)Review Statistics
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 tableCompany Invitations
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 tableProduct Invitations
Product Invitations
Product review invitations, with the products the customer is asked to review.Table:
product_invitations · Primary key: id · Sync: Full tableUnsubscribed Users
Unsubscribed Users
E-mail addresses that unsubscribed from REVIEWS.io invitation e-mails.Table:
unsubscribed_users · Primary key: email · Sync: Full tableReview Nuggets
Review Nuggets
Short highlights REVIEWS.io extracted from your company and product reviews.Table:
review_nuggets · Primary key: id · Sync: Full tableSurveys
Surveys
Your surveys, active and inactive.Table:
surveys · Primary key: id · Sync: Full tableSurvey Responses
Survey Responses
Every response submitted to every survey, with the answers given.Table:
survey_responses · Primary key: survey_id, id · Sync: Full tableWebhooks
Webhooks
Webhooks registered on your REVIEWS.io account.Table:
webhooks · Primary key: id · Sync: Full table