Yotpo

tap-yotpo (singer-io variant)🥈

eCommerce Marketing Platform

The tap-yotpo extractor pulls data from Yotpo that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-yotpo extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-yotpo
  3. Configure the tap-yotpo settings using
    meltano config
    :
  4. meltano config tap-yotpo set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-yotpo test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-yotpo may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-yotpo settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-yotpo list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Key (api_key)

  • Environment variable: TAP_YOTPO_API_KEY

Your API key. Can be found in your Yotpo settings.


Configure this setting directly using the following Meltano command:

meltano config tap-yotpo set api_key [value]

API Secret (api_secret)

  • Environment variable: TAP_YOTPO_API_SECRET

Your API secret. Can be found in your Yotpo settings.


Configure this setting directly using the following Meltano command:

meltano config tap-yotpo set api_secret [value]

Email Stats Lookback Days (email_stats_lookback_days)

  • Environment variable: TAP_YOTPO_EMAIL_STATS_LOOKBACK_DAYS

Parameter is used to fetch updated email statistics (opens, clicks, etc) for emails sent by Yotpo. Default, 30.


Configure this setting directly using the following Meltano command:

meltano config tap-yotpo set email_stats_lookback_days [value]

Request Timeout (request_timeout)

  • Environment variable: TAP_YOTPO_REQUEST_TIMEOUT

An optional paramater to set timeout for requests. Default: 300 seconds.


Configure this setting directly using the following Meltano command:

meltano config tap-yotpo set request_timeout [value]

Reviews Lookback Days (reviews_lookback_days)

  • Environment variable: TAP_YOTPO_REVIEWS_LOOKBACK_DAYS

Parameter is used to re-fetch reviews that have been updated (or deleted) since the last time they were synced. Default, 30.


Configure this setting directly using the following Meltano command:

meltano config tap-yotpo set reviews_lookback_days [value]

Start Date (start_date)

  • Environment variable: TAP_YOTPO_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.


Configure this setting directly using the following Meltano command:

meltano config tap-yotpo set start_date [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-yotpo extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-yotpo

Maintenance Status

  • Maintenance Status

Repo

https://github.com/singer-io/tap-yotpo
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api