Toggl

tap-toggl from singer-io

Time Tracking Software

The tap-toggl extractor pulls data from Toggl that can then be sent to a destination using a loader.

Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-toggl extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-toggl
  3. Configure the tap-toggl settings using
    meltano config
    :
  4. meltano config tap-toggl set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-toggl test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-toggl may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-toggl settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Token (api_token)

  • Environment variable: TAP_TOGGL_API_TOKEN

The Toggl API token.

Detailed Report Trailing Days (detailed_report_trailing_days)

  • Environment variable: TAP_TOGGL_DETAILED_REPORT_TRAILING_DAYS

Determines the window of how many trailing days to pull the time_entries resource.

Start Date (start_date)

  • Environment variable: TAP_TOGGL_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

User Agent (user_agent)

  • Environment variable: TAP_TOGGL_USER_AGENT

The User Agent for your Toggl API requests.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-toggl extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-toggl

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api