Adjust

tap-adjust (airbyte variant)🥈

Marketing analytics platform

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

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

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-adjust extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-adjust
  2. Configure the tap-adjust settings using 
    meltano config
     : 
    3. meltano config tap-adjust set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-adjust test

Next steps

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

Capabilities

The current capabilities for tap-adjust 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-adjust 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 also list these settings using 

meltano config
with the list subcommand: 

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

Airbyte Config Additional Metrics (airbyte_config.additional_metrics)

  • Environment variable: TAP_ADJUST_AIRBYTE_CONFIG_ADDITIONAL_METRICS

Metrics names that are not pre-defined, such as cohort metrics or app specific metrics.


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_config additional_metrics [value]

Airbyte Config Api Token (airbyte_config.api_token)

  • Environment variable: TAP_ADJUST_AIRBYTE_CONFIG_API_TOKEN

Adjust API key, see https://help.adjust.com/en/article/report-service-api-authentication


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_config api_token [value]

Airbyte Config Dimensions (airbyte_config.dimensions)

  • Environment variable: TAP_ADJUST_AIRBYTE_CONFIG_DIMENSIONS

Dimensions allow a user to break down metrics into groups using one or several parameters. For example, the number of installs by date, country and network. See https://help.adjust.com/en/article/reports-endpoint#dimensions for more information about the dimensions.


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_config dimensions [value]

Airbyte Config Ingest Start (airbyte_config.ingest_start)

  • Environment variable: TAP_ADJUST_AIRBYTE_CONFIG_INGEST_START

Data ingest start date.


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_config ingest_start [value]

Airbyte Config Metrics (airbyte_config.metrics)

  • Environment variable: TAP_ADJUST_AIRBYTE_CONFIG_METRICS

Select at least one metric to query.


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_config metrics [value]

Airbyte Config Until Today (airbyte_config.until_today)

  • Environment variable: TAP_ADJUST_AIRBYTE_CONFIG_UNTIL_TODAY

Syncs data up until today. Useful when running daily incremental syncs, and duplicates are not desired.


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_config until_today [value]

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_ADJUST_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-adjust

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_ADJUST_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_ADJUST_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set docker_mounts [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_ADJUST_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_ADJUST_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-adjust set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_ADJUST_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-adjust set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_ADJUST_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-adjust 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-adjust extractor to work, read the Airbyte connector FAQ, look for an existing issue in the Airbyte 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-adjust

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-adjust
  • License

Maintainer

  • Airbyte

Keywords

  • airbyte_protocolmeltano_sdk