Marketo REST Connector Guide > Marketo Sources and Targets > Marketo Sources
  

Marketo Sources

When you configure a source in a Data Synchronization task or Mapping Configuration task, select the source object to read specific data about that source. Use the source objects to search for leads or lists that contain a group of leads. You can also search for leads in the Marketo database that match a requested activity type for a date and time you specify.
You can use the following source objects in a Data Synchronization task or Mapping Configuration task:
Lead
A lead is a contact who shows interest in the product. Use the lead source object in a task and specify the information that you want to read for leads from Marketo. You can retrieve lead information when you specify the filter type, list ID, or program ID in the advanced source properties of a task.
Activity
An activity is the interaction of a lead with an organization, campaign, or product. The activity object retrieves only the metadata for the type of lead activities but does not provide the lead activity information. For example, an activity results when a lead visits a page on a website, downloads a paper, or attends a conference. You can use Marketo to understand the interests of a lead and timely communicate with the lead. A lead can also have multiple activities for a specific program.
When you choose the activity source object in a task, you retrieve the following lead activity metadata:
"id","name","description","primaryAttribute_name","primaryAttribute_dataType","attributes_name","attributes_dataType"
For example, a retrieved lead activity includes the following details:
"1","Visit Webpage","User visits a web page","Webpage ID","integer","Webpage URL","string"
Note: To retrieve lead activities, you must specify the lead source object and the corresponding activity type ID in the advanced source properties of a task.
List
A list is a collection of leads in Marketo. Marketo contains smart and static lists. A static list is a fixed list of leads, while a smart list is a dynamic collection of leads. Marketo Connector supports only static lists.
You can retrieve list details such as ID, name, description, programName, createdAt, and updatedAt. The list object provides data about the list but not the leads that are present in the list. You can specify filters, such as the list ID, the list name, and the program name to retrieve information for lists associated with a specific program. A marketer uses a program to organize all marketing efforts. If you do not specify a filter, the REST API returns all the lists.
For example, the following table shows a retrieved list:
id
name
description
programName
createdAt
updatedAt
workspaceName
1113
SalesForceList
2013 Liz
-
2013-12-05T18:47:40Z
2015-03-09T19:46:34Z
North America
1114
ZuoraList
2013 MH
moni's list upload
2013-12-05T18:47:42Z
2013-12-05T18:49:06Z
North America
Campaign
Campaigns serve a specific goal within a program that contains all the marketing efforts organised from one central location. For example, a program is an email blast, which can record when a lead is sent an email, when the lead opened the email, and whether the lead clicked through a link in the email. In a campaign, you can choose a group of leads from a program to whom you can send the email blast, or notify a sales representative to follow up if a lead clicks through a link within the email blast program.
For example, the following table shows the retrieved campaign details for the specified campaign IDs:
id
programName
createdAt
name
description
updatedAt
workspaceName
1037
Sales Insight - Interesting Moments
2013-11-20T18:23:02Z
Contact Me - Corporate - Decentralized and in PRGM
WWW contact me
2013-12-18T00:06:11Z
Default
2093
-
2015-09-15T15:44:33Z
Sample
-
2015-10-13T09:22:17Z
Default
2094
-
2015-09-15T16:24:14Z
InviteCampaign
-
2015-09-15T16:25:46Z
Default
LeadActivity
A LeadActivity is a lead who shows interest in the product and the interaction of the lead with the product.
Use the LeadActivity source object in a task to fetch both the lead changes and lead activities from Marketo in one API call. Specify the since data time value in the advanced properties of a task to capture the lead changes. If you specify the since date time along with the activity type IDs, you can fetch the lead activity details.
Custom Objects
A custom object provides the relationship between the Marketo leads and the custom object records. A custom object consists of fixed attributes, such as the object name, description, Marketo lead link field, linked field name, and one or more object specific fields.
You can use custom objects in a task to retrieve a list of custom object data based on the search criteria you specify. The custom objects in Marketo are available as source objects in a Data Synchronization task or Mapping Configuration task. Specify the custom object filter type, custom object filter values, and custom object fields in the advanced properties of a task to capture data from a specific custom object from Marketo.
For example, you want to track the flight reservations booked by a lead.
The following image shows the details of the reservation custom object that you can access from Marketo:
You can view the reservation custom object details in Marketo.
The following image shows the field attributes of the reservation object that you can access from Marketo:
You can view the field attributes of the reservation object in Marketo.
The following table shows data for a few fields of the reservation custom object that you can retrieve for a lead from Marketo:
createdAt
marketoGUID
updatedAt
pnr
TicketNumber
12/4/2015 04:48:00
2cc3a035-4274-4b34-abc3-9338cda7a1e4
12/4/2015 04:48:00
BAF57HG1
1001
12/4/2015 04:48:00
c0d1297d-aacc-4d74-8ac7-89490b36d811
12/4/2015 04:48:00
TAU64GS5
1002

