tap-toggl - Meltano Hub

Toggl

tap-toggl (singer-io variant)🥈

Time Tracking Software

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

Alternate Implementations

Airbyte
🥉
Andy Jiang
Stitch Data (default)🥈

Getting Started

Prerequisites

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

Installation and configuration

Add the tap-toggl extractor to your project using
```
meltano add
```
:

meltano add extractor tap-toggl

Configure the tap-toggl settings using

meltano config

meltano config tap-toggl set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-toggl test

Next steps

Follow the remaining steps of the Getting Started guide:

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:

api_token
detailed_report_trailing_days
start_date
user_agent

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-toggl 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.

Configure this setting directly using the following Meltano command:

meltano config tap-toggl set api_token [value]

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.

Configure this setting directly using the following Meltano command:

meltano config tap-toggl set detailed_report_trailing_days [value]

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.

Configure this setting directly using the following Meltano command:

meltano config tap-toggl set start_date [value]

User Agent (user_agent)

Environment variable: TAP_TOGGL_USER_AGENT

The User Agent for your Toggl API requests.

Configure this setting directly using the following Meltano command:

meltano config tap-toggl set user_agent [value]

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

Repo

Maintainer

Meltano Stats

Keywords