|
| 1 | +--- |
| 2 | +title: RateHighly Source |
| 3 | +id: P1kUrzj9pv |
| 4 | +beta: true |
| 5 | +hidden: true |
| 6 | +--- |
| 7 | + |
| 8 | +[RateHighly](https://ratehighly.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} gets your most engaged users to review your application on G2 and Capterra, leveraging machine learning to predict user sentiment and request reviews. |
| 9 | + |
| 10 | +This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. |
| 11 | + |
| 12 | +This source is maintained by RateHighly. For any issues with the source, [contact their Support team ](mailto:[email protected]). |
| 13 | + |
| 14 | +## Getting started |
| 15 | + |
| 16 | +1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**. |
| 17 | +2. Search for "RateHighly" in the Sources Catalog, select RateHighly, and click **Add Source**. |
| 18 | +3. On the next screen, give the Source a name configure any other settings. |
| 19 | + |
| 20 | + - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself (eg. RateHighly). |
| 21 | + |
| 22 | +4. Click **Add Source** to save your settings. |
| 23 | +5. Copy the Write key from the Segment UI. |
| 24 | +6. Log in to your RateHighly account - navigate to [Account > Integrations](https://ratehighly.com/dashboard/account/integrations) > Segment and paste the key to connect. |
| 25 | + |
| 26 | +## Stream |
| 27 | + |
| 28 | +RateHighly uses our stream Source component to send Segment event data. It uses server-side `track` and `identify` methods to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. |
| 29 | + |
| 30 | +RateHighly will pass the provided user_id as the Segment userId, in addition to context and user details. |
| 31 | + |
| 32 | +## Events |
| 33 | + |
| 34 | +The table below lists events that RateHighly sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. RateHighly includes the customer-provided `userId` with all events. The `userId` is user-provided string used when sending any event to RateHighly. |
| 35 | + |
| 36 | +| Event Name | Description | |
| 37 | +| ------------------ | -------------------------------------- | |
| 38 | +| User Created | User was detected by RateHighly | |
| 39 | +| Deemed Happy | User is qualified to review your app | |
| 40 | +| Messaged In-App | User was asked to review in-app | |
| 41 | +| Gave Rating | User gave a score in-app | |
| 42 | +| Skipped Rating | User closed the modal without scoring | |
| 43 | +| Gave Review | User shared a review on G2 or Capterra | |
| 44 | +| Gave Feedback | User wrote internal feedback | |
| 45 | +| Sent Email | User received a review request email | |
| 46 | +| Unsubscribed | User clicked an unsubscribe link | |
| 47 | +| Review Completed | User completed the review sequence | |
| 48 | + |
| 49 | +## Event properties |
| 50 | + |
| 51 | +The table below list the properties included in the events listed above. |
| 52 | + |
| 53 | +| Property Name | Description | |
| 54 | +| ----------------- | ------------------------- | |
| 55 | +| `event` | Event type | |
| 56 | +| `userId` | User ID | |
| 57 | +| `email` | User email | |
| 58 | +| `score` | User rating | |
| 59 | +| `predicted_score` | User predicted score | |
| 60 | + |
| 61 | +## Adding destinations |
| 62 | + |
| 63 | +Now that your Source is set up, you can connect it with Destinations. |
| 64 | + |
| 65 | +Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. |
| 66 | + |
| 67 | +If there are any issues with how the events are arriving to Segment, [contact the RateHighly support team ](mailto:[email protected]). |
0 commit comments