This integration is powered by Singer's Revinate tap. For support, visit the GitHub repo or join the Singer Slack.
Revinate integration summary
Stitch’s Revinate integration replicates data using the Revinate Porter API. Refer to the Schema section for a list of objects available for replication.
Revinate feature snapshot
A high-level look at Stitch's Revinate (v1) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on February 13, 2019 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Unsupported |
Column selection |
Unsupported |
| Select all |
Unsupported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Revinate
Revinate setup requirements
To set up Revinate in Stitch, you need:
-
A Revinate account with API access. Reach out to your Revinate sales representative or account manager to obtain the correct permissions.
-
A Revinate API token and secret. To obtain these credentials, reach out to your Revinate sales representative or account manager.
Step 1: Add Revinate as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Revinate icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Revinate” would create a schema called
stitch_revinatein the destination. Note: Schema names cannot be changed after you save the integration. - In the Username field, enter your Revinate username.
- In the API Key field, paste your Revinate API key. Your Revinate API token must be obtained through your Revinate sales representative or account manager.
- In the API Secret field, paste your Revinate API secret. Your Revinate API secret must be obtained through your Revinate sales representative or account manager.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Revinate integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Revinate’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Revinate integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Initial and historical replication jobs
After you finish setting up Revinate, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Revinate replication
Extraction overview
When Stitch runs a replication job for Revinate, a few things will happen:
- First, Stitch will get all the hotels that the authenticating user has access to.
- Stitch will replicate review snapshot data (
hotel_reviews_snapshot,hotel_reviews_snapshot_by_site,hotel_reviews_snapshot_by_time) for the hotel. - Stitch will replicate data about the hotel (
hotels). - Stitch will repeat steps 2-3 until review snapshot and hotel data has been replicated for all accessible hotels.
- Stitch will replicate review data (
reviews) based on the last savedupdated_atvalue, which is the table’s Replication Key.
Replicating review snapshots
When Stitch extracts review snapshot data, it will do so using an Attribution Window of 1 week. This means that during each replication job, Stitch will replicate snapshot data for that last completed week. For example: If the integration is scheduled to run every 30 minutes, then snapshot data for the last week will be replicated every 30 minutes.
This is applicable to the hotel_reviews_snapshot, hotel_reviews_snapshot_by_site, and hotel_reviews_snapshot_by_time tables.
Revinate table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Revinate integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
hotels
| Replication Method : |
Full Table |
Primary Key  :
|
hotel_id |
| API endpoint : | |||
The hotels table contains info about the hotels in your Revinate account.
Note: Stitch will only replicate data for the hotels that the user whose API key is used to authenticate the integration has access to. If you’re missing records, verify that the authenticating user has access to those hotels in Revinate.
|
hotel_id
The hotel ID. Reference: |
|
hotel_url
The hotel URL. |
|
hotel_reviews_snapshot_url
The review snapshot URL associated with the hotel. |
|
hotel_json
|
|
name
The name of the hotel. |
|
slug
|
|
logo
The logo associated with the hotel. |
|
url
The hotel URL. |
|
address1
The first line of the hotel’s address. |
|
address2
The second line of the hotel’s address. |
|
city
The city the hotel is in. |
|
state
The state the hotel is in. |
|
postal_code
The postal code for the hotel. |
|
country
The country the hotel is in. |
|
trip_advisor_id
The trip advisor ID associated with the hotel. |
|
revinate_purchase_uri
|
|
revinate_login_uri
|
|
account_type
|
|
links_json
|
hotel_reviews_snapshot
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
snapshot_start_date |
|
Primary Key :
|
hotel_id : snapshot_start_date |
API endpoint : |
The hotel_reviews_snapshot table contains snapshot summary stats of reviews for the last completed week, segmented by hotel.
Note: Stitch will only replicate review snapshot data for the hotels that the user whose API key is used to authenticate the integration has access to. If you’re missing records, verify that the authenticating user has access to those hotels in Revinate.
Replication
During each replication job, snapshot data for the last completed week will be replicated. This means that if the integration is scheduled to run every 30 minutes, then snapshot data for the last week will be replicated every 30 minutes.
|
hotel_id
The hotel ID. Reference: |
|
snapshot_start_date
The snapshot start date as a Unix timestamp. |
|
aggregate_average_rating
|
|
aggregate_new_reviews
|
|
aggregate_pos_reviews_pct
|
|
aggregate_trip_advisor_market_ranking
|
|
aggregate_trip_advisor_marke_ranking_pctl
|
|
aggregate_trip_advisor_market_size
|
|
aggregate_values_json
|
|
hotel_reviews_snapshot_json
|
|
hotel_reviews_snapshot_url
|
|
links_json
|
|
snapshot_end_date
The snapshot end date as a Unix timestamp. |
|
values_by_review_site_json
|
|
values_by_time_json
|
hotel_reviews_snapshot_by_site
| Replication Method : |
Key-based Incremental |
Replication Key :
|
snapshot_start_date |
|
Primary Key :
|
hotel_id : review_site_id : snapshot_start_date |
API endpoint : |
The hotel_reviews_snapshot_by_site table contains snapshot summary stats of reviews for the last completed week, segmented by hotel and review site.
Note: Stitch will only replicate review snapshot data for the hotels that the user whose API key is used to authenticate the integration has access to. If you’re missing records, verify that the authenticating user has access to those hotels in Revinate.
Replication
During each replication job, snapshot data for the last completed week will be replicated. This means that if the integration is scheduled to run every 30 minutes, then snapshot data for the last week will be replicated every 30 minutes.
|
hotel_id
The hotel ID. Reference: |
|
review_site_id
The review site ID. Reference: |
|
snapshot_start_date
The snapshot start date. |
|
hotel_reviews_snapshot_url
|
|
review_site_json
|
|
review_site_main_url
The main URL of the review site. |
|
review_site_name
The review site name. |
|
review_site_url
The review site URL. |
|
review_site_slug
|
|
site_average_rating
|
|
site_json
|
|
site_new_reviews
|
|
site_pos_reviews_pct
|
|
site_trip_advisor_market_ranking
|
|
site_trip_advisor_market_ranking_pctl
|
|
site_trip_advisor_market_size
|
|
snapshot_end_date
The snapshot end date as a Unix timestamp. |
hotel_reviews_snapshot_by_time
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
hotel_id : unix_time |
API endpoint : |
The hotel_reviews_snapshot_by_time table contains snapshot summary stats of reviews for the last completed week, segmented by hotel and time.
Note: Stitch will only replicate review snapshot data for the hotels that the user whose API key is used to authenticate the integration has access to. If you’re missing records, verify that the authenticating user has access to those hotels in Revinate.
Replication
During each replication job, snapshot data for the last completed week will be replicated. This means that if the integration is scheduled to run every 30 minutes, then snapshot data for the last week will be replicated every 30 minutes.
|
hotel_id
The hotel ID. Reference: |
|
unix_time
|
|
hotel_reviews_snapshot_url
|
|
snapshot_average_rating
|
|
snapshot_new_reviews
|
|
snapshot_pos_reviews_pct
|
|
snapshot_trip_advisor_market_ranking
|
|
snapshot_trip_advisor_market_ranking_pctl
|
|
snapshot_trip_advisor_market_size
|
|
time_period_json
|
reviews
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updated_at |
|
Primary Key :
|
review_id |
API endpoint : |
The table_name table contains a subset of the latest reviews for the hotels in your Revinate account.
Note: Stitch will only replicate review data for the hotels that the user whose API key is used to authenticate the integration has access to. If you’re missing records, verify that the authenticating user has access to those hotels in Revinate.
|
review_id
The review ID. |
|
updated_at
The time the review was last updated. |
|
author
The review author. |
|
author_location
The review author’s location. |
|
body
The body of the review. |
|
crawled_url
|
|
date_collected
The date the review was collected. |
|
date_review
The date of the review. |
|
guest_stay_json
|
|
hotel_id
The hotel ID. Reference: |
|
hotel_url
|
|
language_english_name
|
|
language_id
|
|
language_json
|
|
language_name
|
|
language_slug
|
|
language_url
|
|
links_json
|
|
nps
|
|
rating
The rating. |
|
response_json
|
|
review_json
|
|
review_site_id
Reference: |
|
review_site_json
|
|
review_site_main_url
|
|
review_site_name
The name of the review site the review is on. |
|
review_site_url
|
|
review_site_slug
|
|
review_url
|
|
subratings_json
|
|
subratings_cleanliness
The cleanliness subrating associated with the review. |
|
subratings_hotel_condition
The hotel condition subrating associated with the review. |
|
subratings_rooms
The room subrating associated with the review. |
|
subratings_service
The service subrating associated with the review. |
|
survey_topics_json
|
|
title
The title of the review. |
|
trip_type
The trip type included in the review. |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.