README.md

tap-uservoice

Author: Connor McArthur ([email protected])

This is a Singer tap that produces JSON-formatted data following the Singer spec.

It:

• Generates a catalog of available data in Uservoice
• Extracts the following resources:
  • Categories
  • Comments
  • External Accounts
  • External Users
  • Feature Statuses
  • Features
  • Forums
  • Labels
  • NPS Ratings
  • Product Areas
  • Requests
  • Segmented Values
  • Segments
  • Status Updates
  • Statuses
  • Suggestions
  • Supporters
  • Teams
  • Users

Quick Start

1. Install

git clone [email protected]:fishtown-analytics/tap-uservoice.git
cd tap-uservoice
pip install .

2. Get credentials from Uservoice. You'll need your:

• Uservoice subdomain,
• and a client ID and secret. See Uservoice's instructions on how to generate these.

3. Create the config file.

There is a template you can use at config.json.example, just copy it to config.json in the repo root and insert your client ID and secret.

4. Run the application to generate a catalog.

tap-uservoice -c config.json --discover > catalog.json

5. Select the tables you'd like to replicate

Step 4 created a file called catalog.json that specifies all the available endpoints and fields. You'll need to open the file and select the ones you'd like to replicate. See the Singer guide on Catalog Format for more information on how tables are selected.

6. Run it!

tap-uservoice -c config.json --properties catalog.json

---

Copyright © 2018 Fishtown Analytics