Skip to content
No description, website, or topics provided.
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tap_frontapp
.gitignore
CHANGELOG.md
LICENSE
MANIFEST.in
README.md
example.config.json
setup.cfg
setup.py

README.md

tap-frontapp

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

This tap:

  • Pulls raw data from FrontApp's API
  • Extracts the following resources from FrontApp
    • Analytics
      • Hourly/Daily analytics of metrics
        • team_table
  • Outputs the schema for each resource

Setup

Building follows the conventional Singer setup:

python3 ./setup.py clean python3 ./setup.py build python3 ./setup.py install

Configuration

This tap requires a config.json which specifies details regarding API authentication, a cutoff date for syncing historical data, and a time period range [daily,hourly] to control what incremental extract date ranges are. See config.sample.json for an example.

Create the catalog:

› tap-frontapp --config config.json --discover > catalog.json

Then to run the extract:

› tap-frontapp --config config.json --catalog catalog.json --state state.json 

Note that a typical state file looks like this:

{"bookmarks": {"team_table": {"date_to_resume": "2018-08-01 00:00:00"}}}

Replication

With each run of the integration, the following data set is extracted and replicated to the data warehouse:

  • Team Table: Daily or hourly aggregated team member statistics since the last_update (last completed run of the integration) through the most recent day or hour respectively. On the first run, ALL increments since the Start Date will be replicated.

Troubleshooting / Other Important Info

  • Team_table Data: The first record is for the teammate = "ALL" and so is an aggregated record across all team members. Also, the API supports pulling specific teams by using a slightly different endpoint, but we have set it up to pull members from all teams.

  • Timestamps: All timestamp columns and resume_date state parameter are Unix timestamps.

Copyright © 2018 Stitch

You can’t perform that action at this time.