https://github.com/ota-insight/singer-satismeter
Singer Tap for Satismeter responses
https://github.com/ota-insight/singer-satismeter
singer singer-tap
Last synced: 10 days ago
JSON representation
Singer Tap for Satismeter responses
- Host: GitHub
- URL: https://github.com/ota-insight/singer-satismeter
- Owner: OTA-Insight
- License: agpl-3.0
- Created: 2019-08-13T07:41:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-26T08:42:20.000Z (almost 5 years ago)
- Last Synced: 2025-02-16T13:47:00.396Z (2 months ago)
- Topics: singer, singer-tap
- Language: Python
- Size: 43.9 KB
- Stars: 0
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-satismeter
This is a singer tap to query the Satismeter REST api. Exports the responses and response statistics.
## Connecting tap-satismeter
### Setup
You need your Satismeter `Project ID` and need to create an `API key` (also called Read key). This is described on the Satismeter docs for the [Export responses api](https://help.satismeter.com/en/articles/87961-export-responses-api)
---
## tap-satismeter Replication
The tap will query the Satismeter REST api to obtain all of the user responses, and the per-month statistics for your project.
For _responses_, the number of rows replicated equals the number of responses. The datasource is append-only style, the tap will keep track of the last replicated response to only replicate new responses (and it will only request responses later than that moment from the Satismeter api).
For _response statistics_, the number of rows replicated equals the number of months. The tap will keep track of which month it has requested, and will continue from then on (it will always requery for the current month).
There are no rate limits enforced on the side of Satismeter api, but the tap has a rate limit of requests to Satismeter of 1 per 5 seconds, and each request has a 30 seconds timeout.
---
## tap-satismeter Table Schemas
1. Responses
- Table name: responses
- Description: all of the user responses
- Primary key column(s): id
- Replicated fully or incrementally _(uses a bookmark to maintain state)_: incrementally, based on the `created` field
- Bookmark column(s): _(if replicated incrementally)_ : created
- Link to API endpoint documentation: [Satismeter Export Responses API](https://help.satismeter.com/en/articles/87961-export-responses-api)
---
## Instructions to run from source
Add the project id and api key for Satismeter in `tap_satismeter/config.json`.
Install the tap and its dependancies:
```bash
pip install -e .
```
```bash
cd tap_satismeter
```
Generate a catalog file which describes the included object stream schemas:
```bash
python __init__.py -c ../config.json --discover > catalog.json
```
Run the tap:
```bash
python __init__.py -c ../config.json --catalog catalog.json > output.json
```
## Use with pipelinewise
This tap is compatible to run with pipelinewise. Use this configuration yaml for it:
```yml
---
id: "satismeter"
name: "Satismeter"
type: "tap-satismeter"
owner: "[email protected]"
db_conn:
project_id: "{PROJECT_ID}"
api_key: "{API_KEY}"
start_date: "{START_DATE}"
user_agent: "{USER_AGENT}"
target: ""
batch_size_rows: 1000
default_target_schema: ""
schemas:
- source_schema: "satismeter"
target_schema: ""
tables:
- table_name: "responses"
```