tap-miro - Meltano Hub

Miro

tap-miro (slalom-consulting variant)🥈

Visual collaboration platform

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

Getting Started

Prerequisites

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

Installation and configuration

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

meltano add extractor tap-miro

Configure the tap-miro settings using

meltano config

:

meltano config tap-miro set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-miro 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-miro 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:

about
catalog
discover
schema-flattening
state
stream-maps

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

Settings

The tap-miro 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:

access_token
api_url
limit
organization_id
stream_config
user_agent

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

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

Access Token (access_token)

Environment variable: TAP_MIRO_ACCESS_TOKEN

Access token for API.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set access_token [value]

API URL (api_url)

Environment variable: TAP_MIRO_API_URL

Override the url for the API service.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set api_url [value]

Limit (limit)

Environment variable: TAP_MIRO_LIMIT
Default Value: 100

The response limit for paginated API streams. (range: 0-100)

Configure this setting directly using the following Meltano command:

meltano config tap-miro set limit [value]

Organization ID (organization_id)

Environment variable: TAP_MIRO_ORGANIZATION_ID

The ID of an Organization.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set organization_id [value]

Stream Config (stream_config)

Environment variable: TAP_MIRO_STREAM_CONFIG

[No description provided.]

Configure this setting directly using the following Meltano command:

meltano config tap-miro set stream_config [value]

User Agent (user_agent)

Environment variable: TAP_MIRO_USER_AGENT

The User agent to present to the API.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set user_agent [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_MIRO_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_MIRO_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_MIRO_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_MIRO_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-miro set stream_maps [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-miro 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-miro

Maintenance Status

Repo

https://github.com/Slalom-Consulting/tap-miro

Maintainer

Keywords