This is a Singer tap that produces JSON-formatted data following the Singer spec.
This tap:
- Pulls raw data from the UJET API
- Extracts the following resources:
- Agents
- Agent Activity Logs
- Calls
- Chats
- Menus
- Menu Tree
- Teams
- Team Tree
- User Statuses
- Outputs the schema for each resource
- Incrementally pulls data based on the input state
agents
- Endpoint: https://{subdomain}.ujet.co/manager/api/v1/agents
- Primary key fields: id
- Foreign key fields: teams > id
- Replication strategy: INCREMENTAL (query filtered)
- Bookmark: status_updated_at
- Bookmark query field: status_updated_at[from]
- Transformations: none
agent_activity_logs
- Endpoint: https://{subdomain}.ujet.co/manager/api/v1/agent_activity_logs
- Primary key fields: id
- Foreign key fields: teams > id
- Replication strategy: INCREMENTAL (query filtered)
- Bookmark: status_updated_at
- Bookmark query field: status_updated_at[from]
- Transformations: none
ADD OTHER ENDPOINTS
-
Install
Clone this repository, and then install using setup.py. We recommend using a virtualenv:
> virtualenv -p python3 venv > source venv/bin/activate > python setup.py install OR > cd .../tap-ujet > pip install .
-
Dependent libraries The following dependent libraries were installed.
> pip install singer-python > pip install singer-tools > pip install target-stitch > pip install target-json
-
Create your tap's
config.json
file. Theserver_subdomain
is everything before.ujet.com.
in the ujet URL. Theaccount_name
is everything between.ujet.com.
andapi
in the ujet URL. Thedate_window_size
is the integer number of days (between the from and to dates) for date-windowing through the date-filtered endpoints (default = 60).{ "company_key": "YOUR_COMPANY_KEY", "company_secret": "YOUR_COMPANY_SECRET_CODE", "subdomain": "YOUR_COMPANY", "domain": "ujet", "start_date": "2019-01-01T00:00:00Z", "user_agent": "tap-ujet <api_user_email@your_company.com>", "date_window_size": "14" }
Optionally, also create a
state.json
file.currently_syncing
is an optional attribute used for identifying the last object to be synced in case the job is interrupted mid-stream. The next run would begin where the last job left off.{ "currently_syncing": "calls", "bookmarks": { "agnets": "2019-09-27T22:34:39.000000Z", "agent_activity_logs": "2019-09-28T15:30:26.000000Z", "calls": "2019-09-28T18:23:53Z", "chats": "2019-09-27T22:40:30.000000Z" } }
-
Run the Tap in Discovery Mode This creates a catalog.json for selecting objects/fields to integrate:
tap-ujet --config config.json --discover > catalog.json
See the Singer docs on discovery mode here.
-
Run the Tap in Sync Mode (with catalog) and write out to state file
For Sync mode:
> tap-ujet --config tap_config.json --catalog catalog.json > state.json > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json
To load to json files to verify outputs:
> tap-ujet --config tap_config.json --catalog catalog.json | target-json > state.json > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json
To pseudo-load to Stitch Import API with dry run:
> tap-ujet --config tap_config.json --catalog catalog.json | target-stitch --config target_config.json --dry-run > state.json > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json
-
Test the Tap
While code/bytecode/Stitchoping the ujet tap, the following utilities were run in accordance with Singer.io best practices: Pylint to improve code quality:
> pylint tap_ujet -d missing-docstring -d logging-format-interpolation -d too-many-locals -d too-many-arguments
Pylint test resulted in the following score:
TBD LATER Your code has been rated at TBD/10
To check the tap and verify working:
> tap-ujet --config tap_config.json --catalog catalog.json | singer-check-tap > state.json > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json
Check tap resulted in the following:
TBD LATER The output is valid. It contained 127 messages for 10 streams. 10 schema messages 92 record messages 25 state messages Details by stream: +---------------------+---------+---------+ | stream | records | schemas | +---------------------+---------+---------+ | TBD | 99 | 1 | +---------------------+---------+---------+
Copyright © 2019 Stitch