Extracting Lead Data by Filter Type

When you configure a Data Synchronization task or Mapping Configuration task to read data from Marketo, you can enter a filter value to filter records that the Secure Agent reads from the source.
You must configure the following properties in the advanced lead source properties in a Data Synchronization task or Mapping Configuration task:
For example, you want to retrieve leads based on their IDs. In the advanced source properties of a task, specify id in the filter field, 8781,8782,8783 as the filter values CSV file, and then provide the following location of the .csv file where the filter values are present: C:\Marketo\FilterValues_Id.csv
You can specify a batch size for reading the filtered email IDs of leads if the number of records are high.
The following table provides the following lead details from the resultant search:
id
firstName
salutation
middleName
lastName
email
phone
8781
Roger N
Mr.
Brandon
Gattis
gattis@baldor.com
4796464711
8782
Octavio
Mr.
Linus
Gutiérrez
jgb@grupocp.mx
5263790289
8787
Eric
Mr.
Lee
Olson
jgb@grupocp.mx
701-530-1400

Extracting Lead Data by List ID

You can specify the list ID to retrieve a list containing specific leads.
To retrieve leads from a list, you must configure the following properties in the advanced source properties in a Data Synchronization task or Mapping Configuration task:
When you run the Data Synchronization task or Mapping Configuration task, all leads from the specified list are retrieved.
For example, specify the list ID for leads as 100 and the batch limit as 300 in the advanced source properties in a task.
The following table provides the details of the leads retrieved from the list:
id
firstName
salutation
middleName
lastName
email
phone
8781
Roger N
Mr.
Brandon
Gattis
gattis@baldor.com
4796464711
8782
Octavio
Mr.
Linus
Gutiérrez
jgb@grupocp.mx
5263790289
8787
Eric
Mr.
Lee
Olson
jgb@grupocp.mx
701-530-1400

Extracting Lead Data by Program ID

You can retrieve leads from a program. You must provide the program ID to retrieve leads from that program.
Configure the following properties in the advanced source properties in a Data Synchronization task or Mapping Configuration task:
When you specify the program ID, you retrieve the following fields of the lead by default: progressionStatus, stream, nurtureCadence, isExhausted, acquiredBy, reachedSuccess, reachedSuccessDate, and membershipDate

Changed Data Capture for Lead and Lead Activities

You can capture lead changes and lead activity changes for a specified date and time, since the last extracted period, or from a specified time period.
To capture changed data for leads, you must map the following fields from the source to the target: activityId, activityDate, activityTypeId, attributeName, attributeValue, and CDCType
To capture changed data for lead activities, you must map the following fields from the source to the target: activityId, activityDate, activityTypeId, primaryAttributeValueId, primaryAttributeValue, attributeName, attributeValue
You can also map other lead fields. However, if any of the lead fields does not involve lead activity changes or lead changes, those fields will not show any values when you run the mapping. Ensure that you do not configure both Since Date Time and Since Last Extract in the same Data Synchronization task or Mapping Configuration task.

Changed Data Capture Since Date Time

You can capture lead changes or lead activity changes from a specified date and time. Specify lead as the source object in a Data Synchronization task or Mapping Configuration task to capture lead changes or lead activity changes.
Lead Changes
You can retrieve change data values for the lead object. You must map only those fields that show lead changes.
To retrieve lead changes, configure the following advanced source properties in the Data Synchronization task or Mapping Configuration task:
For example, you want to retrieve a list of leads and corresponding emails from a specific list of leads in Marketo that has changed from February 01, 2015. Specify the changed data capture since date time to retrieve the lead changes.
Specify the changed data capture date range in the following format: 2015-02-01T13:22:17-08:00
Specify the list ID of leads as 100.
Lead Activities
You can retrieve the activities performed by leads. When you specify an activity type ID and a Since Date Time value, the Data Synchronization task or Mapping Configuration task capture the changes in lead activities from the specified time. Ensure that you do not map any lead fields because the REST call does not retrieve any lead fields.
To retrieve lead activities, configure the following advanced source properties in the Data Synchronization task or Mapping Configuration task:

