# Marketo
The tap-marketo
extractor pulls data from the Marketo API.
- Repository: https://gitlab.com/meltano/tap-marketo
- Maintainer: Meltano community
- Maintenance status: Active
# Getting Started
# Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
# Installation and configuration
# Using the Command Line Interface
Add the
tap-marketo
extractor to your project usingmeltano add
:meltano add extractor tap-marketo
Configure the settings below using
meltano config
.
# Using Meltano UI
Start Meltano UI using
meltano ui
:meltano ui
Open the Extractors interface at http://localhost:5000/extractors.
Click the "Add to project" button for "Marketo".
Configure the settings below in the "Configuration" interface that opens automatically.
# Next steps
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.
# Settings
tap-marketo
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 in the sidebar.
# Minimal configuration
A minimal configuration of tap-marketo
in your meltano.yml
project file will look like this:
plugins:
extractors:
- name: tap-marketo
variant: meltano
config:
endpoint: https://284-RPR-133.mktorest.com/rest
identity: https://284-RPR-133.mktorest.com/identity
client_id: 70ee92a1-603f-44a8-97a3-e0e55d758d1b
start_date: '2020-10-01T00:00:00Z'
Sensitive values are most appropriately stored in the environment or your project's .env
file:
export TAP_MARKETO_CLIENT_SECRET=my_secret
# Endpoint
- Name:
endpoint
- Environment variable:
TAP_MARKETO_ENDPOINT
Endpoint URL
See https://developers.marketo.com/rest-api/base-url/.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-marketo set endpoint <endpoint_url>
export TAP_MARKETO_ENDPOINT=<endpoint_url>
# Identity
- Name:
identity
- Environment variable:
TAP_MARKETO_IDENTITY
Identity URL
See https://developers.marketo.com/rest-api/base-url/.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-marketo set identity <identity_url>
export TAP_MARKETO_IDENTITY=<identity_url>
# Client ID
- Name:
client_id
- Environment variable:
TAP_MARKETO_CLIENT_ID
See https://developers.marketo.com/rest-api/authentication/.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-marketo set client_id <client_id>
export TAP_MARKETO_CLIENT_ID=<client_id>
# Client Secret
- Name:
client_secret
- Environment variable:
TAP_MARKETO_CLIENT_SECRET
See https://developers.marketo.com/rest-api/authentication/.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-marketo set client_secret <client_secret>
export TAP_MARKETO_CLIENT_SECRET=<client_secret>
# Start Date
- Name:
start_date
- Environment variable:
TAP_MARKETO_START_DATE
This property 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 UI, meltano config
, or an environment variable:
meltano config tap-marketo set start_date YYYY-MM-DDTHH:MM:SSZ
export TAP_MARKETO_START_DATE=YYYY-MM-DDTHH:MM:SSZ
# For example:
meltano config tap-marketo set start_date 2020-10-01T00:00:00Z
export TAP_MARKETO_START_DATE=2020-10-01T00:00:00Z