> For the complete documentation index, see [llms.txt](https://docs.erathos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.erathos.com/connectors/apis/reviews-io.md).

# Reviews.io

Connect your Reviews.io account to your data warehouse. Sync reviews, invitations, product ratings, surveys, UGC, and webhooks to BigQuery, Redshift, PostgreSQL, Databricks, and more.

## Using the Erathos platform

When selecting Reviews.io as a new connector on the Erathos platform, you will need to name your connection and fill in the following form:

* **Store** — your Reviews.io store identifier, used to select which store the data is pulled from
* **API key** — your Reviews.io API key, used to authenticate all requests to the API

With this connection created you can seamlessly move your Reviews.io data to your BigQuery, Redshift or PostgreSQL data warehouse.

### How to find my token?

Log in to your Reviews.io dashboard and go to **Settings → API Keys** (under the Integrations section). Here you will find the API key associated with your store — copy it if you already have one, or generate a new key by clicking the option to create an API key.

Note the **store** name/identifier as configured in your Reviews.io account, since both the store and the API key are required to authenticate requests.

Paste the store identifier into the **Store** field and the key into the **API key** field on the Erathos platform, then click **Save and close** to complete the setup.

## Endpoints and fields

### company\_invitations

Sync type availability: Full-refresh

| Field           | Type      |
| --------------- | --------- |
| id              | text      |
| order\_id       | text      |
| customer\_name  | text      |
| customer\_email | text      |
| email\_sent     | text      |
| status          | text      |
| date\_send      | timestamp |
| resent          | integer   |

### product\_invitations

Sync type availability: Full-refresh

| Field           | Type      |
| --------------- | --------- |
| id              | text      |
| order\_id       | text      |
| customer\_name  | text      |
| customer\_email | text      |
| email\_sent     | text      |
| status          | text      |
| date\_send      | timestamp |
| resent          | integer   |
| product         | json      |

### product\_ratings

Sync type availability: Full-refresh

| Field           | Type  |
| --------------- | ----- |
| sku             | text  |
| average\_rating | text  |
| num\_ratings    | float |

### review\_nuggets

Sync type availability: Full-refresh

| Field                 | Type      |
| --------------------- | --------- |
| id                    | integer   |
| type                  | text      |
| text                  | text      |
| rating                | text      |
| review\_id            | text      |
| date\_created\_nugget | timestamp |

### reviews

Sync type availability: Full-refresh

| Field               | Type    |
| ------------------- | ------- |
| id                  | text    |
| type                | text    |
| type\_label         | text    |
| source              | text    |
| rating              | integer |
| title               | text    |
| comments            | text    |
| author              | json    |
| date\_created       | text    |
| time\_ago           | text    |
| order\_id           | text    |
| sku                 | text    |
| helpful\_count      | text    |
| attributes          | json    |
| photos              | json    |
| unpublished\_photos | json    |
| videos              | json    |
| tags                | json    |
| replies             | json    |

### survey\_responses

Sync type availability: Full-refresh

Child of [surveys](#surveys)

| Field            | Type      |
| ---------------- | --------- |
| id               | integer   |
| user\_id         | integer   |
| completion\_time | integer   |
| href             | text      |
| browser          | text      |
| ip\_address      | text      |
| date\_created    | timestamp |
| date\_updated    | timestamp |
| country\_code    | text      |
| total\_price     | text      |
| order\_count     | integer   |
| tags             | text      |
| responses        | json      |

### surveys

Sync type availability: Full-refresh

Parent of [survey\_responses](#survey_responses)

| Field            | Type      |
| ---------------- | --------- |
| id               | integer   |
| title            | text      |
| question\_count  | integer   |
| responses\_count | integer   |
| active           | integer   |
| date\_created    | timestamp |
| date\_updated    | timestamp |

### ugc

Sync type availability: Full-refresh

| Field            | Type    |
| ---------------- | ------- |
| type             | text    |
| type\_label      | text    |
| source           | text    |
| rating           | integer |
| comments         | text    |
| author           | text    |
| date\_created    | text    |
| order\_id        | text    |
| sku              | text    |
| helpful\_count   | text    |
| is\_video        | integer |
| image\_raw       | text    |
| image\_sm        | text    |
| image\_md        | text    |
| image\_lg        | text    |
| attributes       | json    |
| tagged\_products | json    |
| replies          | json    |

### unsubscribed\_users

Sync type availability: Full-refresh

| Field | Type |
| ----- | ---- |
| email | text |

### webhooks

Sync type availability: Full-refresh

| Field | Type |
| ----- | ---- |
| id    | text |
| type  | text |
| url   | text |

## Entity Relationships

```mermaid
erDiagram
    surveys ||--o{ survey_responses : "id = _pk_surveys"
    reviews ||--o{ review_nuggets : "id = review_id"

    company_invitations {
        text id PK
    }
    product_invitations {
        text id PK
    }
    product_ratings {
        text sku PK
    }
    review_nuggets {
        integer id PK
    }
    reviews {
        text id PK
    }
    survey_responses {
        text _pk_surveys PK
        integer id PK
    }
    surveys {
        integer id PK
    }
    unsubscribed_users {
        text email PK
    }
    webhooks {
        text id PK
    }
```