Changed Data Capture for a Specified Period

You can provide a start date and end date to capture lead changes or lead activity changes for a specific period. Specify lead or lead activity as the source object in a Data Synchronization task or Mapping Configuration task to capture lead changes or lead activity changes.
Lead Changes
You can retrieve change data values for the lead object. You must map only those fields that show lead changes.
To retrieve lead changes, configure the following advanced source properties in a Data Synchronization task or Mapping Configuration task:
For example, you want to retrieve a list of leads and corresponding emails from a specific list of leads in Marketo that has changed from November 30, 2014 to December 10, 2015. To retrieve the lead changes, specify the list ID of leads as 100. Specify the start date in the following format: 2014-11-30. Specify the end data in the following format: 2015-12-10.
Lead Activities
You can retrieve the activities performed by leads for a specified time period. When you specify an activity type ID, a start date, and end date in a Data Synchronization task or Mapping Configuration task, the Secure Agent captures the changes in lead activities from the specified period.
To retrieve lead activities, configure the following advanced source properties in a Data Synchronization task or Mapping Configuration task:

Changed Data Capture Since the Last Extract

You can capture lead changes or lead activity changes since the last extract.
Lead Changes
You can retrieve change data values for the lead object. You must map only those fields that have been changed.
To retrieve lead changes, configure the following advanced source properties in the Data Synchronization task or Mapping Configuration task:
For example, you can track web page visits for leads from a list in Marketo from February 01, 2015.
Lead Activities
You can retrieve the activities performed by leads. When you specify an activity type ID and a since last extract value, the Data Synchronization task or Mapping Configuration task captures the changes in lead activities since the last extract period. Ensure that you do not map any lead fields because the REST call does not retrieve any lead fields.
To retrieve lead activities, configure the following advanced source properties in the Data Synchronization task or Mapping Configuration task:

Extract Campaign Data

You can specify the campaign ID or name to retrieve a campaign from Marketo.
To retrieve a campaign, you can configure one or both of the following properties in the advanced source properties in a Data Synchronization task or Mapping Configuration task:
To retrieve multiple campaigns, specify the campaign IDs and campaign names, each separated with a comma.

Retrieving Lists

You can retrieve lists from Marketo.
To retrieve lists, configure the following advanced list properties in a Data Synchronization task or Mapping Configuration task:
You can specify more than one value for the specified advanced properties separated by a comma.
For example, specify the list ID for list details as 1113,1114 and the list name as SalesForceList,ZuoraList that you want to retrieve.
The following table shows the details of the retrieved list:
id
name
description
programName
createdAt
updatedAt
1113
SalesForceList
2013 Liz
-
2013-12-05T18:47:40Z
2015-03-09T19:46:34Z
1114
ZuoraList
2013 MH
moni's list upload
2013-12-05T18:47:42Z
2013-12-05T18:49:06Z

Retrieving Data from Custom Objects

You can retrieve data from a custom object in Marketo based on the search criteria you specify in a Data Synchronization task or Mapping Configuration task.
To retrieve custom object records from Marketo, configure the following advanced list properties in a Data Synchronization task or Mapping Configuration task:
For example, specify the filter type as dedupeFields and the filter value as E:\Files\FilterValues_DDF_Reservation.csv , which contains the dedupe field values. Specify the custom object fields as createdAt,marketoGUID,updatedAt,pnr,TicketNumber for which you want to retrieve data from a flight reservation custom object.
The following table shows the details of the retrieved list:
createdAt
marketoGUID
updatedAt
pnr
TicketNumber
12/4/2015 04:48:00
2cc3a035-4274-4b34-abc3-9338cda7a1e4
12/4/2015 04:48:00
BAF57HG1
1001
12/4/2015 04:48:00
c0d1297d-aacc-4d74-8ac7-89490b36d811
12/4/2015 04:48:00
TAU64GS5
1002