ContextQMD
Back to Airbyte

Yotpo

docs/integrations/sources/yotpo.md

2.0.07.7 KB
Original Source

Yotpo

This page contains the setup guide and reference information for the Yotpo source connector.

Prerequisites

To set up the Yotpo source connector, you need:

  1. A Yotpo account with API access
  2. Your Yotpo App Key (found in your Yotpo account settings)
  3. An Access Token generated from the Yotpo API

Setup guide

Step 1: Generate an Access Token

  1. You need your App Key and API Secret to generate an access token
  2. Find your App Key and API Secret in your Yotpo account settings
  3. Generate an access token using the Yotpo authentication endpoint: 
    POST https://api.yotpo.com/oauth/token
    with the following parameters:
    json
    {
  "client_id": "YOUR_APP_KEY",
  "client_secret": "YOUR_API_SECRET",
  "grant_type": "client_credentials"
}
  4. Store the returned access token securely as it will be used for all API calls

Step 2: Set up the Yotpo connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account
  2. In the left navigation bar, click Sources. In the top-right corner, click New Source
  3. On the Set up the source page, enter the name for the Yotpo connector and select Yotpo from the Source type dropdown
  4. Enter the following required parameters:
    • access_token: The access token generated in Step 1
    • app_key: Your Yotpo App Key
    • start_date: The date from which you want to start syncing data (format: YYYY-MM-DDT00:00:00.000Z)
    • email: Your registered email address with Yotpo
  5. Click Set up source

For Airbyte OSS:

  1. Navigate to the Airbyte Open Source dashboard
  2. Set the name for your source
  3. Enter the required parameters as described above
  4. Click Set up source

Supported sync modes

The Yotpo source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncYes
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

Supported Streams

Stream NameDescriptionIncrementalNotes
email_analyticsRetrieves aggregated data for email metricsNoData is grouped by metrics and can be filtered by date range
raw_dataReturns detailed data about every email sent from YotpoNoIncludes email recipient, delivery status, open/click events
reviewsRetrieves product reviewsYesUses created_at as cursor field with a lookback window of 31 days
unsubscribersLists users who have unsubscribed from emailsNoLimited to 5000 responses per request, requires pagination for larger datasets
webhooksLists all webhooks created for the accountNoIncludes webhook URL and event type information
webhook_eventsLists available webhook event typesNoIncludes event names and descriptions

Performance considerations

Rate Limits

  • The Reviews endpoint is limited to 5,000 requests per minute per app key
  • For Reviews, it's recommended to query up to 100 reviews per request (default is 10)
  • Review data is retrieved with a delay of 1 hour

Pagination

  • For the Reviews stream, pagination is handled automatically using page and count parameters
  • For the Unsubscribers stream, if your list exceeds 5000 email addresses, you must use the count and page parameters for pagination

API method example

GET https://api.yotpo.com/v1/apps/{app_key}/reviews?utoken={access_token}

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
0.2.162025-10-2168442Update dependencies
0.2.152025-10-1468011Update dependencies
0.2.142025-10-0767250Update dependencies
0.2.132025-09-3066843Update dependencies
0.2.122025-09-2466469Update dependencies
0.2.112025-09-0965710Update dependencies
0.2.102025-08-2465429Update dependencies
0.2.92025-08-1064819Update dependencies
0.2.82025-08-0264357Update dependencies
0.2.72025-07-2664066Update dependencies
0.2.62025-07-1963622Update dependencies
0.2.52025-07-1263210Update dependencies
0.2.42025-07-0562684Update dependencies
0.2.32025-06-2862250Update dependencies
0.2.22025-06-2161748Update dependencies
0.2.12025-06-1547597Update dependencies
0.2.02024-08-2644780Refactor connector to manifest-only format
0.1.142024-08-2444661Update dependencies
0.1.132024-08-1744254Update dependencies
0.1.122024-08-1243891Update dependencies
0.1.112024-08-1043658Update dependencies
0.1.102024-08-0343198Update dependencies
0.1.92024-07-2742610Update dependencies
0.1.82024-07-2042275Update dependencies
0.1.72024-07-1341815Update dependencies
0.1.62024-07-1041444Update dependencies
0.1.52024-07-0941250Update dependencies
0.1.42024-07-0640795Update dependencies
0.1.32024-06-2540488Update dependencies
0.1.22024-06-2139945Update dependencies
0.1.12024-05-2038390[autopull] base image + poetry + up_to_date
0.1.02023-04-14InitInitial commit
</details>