Repository files navigation

This is aSinger tap that produces JSON-formatted datafollowing theSingerspec.

This tap:

• Pulls raw data fromSurveyMonkey

• Extracts the following resources:

  • Surveys
  • Responses
  • Simplified Responses
  • Survey Details

• Outputs the schema for each resource

• Incrementally pulls data based on the input state

To pull all surveys, the configuration parametersaccess_token andstart_date are required.

• To pull all responses or simplified responses or survey_details for a specific survey, the configuration parametersaccess_token,start_date, andsurvey_id are required.
• To pull all data of responses or simplified responses or survey_details, the configuration parametersaccess_token,start_date, andsurvey_id are required.

The parameterpage_size(default: 50, max: 100) is optional to adjust the response-size for faster response times or larger batches thereby and reduced number of API-calls.

Thesurveys andresponses resources will pull data in the form described on the SurveyMonkey API docs.

The Simplified Responses resource will pull a Response schema, with an extra keysimple_text embedded in each of theanswer dictionaries,which is a human-readable form of the survey respondent's response to question. It also contains thefamily,subtype, andheading keys in thequestion object, for easy reference.

1. Install

   Clone this repo

   git clone ...

   We recommend using a virtualenv:

   python3 -m venv ~/.virtualenvs/tap-surveymonkeysource ~/.virtualenvs/tap-surveymonkey/bin/activatepip install -e .

2. Create a SurveyMonkey access token

   Login to your SurveyMonkey account, go toSurveyMonkey app directory, and putstitchdata in the search box to find the Stitchdata app. In there, you can authorize to get an access token.

3. Set up your config file.

   An example config file is provided insample_config.json, the access token and survey in that file are invalid, and will error out. Replace them with your own valid ones.

4. Run the tap in discovery mode to get catalog.json file.

   tap-surveymonkey --config config.json --discover > catalog.json

5. In the generatedcatalog.json file, select the streams to sync.

   Each stream in thecatalog.json file has aschema entry. To select a stream to sync, add"selected": true to that stream'sschema entry. For example, to sync the survey_details stream:

   "tap_stream_id": "survey_details",    "schema": {        "selected": true,        "properties": {            ...        }    }...

6. Run the application

   tap-surveymonkey can be run with:

   tap-surveymonkey --config config.json --catalog catalog.json

7. To run withStitch Import API with dry run:

   tap-surveymonkey --config config.json --catalog catalog.json | target-stitch --config target_config.json --dry-run > state.json

• Endpoint:https://api.surveymonkey.com/v3/surveys
• Primary keys: id
• Replication strategy: INCREMENTAL
  • Bookmark: date_modified (date-time)

• Endpoint:https://api.surveymonkey.com/v3/surveys/[survey_id]/details
• Primary keys: id
• Replication strategy: INCREMENTAL
  • Bookmark: date_modified (date-time)

• Endpoint:https://api.surveymonkey.com/v3/surveys/[survey_id]/responses/bulk
• Primary keys: id
• Replication strategy: INCREMENTAL
  • Bookmark: date_modified (date-time)

• Endpoint:https://api.surveymonkey.com/v3/surveys/[survey_id]/responses/bulk
• Primary keys: id
• Replication strategy: INCREMENTAL
  • Bookmark: date_modified (date-time)

While developing the tap, run pylint to improve better code quality which is recommended bySinger.io best practices.

pylint tap_surveymonkey -d missing-docstring -d logging-format-interpolation -d too-many-locals -d too-many-arguments

To check the tap and verify working, installsinger-tools.

tap-surveymonkey --config tap_config.json --catalog catalog.json | singer-check-tap

Copyright © 2019 Stitch