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

Alternative variants #

Multiple variants of tap-toggl are available. This document describes the default singer-io variant, which is recommended for new users.

Alternative variants are:

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 #

Using the Command Line Interface #

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

    meltano add extractor tap-toggl
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

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

Capabilities #

Settings #

tap-toggl requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

API Token (api_token) #

The Toggl API token.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-toggl set api_token <api_token>

export TAP_TOGGL_API_TOKEN=<api_token>

Detailed Report Trailing Days (detailed_report_trailing_days) #

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

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-toggl set detailed_report_trailing_days 1234

export TAP_TOGGL_DETAILED_REPORT_TRAILING_DAYS=1234

Start Date (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.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-toggl set start_date <start_date>

export TAP_TOGGL_START_DATE=<start_date>

User Agent (user_agent) #

The User Agent for your Toggl API requests.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-toggl set user_agent <user_agent>

export TAP_TOGGL_USER_AGENT=<user_agent>

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.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!