Skip to content

bytecodeio/tap-frontapp

Repository files navigation

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 by using a token, a cutoff date for syncing historical data (date format of YYYY-MM-DDTHH:MI:SSZ), and a time period range [daily,hourly] to control what incremental extract date ranges are. See example.config.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"}}}

Copyright © 2018 Stitch

About

Singer tap for Analytics data from the FrontApp API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages