接続の確立

Marketo への接続を追加

Marketo への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
Marketo アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからMarketo コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Marketo への接続

Marketo に接続するには、次の接続オプションが必要です。

URL：REST API サービスのURL。これは管理 -> 統合 -> ウェブサービス -> REST API で確認できます。値の例：https://123-abc-456.mktorest.com/ or https://123-abc-456.mktorest.com/rest
OAuthClientId：カスタムサービスに紐付けられたOAuth クライアントID。
OAuthClientSecret：カスタムサービスに紐付けられたOAuth クライアントシークレット。

その他の接続オプションについては、接続文字列オプションを参照してください。

OAuth 資格情報の取得

OAuth 資格情報を取得する前に、まだカスタムサービスを持っていない場合は、作成する必要があります。そのためには、カスタムサービスの作成の手順に従います。

カスタムサービスのOAuth資格情報を取得するには：

管理タブに移動します。
LaunchPoint オプションをクリックします。
サービスを選択して詳細の表示をクリックします。
Marketo は、認証資格情報を表示するウィンドウを開きます。"Client Id" をOAuthClientId の値として、Client Secret" をOAuthClientSecret の値として使用します。

高度な機能

このセクションでは、Marketo Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Marketo にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

CData Sync App は、Marketo エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。

Note： バルクAPI を使用する場合、データモデルが異なる可能性があります。

テーブル

テーブルでは、利用可能なテーブルを説明します。 CustomObjects、CustomActivities、Leads、StatiListLeads、Companies、NamedAccounts、Opportunities、Opportunityroles、SalesPersons、およびProgramMembers テーブルは動的テーブルです。データモデルは、Marketo データモデルの外観のサンプルを示します。実際のデータモデルは、使用するMarketo インスタンスに基づいて動的に取得されます。

ビュー

ビューでは、Activities_NewLead、WeeklyUsageStatistics などの利用可能な読み取り専用データについて説明します。

ストアドプロシージャ

ストアドプロシージャは、Marketo のファンクションライクなインターフェースです。これらは、テーブルやビューとしてモデル化できない情報の作成、更新、変更、取得に使用できます。一部のプロシージャは、ファイルのダウンロード / アップロードやBulk API とのやりとりに使用されます。

テーブル

Sync App はMarketo のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Marketo Connector for CData Sync テーブル


Name	Description
Activities_Custom	Sample custom activity.
Companies	Query Companies in Marketo.
CustomObjects	Query custom objects for a Marketo organization.
Emails	Query emails for a Marketo organization.
EmailTemplates	Query email templates for a Marketo organization.
Folders	Create, update, delete, and query Folders for a Marketo organization.
Forms	Create, update, delete and query Forms for a Marketo organization.
LandingPageContentSection	Create, update, delete, and query Content Sections of Landing Pages for a Marketo organization.
LandingPages	Create, update, delete and query Landing Pages for a Marketo organization.
LandingPageTemplates	Create, update, delete and query Landing Page Templates for a Marketo organization.
Leads	Query Leads of a Marketo organization.
NamedAccounts	Query Named Accounts for a Marketo organization.
Opportunities	Query Opportunities in Marketo.
OpportunityRoles	Query Opportunity Roles in Marketo.
ProgramMembers	Query Program Members in Marketo.
Programs	Create, update, delete, and query Programs for a Marketo organization.
SalesPersons	Query Sales Persons in Marketo.
SmartCampaigns	Query Smart Campaigns for a Marketo organization.
SmartLists	Query Smart Lists for a Marketo organization.
Snippets	Create, update, delete and query snippets for a Marketo organization.
StaticListMembership	Query relations of static lists and leads in Marketo.
StaticLists	Query Static Lists for a Marketo organization.
Tokens	Create, delete, and query Tokens for a Marketo organization.
Users	Query users for a Marketo organization.
UserWorkspaceRoles	Query user roles for each workspace in Marketo.

Activities_Custom

Sample custom activity.

Each custom activity in your Marketo organization is returned as a separate table, apart from the main "Activities" table. Each table name is prefixed with 'Activity_' followed by the name of your custom activity.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

The following queries are related to a sample custom activity 'Activities_AttendConference'. This table may not exist in your Marketo instance.

	SELECT * FROM Activities_AttendConference WHERE ListId = '1014'

Insert

	INSERT INTO Activities_AttendConference (ActivityDate, LeadId, PrimaryAttributeValue, ConferenceDate, NumberOfAttendees) VALUES ('2024-01-01T00:01:00Z', 4, 'asd', '2024-01-10', 4)

Bulk

When UseBulkAPI is set to true the ActivityDate filter can be processed server-side. Sample queries:

	SELECT * FROM Activities_AttendConference WHERE ActivityDate > '2024-01-01T00:00:00Z'
	SELECT * FROM Activities_AttendConference WHERE ActivityDate >= '2024-01-01T00:00:00Z' AND ActivityDate <= '2024-03-01T00:00:00Z'
	SELECT * FROM Activities_AttendConference WHERE ListId = '1014' AND ActivityDate > '2024-01-01T00:00:00Z'
	SELECT * FROM Activities_AttendConference WHERE ListId = '1014' AND ActivityDate >' 2024-01-01T00:00:00Z'

Columns


Name	Type	ReadOnly	Operators	Description
ActivityId [KEY]	String	False		Unique id of the activity.
ActivityDate	Datetime	False		Datetime of the activity.
LeadId	Int	False	=,IN	Id of the lead associated to the activity.
CampaignId	Int	False		Id of the associated Smart Campaign, if applicable.
ListId	Int	False	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ConferenceName	String	False
ConferenceNameValue	String	False
ConferenceDate	Datetime	False
NumberOfAttendees	Int	False

Companies

Query Companies in Marketo.

Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.

Select

Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

	SELECT * FROM Companies WHERE [Id]=10
	SELECT * FROM Companies WHERE [Id] IN (10, 11, 22)
	SELECT * FROM Companies WHERE [ExternalCompanyId]='CData'
	SELECT * FROM Companies WHERE [ExternalCompanyId] IN ('CData', 'Marketo')
	SELECT * FROM Companies WHERE [Company]='CData'
	SELECT * FROM Companies WHERE [Company] IN ('CData', 'Marketo')
	SELECT * FROM Companies WHERE [ExternalSalesPersonId]='CDataSales'
	SELECT * FROM Companies WHERE [ExternalSalesPersonId] IN ('CDataSales', 'MarketoSales')

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO Companies (ExternalCompanyId, Company, Industry, Website) VALUES ('cdata', 'CData', 'Tech', 'cdata.com'), ('marketo', 'Marketo', 'Tech', 'marketo.com')

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

	UPDATE Companies SET Company='test_UPDATE_Companies', MainPhone='800-555-1234', AnnualRevenue='10000000.00' WHERE ExternalCompanyId='cdata'
	UPDATE Companies SET Company='CData', MainPhone='800-555-1234', AnnualRevenue='10000000.00' WHERE WHERE Id IN (2523781, 2523782, 2523783, 2523784)

Upsert

This table supports BATCH UPSERT when UseBulkAPI is set to false.

	UPSERT INTO Companies (ExternalCompanyId, Company, Industry, Website) VALUES ('testUpsert', 'Google', 'Tech', 'google.com')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM Companies WHERE externalCompanyId='cdata'
	DELETE FROM Companies WHERE Id IN (2521059, 2521060, 123, 2521058)
	DELETE FROM Companies WHERE Company='testName'

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=,IN
ExternalCompanyId	String	True	=,IN
AnnualRevenue	Decimal	False
BillingCity	String	False
BillingCountry	String	False
BillingPostalCode	String	False
BillingState	String	False
BillingStreet	String	False
Company	String	False	=,IN
CompanyNotes	String	False
ExternalSalesPersonId	String	False	=,IN
Industry	String	False
MainPhone	String	False
NumberOfEmployees	Int	False
SicCode	String	False
Site	String	False
Website	String	False
CreatedAt	Datetime	True
UpdatedAt	Datetime	True

CustomObjects

Query custom objects for a Marketo organization.

Each custom object in your Marketo organization is returned as a separate table. Each table name is prefixed with 'CustomObject_' followed by the name of your custom object.

Select

Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

The following queries are related to a sample custom object. This table may not exist in your Marketo instance.

	SELECT * FROM CustomObject_cdata WHERE MarketoGUID IN ('8207b49b-933c-40a0-995d-d12c90572a65', '71cce7c8-e7d1-4a00-8ea7-89806fee56be')
	SELECT * FROM CustomObject_cdata WHERE Mailaddress IN ('[email protected]', '[email protected]')

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO CustomObject_cdata (Names) VALUES ('tes123')

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

	UPDATE CustomObject_cdata SET Value1='testupdate' WHERE Mailaddress='[email protected]'
	UPDATE CustomObject_cdata SET Value1='testupdateMultipleValues' WHERE Mailaddress IN ('[email protected]', '[email protected]')

Upsert

This table supports BATCH UPSERT when UseBulkAPI is set to false.

This table supports BULK UPSERT when UseBulkAPI is set to true.

	UPSERT INTO CustomObject_cdata (Mailaddress, Value1) VALUES ('[email protected]', 'test01')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM [CustomObject_cdata] WHERE MarketoGUID='8207b49b-933c-40a0-995d-d12c90572a65'
	DELETE FROM [CustomObject_cdata] WHERE MarketoGUID IN ('980415e9-3cf0-4168-ae99-8cf3c613c83b', '71cce7c8-e7d1-4a00-8ea7-89806fee56be')
	DELETE FROM [CustomObject_cdata] WHERE Mailaddress='[email protected]'
	DELETE FROM [CustomObject_cdata] WHERE Mailaddress IN ('[email protected]', '[email protected]')

Bulk

When UseBulkAPI is set to true the UpdateAt filter can be processed server-side, in addition to that the following extra filters are available:


Name	Type	ReadOnly	Operators	Description
ListId	Int	True	=	Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided static list Id.
ListName	String	True	=	Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided static list name.
SmartListId	Int	True	=	Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list Id.
SmartListName	String	True	=	Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list name.

Sample queries:

	SELECT * FROM CustomObject_cdata WHERE UpdatedAt>'2024-04-01T00:00:00Z'
	SELECT * FROM CustomObject_cdata WHERE UpdatedAt>'2024-04-01T00:00:00Z' AND UpdatedAt<'2024-09-01T00:00:00Z'
	SELECT * FROM CustomObject_cdata WHERE ListId=2

Columns


Name	Type	ReadOnly	Operators	Description
MarketoGUID [KEY]	String	True	=,IN
UpdatedAt	Datetime	True		The datetime when the custom object was last updated.
CreatedAt	Datetime	True
Mailaddress	String	False	=,IN
Value1	String	False

Emails

Query emails for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

GetEmailFullContent can be used to retrieve the full content of an email.

UpdateEmailContent can be used to update the content content of an email.

UpdateEmailFullContent can be used to update the full content of an email.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following queries are processed server-side:

	SELECT * FROM Emails WHERE Id=15457
	SELECT * FROM Emails WHERE Name='[email protected]'
	SELECT * FROM Emails WHERE FolderId=26
	SELECT * FROM Emails WHERE UpdatedAt >= '2023-03-22 00:09:14.0' AND UpdatedAt <= '2023-03-22 01:49:03.0'

Insert

	INSERT INTO Emails (Name, TemplateId, FolderId, FolderType) VALUES ('My Email', 1037, 5111, 'Program')

Update

	UPDATE Emails SET Name='CRUD Test', Description='Testing CRUD' WHERE Id=23852

Delete

	DELETE FROM Emails WHERE Id=23838
	DELETE FROM Emails WHERE Id=23759 AND Status='approved'
	DELETE FROM Emails WHERE Id IN (17008, 23764) AND Status='draft'

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	The unique, Marketo-assigned identifier of the email.
Status [KEY]	String	True	=	The status of the email, draft or approved version.
Name	String	False	=	The name of the email.
Description	String	False		The description of the email.
Subject	String	False		The email subject.
FromName	String	False		The from name.
FromEmail	String	False		The from email address.
ReplyEmail	String	False		The reply email address.
PreHeader	String	False		The pre-header text for the email.
URL	String	True		The URL of the asset in the Marketo UI.
TemplateId	Int	False		The template associated with the email.
PublishToMSI	Bool	True		Identifies whether the email is published.
Version	Int	True		The Template version type.
Operational	Bool	False		Identifies whether the email is operational.
TextOnly	Bool	False		Identifies whether the email is text only.
WebView	Bool	False		Identifies whether the email is web view.
AutoCopyToText	Bool	False		Identifies whether the email is auto copied to text.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	False	=	The type of folder (Folder,Program)
WorkspaceName	String	True		Name of the workspace the email is part of.
CreatedAt	Datetime	True		Datetime the email was created.
UpdatedAt	Datetime	True	=,>,<,>=,<=	Datetime the email was most recently updated.

EmailTemplates

Query email templates for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

CreateEmailTemplate can be used to create email templates.

GetEmailTemplateContent can be used to retrieve the email template content.

UpdateEmailTemplateContent can be used to update the email template content.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following queries are processed server-side:

	SELECT * FROM EmailTemplates WHERE ID=1038
	SELECT * FROM EmailTemplates WHERE Name='Test Template 3'
	SELECT * FROM EmailTemplates WHERE Status='approved'
	SELECT * FROM EmailTemplates WHERE ID=1038 AND Status='approved'

Update

	UPDATE EmailTemplates SET Description='test update' WHERE Id=1039

Delete

	DELETE FROM EmailTemplates WHERE Id=1014
	DELETE FROM EmailTemplates WHERE Id=1034 AND Status='draft'
	DELETE FROM EmailTemplates WHERE Name='Serenity (Marketo Starter Template)

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	The id of the asset.
Status [KEY]	String	True	=	Status of the email template, draft or approved versions.
Name	String	False	=	The name of the asset.
Description	String	False		The description of the asset.
URL	String	True		The URL of the asset in the Marketo UI.
Version	Int	True		The Template version type.
WorkspaceName	String	True		Name of the workspace the email template is part of.
FolderId	Int	True		The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	True		The type of folder (Folder,Program)
CreatedAt	Datetime	True		The date and time the asset was created.
UpdatedAt	Datetime	True		The date and time the asset was last updated.

Folders

Create, update, delete, and query Folders for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following queries are processed server-side:

	SELECT * FROM Folders WHERE Name='Marketo8'
	SELECT * FROM Folders WHERE Name='Default'
	SELECT * FROM Folders WHERE Name='Default' AND WorkspaceName='Default'
	SELECT * FROM Folders WHERE MaxDepth=1;
	SELECT * FROM Folders WHERE ParentId=12 AND ParentType='Folder'
	SELECT * FROM Folders WHERE ParentId=12

Insert

	INSERT INTO Folders (Name, ParentId, ParentType, Description) VALUES ('newFolder1234567', 38, 'Folder', 'test insert description')

Update

Note: Folders of Type='Program' can not be updated.

	UPDATE Folders SET Description='test update folders2', IsArchive='true' WHERE Id IN (5910, 5911) AND Type='Folder'

Delete

Note: Folders of Type='Program' and folders with IsSystem=true can not be deleted.

	DELETE FROM Folders WHERE Id=5363 AND Type='Folder'

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	The unique, Marketo-assigned identifier of the folder.
Type [KEY]	String	False	=	The type of the folder (Folder or Program).
Name	String	False	=	The name of the folder.
Description	String	False		The description of the folder.
FolderType	String	True		The type of the folder (Revenue Cycle Model, Marketing Folder, List, Smart List).
ParentId	Int	False	=	The Id of the parent folder.
ParentType	String	False	=	The type of the parent folder.
Path	String	True		The path of a folder shows its hierarchy in the folder tree, similar to a Unix-style path.
WorkspaceName	String	True	=	The name of the smart campaign workspace.
URL	String	True		The explicit URL of the asset in the designated instance.
IsSystem	Bool	True		Whether or not the folder is a system folder.
IsArchive	Bool	False		Whether or not the folder is archived.
AccessZoneId	Int	True		The access zone id
CreatedAt	Datetime	True		The date and time the folder was created.
UpdatedAt	Datetime	True		The date and time the folder was last updated.
MaxDepth	Int	True	=	Mirror column used to specify the maximum folder depth to traverse. Will be ignored when filtering by Id or Name.

Forms

Create, update, delete and query Forms for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following queries are processed server-side:

	SELECT * FROM FORMS WHERE status='draft'
	SELECT * FROM FORMS WHERE Id=1001
	SELECT * FROM FORMS WHERE Name='Form1'
	SELECT * FROM FORMS WHERE Id=1001 AND Status='draft'
	SELECT * FROM FORMS WHERE FolderId=1089 AND FolderType='Program'
	SELECT * FROM FORMS WHERE FolderId=1002

Insert

	INSERT INTO Forms (Name, Description, FolderId, FolderType, FontFamily, FontSize, LabelPosition, Language, Locale, ProgressiveProfiling) 
	VALUES ('test insert form', 'test form description', 1089, 'Program', 'Arial', '12px', 'left', 'English', 'en_US', true)

Update

	UPDATE Forms SET Name='test update form', Description='Testing Update', FontSize='13px' WHERE Id=1016

Delete

	DELETE FROM Forms WHERE Id=1004
	DELETE FROM Forms WHERE Id=1004 AND Status='draft'
	DELETE FROM Forms WHERE Name IN ('test', 'My Snippet')

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	The unique, Marketo-assigned identifier of the form.
Status [KEY]	String	True	=	Status of the form, draft or approved versions.
Name	String	False	=	The name of the form.
Description	String	False		The description of the form.
URL	String	True		The URL of the form in the Marketo UI.
KnownVisitorTemplate	String	False		Template of the known visitor behavior for the form.
KnownVisitorType	String	False		Type of the known visitor behavior for the form.
Theme	String	False		CSS theme for the form to use.
Language	String	False		Language of the form.
Locale	String	False		Locale of the form.
ProgressiveProfiling	Bool	False		Whether progressive profiling is enabled for the form.
LabelPosition	String	False		Default positioning of labels.
ButtonLabel	String	False		Label text of the button.
ButtonWaitingLabel	String	False		Waiting text of the button.
ButtonLocation	Int	False		Location in pixels of the button relative to the left of the form.
FontFamily	String	False		font-family property for the form.
FontSize	String	False		font-size property of the form.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	False	=	The type of folder (Folder,Program)
WorkspaceId	Int	True		Workspace Id of the asset.
CreatedAt	Datetime	True		Datetime the form was created.
UpdatedAt	Datetime	True		Datetime the form was most recently updated.
ThankYouList	String	True		JSON array of ThankYouPage JSON objects.

LandingPageContentSection

Create, update, delete, and query Content Sections of Landing Pages for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following queries are processed server-side:

	SELECT * FROM LandingPageContentSection WHERE LandingPageId='2'
	SELECT * FROM LandingPageContentSection WHERE LandingPageId='2' AND status='draft'

Insert

	INSERT INTO LandingPageContentSection (LandingPageId, Content, Type, Height, Width, FormattingOptionsTop, FormattingOptionsLeft, Opacity, BorderColor, BackgroundColor, HideDesktop, HideMobile, ImageOpenNewWindow, FormattingOptionsZIndex) 
	VALUES (1009, '<html><body>Hello World!</body></html>', 'HTML', '100', '101', '1', '2', '0.8', '#ff00ff', '#00ffff', false, true, true, 1)

Update

	UPDATE LandingPageContentSection BorderColor='#ff0000', BackgroundColor='#0000ff', HideMobile='true', ImageOpenNewWindow='true', Type='HTML', FormattingOptionsTop='1', FormattingOptionsLeft='2', Width='101', HideDesktop='false', Opacity='0.8', Content='<html><body>Hello World!</body></html>', Height='100', FormattingOptionsZIndex='1'
	WHERE LandingPageId=1009 AND Id=1049

Delete

	DELETE FROM LandingPageContentSection WHERE LandingPageId=1009

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	String	True		Id of the content section.
LandingPageId [KEY]	String	False	=	Id of the landing page to which the content section belongs to.
Status [KEY]	String	True	=	Status filter for draft or approved versions.
Index	Int	True		Index of the content section. Index orients the elements from lowest to highest.
Type	String	False		Type of content section.
Content	String	False		Content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content.
RawContent	String	True		Raw content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content.
ContentType	String	True		Content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content.
ContentURL	String	True		Content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content.
LinkURL	String	False		RL parameter of a link type section.
FollowupType	String	False		Follow-up behavior of a form. Only available for form-type content sections. Defaults to form defined behavior.
FollowupValue	String	False		Where to follow-up on form submission. When followupType is lp, accepts the integer id of a landing page. For url, it accepts a url string.
Height	String	False		The height of the content.
MinHeight	String	True		The min height of the content.
Width	String	False		The width of the content.
MinWidth	String	True		The min width of the content.
FormattingOptionsTop	String	False		The top margin of the content.
FormattingOptionsLeft	String	False		The left margin of the content.
Opacity	String	False		The opacity of the content.
BorderWidth	String	False		The border width of the content.
BorderStyle	String	False		The border style of the content.
BorderColor	String	False		The border color of the content.
BackgroundColor	String	False		The background color of the content.
HideDesktop	Bool	False		Hide the section when displayed on a desktop browser. Default false.
HideMobile	Bool	False		Hide the section when displayed on a desktop browser. Default false.
ImageOpenNewWindow	String	False		ImageOpenNewWindow
FormattingOptionsZIndex	String	False		The z-index of the content.

LandingPages

Create, update, delete and query Landing Pages for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following queries are processed server-side:

	SELECT * FROM LandingPages WHERE status='approved'
	SELECT * FROM LandingPages WHERE folderId=1001
	SELECT * FROM LandingPages WHERE folderId=1001 AND status='draft'
	SELECT * FROM LandingPages WHERE name='string'

Insert

	INSERT INTO LandingPages (Name, CustomHeadHTML, Description, FacebookOgTags, FolderId, FolderType, Keywords, MobileEnabled, Robots, Template, Title)
	VALUES ('test insert landing page', '<!DOCTYPE html>\\n<html>\\n<body>\\n<h1>My landing page</h1>\\n<p>My landing page content.</p>\\n</body></html>', 'Testing  Insert operation', '', 1184, 'Program', '', true, 'index,  nofollow', 1, 'Insert Operation')

Update

	UPDATE LandingPages SET Description='Testing Update', FacebookOgTags='', Keywords='',
	MobileEnabled=false, Name='Test Update', Robots='index, nofollow',Title='Updating Landing Page',
	CustomHeadHTML='<!DOCTYPE html>\n<html>\n<body>\n<h1>Updating Landing Page</h1>\n<p>Editing Landing Page</p>\n</body></html>'
	WHERE Id=1009

Delete

Note: Approved landing pages cannot be deleted. Use UnApproveAsset to revoke landing page approval.

	DELETE FROM LandingPages WHERE Id=1003
	DELETE FROM LandingPages WHERE Id=1003 WHERE status='draft'

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	The unique, Marketo-assigned identifier of the landing page.
Status [KEY]	String	True	=	Status filter for draft or approved versions.
Name	String	False	=	The name of the landing page.
Description	String	False		The description of the landing page.
Title	String	False		Title element of the landing page.
URL	String	True		The URL of the landing page in the Marketo UI.
ComputedURL	String	True		Computed URL of landing page.
WorkspaceName	String	False		Workspace name of the asset.
Template	Int	False		Id of the template used.
Robots	String	False		Robots directives to apply to the pages meta tags
MobileEnabled	Bool	False		Whether the page has mobile viewing enabled. Free-form pages only. Default false.
CustomHeadHTML	String	False		Any custom HTML to embed in the tag of the page.
Keywords	String	False		Keywords
FormPrefill	Bool	True		Boolean to toggle whether forms embedded in the page will prefill. Default false.
FacebookOgTags	String	False		Any OpenGraph meta tags to apply to the page.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	False	=	The type of folder (Folder,Program)
CreatedAt	Datetime	True		Datetime the landing page was created.
UpdatedAt	Datetime	True		Datetime the landing page was most recently updated.

LandingPageTemplates

Create, update, delete and query Landing Page Templates for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side. The Name and Id filters will be processed server-side only if Status='approved'.

For example, the following queries are processed server-side:

	SELECT * FROM LandingPageTemplates WHERE Status='approved'
	SELECT * FROM LandingPageTemplates WHERE FolderId=19
	SELECT * FROM LandingPageTemplates WHERE Name='Test Insert 1' AND Status='approved'
	SELECT * FROM LandingPageTemplates WHERE Id=3 AND Status='approved'

Insert

	INSERT INTO LandingPageTemplates (Name, TemplateType, Description, EnableMunchkin, FolderId, FolderType)
	VALUES ('Test Insert 1', 'guided', 'Testing Insert', true, 19, 'Folder')

Update

	UPDATE LandingPageTemplates SET Description='Testing Update', EnableMunchkin=false, Name='Test Update' WHERE Id=1

Delete

	DELETE FROM LandingPageTemplates WHERE Id=2 AND Status='approved'
	DELETE FROM LandingPageTemplates WHERE Name='Test Insert 1'

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	The unique, Marketo-assigned identifier of the landing page template.
Status [KEY]	String	True	=	Status of the landing page template, draft or approved versions.
Name	String	False	=	The name of the landing page template.
Description	String	False		The description of the landing page template.
EnableMunchkin	Bool	False		Whether to enable munchkin on the derived pages. Defaults to true.
TemplateType	String	False		Type of template to create 'guided' or 'freeForm'
URL	String	True		The URL of the landing page in the Marketo UI.
WorkspaceName	String	True		Workspace name of the asset.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	False	=	The type of folder (Folder,Program)
CreatedAt	Datetime	True		Datetime the landing page template was created.
UpdatedAt	Datetime	True		Datetime the landing page template was most recently updated.

Leads

Query Leads of a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

To optimize response time from the server, identify only the rows and columns you want to retrieve.

SELECT Id, FirstName, LastName FROM Leads WHERE Id IN (1, 2, 5, 10)

To achieve the best performance from this query, confine it to a list of known Leads within Marketo. Create a static list of Leads within Marketo, and then specify the ListId to retrieve them.

SELECT * FROM Leads WHERE ListId=1014

If you do not specify a filter, the driver retrieves all Leads, which might take a long time depending on the number of leads in your Marketo instance. Specify the LeadChangeDateTime pseudo-column to improve query performance by limiting the number of records requested.

Note: LeadChangeDateTime is a pseudo column that can only be used as a server-side filter. The API does not return values for this column. This is a result of the documented API behavior, see this forum post.

	SELECT * FROM Leads WHERE LeadChangeDateTime >= '2024-03-20T15:49:22.000Z'
	SELECT Id, LeadChangeDateTime, UpdatedAt FROM Leads WHERE LeadChangeDateTime >= '2024-01-17T14:32:37.000-05:00'

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO Leads (FirstName, LastName, Email, DoNotCall, DoNotCallReason, DateOfBirth) VALUES ('test', 'test', '[email protected]', true, 'Testing', '01/01/2000')
	INSERT INTO Leads (FirstName, LastName, Email, DoNotCall, DoNotCallReason, DateOfBirth) VALUES ('test1', 'test1', '[email protected]', true, 'Testing', '01/01/2000'), ('test3', 'test3', '[email protected]', true, 'Testing', '01/01/2000')
	INSERT INTO Leads (FirstName, LastName, Email, PartitionName) VALUES ('test', 'test', '[email protected]', 'testPartition')

To insert multiple leads at once via a #TEMP table, first create the #TEMP table, and then insert that table into your Leads table.

The following example creates a #TEMP table with three new Leads, and then inserts that #TEMP table into the Leads table:

	INSERT INTO Leads#TEMP (FirstName, LastName, Email, Company) VALUES ('John', 'Mangel', '[email protected]', 'ABC')
	INSERT INTO Leads#TEMP (FirstName, LastName, Email, Company) VALUES ('Steve', 'Puth', '[email protected]', 'ABC')
	INSERT INTO Leads#TEMP (FirstName, LastName, Email, Company) VALUES ('Andrew', 'Stack', 'andy@abc', 'ABC')

	INSERT INTO Leads (FirstName, LastName, Email, Company) SELECT FirstName, LastName, Email, Company FROM Leads#TEMP

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

You can update any field in the Leads table that is not read-only. All critria fields are used as deduplication fields. Use a field for deduplication if it supports server side filtering, otherwise the Id column is used for deduplication.

	UPDATE Leads SET Company='TestCompany', NumberOfEmployees=100 WHERE Id='2521004'
	UPDATE Leads SET Title='My Job', Address='123 Main St' WHERE Email='[email protected]'
	UPDATE LEADS SET Email='[email protected]' WHERE Id=2523020
	UPDATE LEADS SET TestKpQA='test' WHERE TestCustomfieldEmail='[email protected]'

Upsert

This table supports BATCH UPSERT when UseBulkAPI is set to false.

This table supports BULK UPSERT when UseBulkAPI is set to true.

	UPSERT INTO Leads (Email, FirstName, LastName) VALUES ('[email protected]', 'Lead', 'Upsert_InsertNewRecord')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM Leads WHERE Id=508
	DELETE FROM Leads WHERE Id IN (505, 506, 501, 507)
	DELETE FROM Leads WHERE Email='[email protected]'

GetDeleted

Note: The API returns only leads which have been deleted in the past 14 days.

	GetDeleted FROM Leads

GetDeleted supports filtering by UpdatedAt.

	GETDELETED FROM Leads WHERE UpdatedAt > '2024-01-01T01:00:00'
	GETDELETED FROM Leads WHERE UpdatedAt > '2024-01-01T01:00:00' AND UpdatedAt <= '2024-02-01T01:00:00'

Bulk

When UseBulkAPI is set to true, the CreatedAt filter can be processed server-side. In addition, the following extra filters are available:


Name	Type	ReadOnly	Operators	Description
StaticListName	String	True	=	Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided static list name.
SmartListId	Int	True	=	Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list Id.
SmartListName	String	True	=	Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list name.

Sample queries:

	SELECT Id, LeadChangeDateTime, UpdatedAt FROM LEADS WHERE LeadChangeDateTime>'2024-01-17T14:28:57.000-05:00' AND LeadChangeDateTime<'2024-01-29T04:29:55.000-05:00'
	SELECT Id, CreatedAt FROM LEADS WHERE CreatedAt>='2024-01-17T14:27:20.000-05:00' AND CreatedAt<'2024-01-29T04:29:30.000-05:00'
	SELECT * FROM LEADS WHERE ListId=1062
	SELECT * FROM LEADS WHERE StaticListName='test0614'
	SELECT Id FROM LEADS WHERE SmartListId=1095
	SELECT Id FROM LEADS WHERE SmartListName='LeadSmartListTest'

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=,IN	The id of the lead.
CreatedAt	Datetime	True		The datetime when the lead was created.
UpdatedAt	Datetime	True		The datetime when the lead was last updated.
ProgramId	Int	True	=	Mirror column that can be used only as a filter. Will retrieve Leads related to the given email ProgramId. Not available when UseBulkAPI=true.
ListId	Int	True	=	Mirror column that can be used only as a filter. Will retrieve Leads related to the provided static list Id.
PartitionName	String	False		Mirror column that can be used only during inserts to specify the partition of the lead.
ItemURL	String	True		The URL of the lead in the Marketo UI.
LeadChangeDateTime	Datetime	True	=,>,>=,<,<=	A server-side filter for the datetime when the Lead was updated, not necessarily the latest update.
AcmeAccessCode	String	False	=,IN
AcquisitionProgramId	Int	False
Address	String	False
AnnualRevenue	Decimal	False
AnonymousIP	String	False
BillingCity	String	False
BillingCountry	String	False
BillingPostalCode	String	False
BillingState	String	False
BillingStreet	String	False
BlackListed	Bool	False
BlackListedCause	String	False
City	String	False
Company	String	False
ContactCompany	Int	True
Cookies	String	False	=,IN
Country	String	False
Cstmfdtest1	String	False	=,IN
Cstmfdtest2	String	False	=,IN
DateOfBirth	Date	False
Department	String	False	=,IN
DoNotCall	Bool	False
DoNotCallReason	String	False
Ecids	String	True
Email	String	False	=,IN
EmailInvalid	Bool	False
EmailInvalidCause	String	False
EmailSuspended	Bool	False
EmailSuspendedAt	Datetime	False
EmailSuspendedCause	String	False	=,IN
ExternalCompanyId	String	False	=,IN
ExternalSalesPersonId	String	False	=,IN
Fax	String	False
FirstName	String	False
FirstUTMCampaign	String	False
FirstUTMContent	String	False
FirstUTMMedium	String	False
FirstUTMSource	String	False
FirstUTMTerm	String	False
GdprMailableStatus	String	False
Industry	String	False
InferredCity	String	True
InferredCompany	String	True
InferredCountry	String	True
InferredMetropolitanArea	String	True
InferredPhoneAreaCode	String	True
InferredPostalCode	String	True
InferredStateRegion	String	True
IsAnonymous	Bool	False
IsLead	Bool	False
LastName	String	False
LatestUTMCampaign	String	False
LatestUTMContent	String	False
LatestUTMMedium	String	False
LatestUTMSource	String	False
LatestUTMterm	String	False
LeadPartitionId	Int	False	=,IN
LeadPerson	Int	True
LeadRevenueCycleModelId	Int	False
LeadRevenueStageId	Int	False
LeadRole	String	False
LeadScore	Int	False
LeadSource	String	False
LeadStatus	String	False
MainPhone	String	False
MarketingSuspended	Bool	False
MarketingSuspendedCause	String	False
MiddleName	String	False
MktoAcquisitionDate	Datetime	False
MktoCompanyNotes	String	False
MktoDoNotCallCause	String	False
MktoIsCustomer	Bool	False
MktoIsPartner	Bool	False
MktoName	String	True	=,IN
MktoPersonNotes	String	False
MobilePhone	String	False
NumberOfEmployees	Int	False
NumberofEmployeesProspect	String	False
OriginalReferrer	String	True
OriginalSearchEngine	String	True
OriginalSearchPhrase	String	True
OriginalSourceInfo	String	True
OriginalSourceType	String	True
PersonLevelEngagementScore	Int	False	=,IN
PersonPrimaryLeadInterest	Int	True
PersonTimeZone	String	True
PersonType	String	False
Phone	String	False
PostalCode	String	False
Priority	Int	False
Rating	String	False
RegistrationSourceInfo	String	False
RegistrationSourceType	String	False
RelativeScore	Int	False
RelativeUrgency	Int	False
Salutation	String	False
SicCode	String	False
Site	String	False
State	String	False
Test	String	False	=,IN
Test1	Bool	False
Test98	String	False	=,IN
TestBoolean	Bool	False
TestCustomfieldEmail	String	False	=,IN
TestFieldText1	String	False	=,IN
TestInteger	Bool	False
TestInteger_cf	Int	False	=,IN
TestKpQA	String	False	=,IN
Title	String	False
Unsubscribed	Bool	False
UnsubscribeDateFoFS	String	False
UnsubscribeDateUnleashed	String	False
UnsubscribedReason	String	False
UnsubscribeFoFS	String	False
UnsubscribeMarketing	String	False
UnsubscribeSales	String	False
UnsubscribeUnleashed	String	False
Urgency	Double	False
UTMTerm	String	False	=,IN
Website	String	False

NamedAccounts

Query Named Accounts for a Marketo organization.

Select

Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

	SELECT * FROM NamedAccounts WHERE Name='MyNamedAccount1'

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO NamedAccounts (Name, City, Country, DomainName, Industry) VALUES ('testNamedAccountInsert002', 'Chapel Hill', 'USA', 'MyDomain', 'Tech')

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

	UPDATE NamedAccounts SET NumberOfEmployees=100, State='NC', AnnualRevenue='10000000.00' WHERE Name='testNamedAccountInsert002'
	UPDATE NamedAccounts SET NumberOfEmployees=999 WHERE MarketoGUID='197d0ecd-4264-4826-a44a-58a6df1f9ae5'

Upsert

This table supports BATCH UPSERT when UseBulkAPI is set to false.

	UPSERT INTO NamedAccounts (Name, City, Country, DomainName, Industry) VALUES ('testUpsert', 'Chapel Hill', 'USA', 'MyDomain', 'Tech')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM NamedAccounts WHERE Name IN ('MyAccount2', 'MyAccount')
	DELETE FROM NamedAccounts WHERE marketoGUID IN ('04da404b-c4e9-40c8-867f-d9fae0062343', 'fd422222-a37f-4c2b-86df-3ed4c22e9c79')

Columns


Name	Type	ReadOnly	Operators	Description
MarketoGUID [KEY]	String	True	=,IN
Id	Int	True	=,IN
ApproximateNumOfPeople	Int	True	=,IN
ParentAccountId	Int	True	=,IN
AccountOwnerId	Int	False	=,IN
AccountPhoneNumber	String	False	=,IN
AddressPostalCode	String	False	=,IN
AddressRegion	String	False	=,IN
AnnualRevenue	Decimal	False	=,IN
City	String	False	=,IN
Country	String	False	=,IN
CreatedAt	Datetime	True
CrmGuid	String	False	=,IN
CrmOrgId	Int	False	=,IN
DomainName	String	False	=,IN
ExternalSourceId	String	False	=,IN
ExternalSourceInstanceId	String	False	=,IN
ExternalSourceKey	String	False	=,IN
ExternalSourceType	String	False	=,IN
Industry	String	False	=,IN
LogoUrl	String	False	=,IN
MembershipCount	Int	True	=,IN
Name	String	False	=,IN
NumberOfEmployees	Int	False	=,IN
OpptyAmount	Decimal	True	=,IN
OpptyCount	Int	True	=,IN
SicCode	String	False	=,IN
SourceType	String	False	=,IN
State	String	False	=,IN
Street1	String	False	=,IN
UpdatedAt	Datetime	True

Opportunities

Query Opportunities in Marketo.

Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

Note: A filter must be specified when retrieving Opportunities.

	SELECT * FROM Opportunities WHERE ExternalOpportunityId='test2'
	SELECT * FROM Opportunities WHERE ExternalCompanyId='CData'

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO Opportunities (ExternalOpportunityId, Description, ExternalCompanyId, Name) VALUES ('testOpportunitiesInsert001', 'First Opportunity', 'cdata', 'Opp')

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

	UPDATE Opportunities SET IsWon=true, FiscalYear=2016, Amount='1000.00' WHERE ExternalOpportunityId='testOpportunitiesInsert001'
	UPDATE Opportunities SET IsWon=false, FiscalYear=2017, Amount='1000.00' WHERE ExternalCompanyId='testInsert_ExternalCompanyId_012'

Upsert

This table supports BATCH UPSERT when UseBulkAPI is set to false.

	UPSERT INTO Opportunities (ExternalOpportunityId, Description, ExternalCompanyId, Name) VALUES ('testUpsert', 'First Opportunity', 'CData', 'Opp')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM Opportunities WHERE ExternalOpportunityId='CDATA2'
	DELETE FROM Opportunities WHERE marketoGUID IN ('c1bac835-e5d3-47cc-9c87-bd18fdf573f8', '04ecb93c-d140-4c38-96cc-1fc2821e91eb')

Columns


Name	Type	ReadOnly	Operators	Description
CreatedAt	Datetime	True
ExternalOpportunityId	String	True	=,IN
MarketoGUID [KEY]	String	True	=,IN
UpdatedAt	Datetime	True
Amount	Decimal	False
CloseDate	Date	False
Description	String	False
ExpectedRevenue	Decimal	False
ExternalCompanyId	String	False	=,IN
ExternalCreatedDate	Datetime	False
ExternalSalesPersonId	String	False	=,IN
Fiscal	String	False
FiscalQuarter	Int	False
FiscalYear	Int	False
ForecastCategory	String	False
ForecastCategoryName	String	False
IsClosed	Bool	False
IsWon	Bool	False
LastActivityDate	Date	False
LeadSource	String	False
Name	String	False
NextStep	String	False
Probability	Int	False
Quantity	Double	False
Stage	String	False
Type	String	False

OpportunityRoles

Query Opportunity Roles in Marketo.

Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.

Select

Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

	SELECT * FROM OpportunityRoles WHERE externalOpportunityId='test2'
	SELECT * FROM OpportunityRoles WHERE ExternalOpportunityId IN ('[email protected]', '[email protected]')

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO OpportunityRoles (ExternalOpportunityId, LeadId, IsPrimary, Role) VALUES ('testOpportunitiesInsert', '12', false, 'Test')

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

	UPDATE OpportunityRoles SET IsPrimary=true WHERE MarketoGUID='c92c78dd-b869-40dc-bb2b-7cba112e8f50'
	UPDATE OpportunityRoles SET IsPrimary=false WHERE ExternalOpportunityId='testOpportunitiesInsert'
	UPDATE OpportunityRoles SET IsPrimary=false WHERE ExternalOpportunityId='testOpportunitiesInsert001' AND LeadId=12 AND Role='Test1'

Upsert

This table supports BATCH UPSERT when UseBulkAPI is set to false.

	UPSERT INTO OpportunityRoles (ExternalOpportunityId, LeadId, IsPrimary, Role) VALUES ('testOpportunitiesInsert001', '4', false, 'Test')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM OpportunityRoles WHERE ExternalOpportunityId='CDATA1'
	DELETE FROM OpportunityRoles WHERE LeadId IN (4, 6)
	DELETE FROM OpportunityRoles WHERE ExternalOpportunityId='CDATA1' AND LeadId=6 AND Role='MyRole2'

Columns


Name	Type	ReadOnly	Operators	Description
CreatedAt	Datetime	True
MarketoGUID [KEY]	String	True	=,IN
UpdatedAt	Datetime	True
ExternalCreatedDate	Datetime	False
ExternalOpportunityId	String	False	=,IN
IsPrimary	Bool	False
LeadId	Int	False	=,IN
Role	String	False

ProgramMembers

Query Program Members in Marketo.

UpdateLeadProgramStatus can be used to update the membership status of a lead.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

Note: The REST API throws an error if you query program members for a program with more than 100'000 members. You can set UseBulkAPI to 'true' or 'auto' to automatically use the BULK API to retrieve the records.

	SELECT * FROM ProgramMembers WHERE ProgramId=1001

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO ProgramMembers (ProgramId, LeadId, StatusName) VALUES ('1001', 4, 'member')

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

	UPDATE ProgramMembers SET WebinarURL='wsfldknfs1.com', RegistrationCode='adcff5f12-a7c7-11eb-bcbc-0242ac130001' WHERE LeadId='13' AND ProgramId='1001'
	UPDATE ProgramMembers SET WebinarURL='[email protected]/sync' WHERE ProgramId=1001 AND LeadId IN (28, 29, -2)
	UPDATE ProgramMembers SET WebinarURL='[email protected]/sync' WHERE ProgramId IN (1001, 1018) AND LeadId IN (12, 14)

Upsert

This table supports only BULK UPSERT when UseBulkAPI is set to true.

	UPSERT INTO OpportunityRoles (ExternalOpportunityId, LeadId, IsPrimary, Role) VALUES ('testOpportunitiesInsert001', '4', false, 'Test')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM ProgramMembers WHERE ProgramId=1001 AND LeadId=21
	DELETE FROM ProgramMembers WHERE ProgramId=1001 AND LeadId IN (28, 29, -2)
	DELETE FROM ProgramMembers WHERE ProgramId IN (1001, 1018) AND LeadId IN (12, 14, -2)
	DELETE FROM ProgramMembers WHERE ProgramId=1001 AND registrationCode='494164'

Columns


Name	Type	ReadOnly	Operators	Description
ProgramId [KEY]	Int	False	=	Id of the program.
LeadId [KEY]	Int	False		Id of the lead.
UpdatedAt	Datetime	True		Datetime the records was most recently updated.
IsExhausted	Bool	True
NurtureCadence	String	True
StatusName	String	False	=,IN
AttendanceLikelihood	Int	True
CreatedAt	Datetime	True
MembershipDate	Datetime	True
Program	String	True
ReachedSuccess	Bool	True	=,IN
ReachedSuccessDate	Datetime	True
RegistrationLikelihood	Int	True
TrackName	String	True
WaitlistPriority	Int	True
AcquiredBy	Bool	False
FlowStep	Int	False	=,IN
RegistrationCode	String	False
ReiNewCustomField	String	False	=,IN
StatusReason	String	False
Test99	Int	False	=,IN
TestCustomObjFd	String	False	=,IN
UTMSource	String	False	=,IN
WebinarUrl	String	False

Programs

Create, update, delete, and query Programs for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Programs WHERE Id=6201
	SELECT * FROM Programs WHERE Id IN (6201, 6200, 6152, 6117)
	SELECT * FROM Programs WHERE Name='duplicateProgramName'
	SELECT * FROM Programs WHERE WorkspaceName='test'
	SELECT * FROM Programs WHERE FolderId=48
	SELECT * FROM Programs WHERE FolderId=48 AND folderType='Folder'
	SELECT * FROM Programs WHERE UpdatedAt >' 2023-03-28T00:19:32.000-04:00'
	SELECT * FROM Programs WHERE UpdatedA >=' 2023-03-28T00:19:32.000-04:00'
	SELECT * FROM Programs WHERE UpdatedAt =' 2023-03-28T00:19:32.000-04:00'
	SELECT * FROM Programs WHERE UpdatedAt <=' 2023-03-28T00:19:32.000-04:00' AND UpdatedAt>'2021-08-11T08:10:01.000Z'
	SELECT * FROM Programs WHERE UpdatedAt < '2023-03-28T00:19:32.000-04:00' AND UpdatedAt>'2021-08-11T08:10:01.000Z'

Insert

Inserting a new program:

	INSERT INTO Programs (Name, FolderId, FolderType, Type, Description, Channel)
	VALUES ('test insert program', '6152', 'Program', 'Event', 'Test Insert Description', 'Tradeshow')

Update

Updating a program:

	UPDATE Programs SET Name='UpdatedProgram', Description='Updated Description' WHERE Id=6224

Delete

	DELETE FROM Programs WHERE Id=2383
	DELETE FROM Programs WHERE Name='Sample0034'
	DELETE FROM Programs WHERE ID IN (1064, 1065, 1066, 1067)
	DELETE FROM Programs WHERE Name IN ('Sample0035', 'Sample0036', 'Sample0037')

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=,IN	The unique, Marketo-assigned identifier of the program.
Name	String	False	=	The name of the program.
Description	String	False		The description of the program.
Type	String	False		The program type.
Channel	String	False		The channel the program is associated with.
WorkspaceName	String	True	=,IN	The name of the workspace where the program is located.
URL	String	True		The URL reference to the program.
Status	String	True		The status of the program.
FolderId	Int	False	=,IN	The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	False	=	The type of folder (Folder,Program)
CreatedAt	Datetime	True		Datetime the channel was created.
UpdatedAt	Datetime	True	=,>,<,>=,<=	Datetime the channel was most recently updated.

SalesPersons

Query Sales Persons in Marketo.

Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.

Select

Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

	SELECT * FROM SalesPersons WHERE ExternalSalesPersonId='test SalesPerson'
	SELECT * FROM SalesPersons WHERE Id=2520998
	SELECT * FROM SalesPersons WHERE Email='[email protected]'
	SELECT * FROM SalesPersons WHERE Email IN ('[email protected]', '[email protected]')

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO SalesPersons (ExternalSalesPersonId, Email, FirstName, LastName) VALUES ('testInsertSalesPersons001', '[email protected]', 'Sales', 'Person')

Update

This table supports BATCH UPDATE when UseBulkAPI is set to false.

	UPDATE SalesPersons SET Phone='800-123-4567', Title='Technical Sales', Email='[email protected]' WHERE ExternalSalesPersonId='testInsertSalesPersons001'

Upsert

This table supports BATCH UPSERT when UseBulkAPI is set to false.

	UPSERT INTO SalesPersons (ExternalSalesPersonId, Email, FirstName, LastName) VALUES ('testInsertSalesPersons123', '[email protected]', 'Sales', 'Person')

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM SalesPersons WHERE ExternalSalesPersonId='[email protected]'
	DELETE FROM SalesPersons WHERE ID='2521702'
	DELETE FROM SalesPersons WHERE ID IN (2521703, 2521704)
	DELETE FROM SalesPersons WHERE Email='[email protected]'
	DELETE FROM SalesPersons WHERE Email IN ('[email protected]', '[email protected]')

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=,IN
ExternalSalesPersonId	String	True	=,IN
Email	String	False	=,IN
Fax	String	False
FirstName	String	False
LastName	String	False
MobilePhone	String	False
Phone	String	False
Title	String	False
CreatedAt	Datetime	True
UpdatedAt	Datetime	True

SmartCampaigns

Query Smart Campaigns for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM SmartCampaigns WHERE IsActive='False'
	SELECT * FROM SmartCampaigns WHERE FolderId=5318 AND FolderType='Folder' AND IsActive='true'
	SELECT * FROM SmartCampaigns WHERE UpdatedAt >'2024-01-17T19:19:51Z'
	SELECT * FROM SmartCampaigns WHERE UpdatedAt >='2024-01-17T19:19:51Z'
	SELECT * FROM SmartCampaigns WHERE UpdatedAt <'2024-01-17T19:19:51Z'
	SELECT * FROM SmartCampaigns WHERE UpdatedAt <='2024-01-17T19:19:51Z'
	SELECT * FROM SmartCampaigns WHERE UpdatedAt = '2024-01-17T19:19:51Z'

Insert

	INSERT INTO SmartCampaigns (Name, FolderId, FolderType, Description)
    VALUES ('test insert smart campaign', '6152', 'Program', 'Test Insert Description')

Update

	UPDATE SmartCampaigns Set Name = 'UpdatedSmartCampaignName', Description = 'CData Campaign' WHERE Id = 1109

Delete

	DELETE FROM SmartCampaigns WHERE Id=1106
	DELETE FROM SmartCampaigns WHERE Name='JET - Test email link reports'
	DELETE FROM SmartCampaigns WHERE ID IN (1043, 5318)
	DELETE FROM SmartCampaigns WHERE Name IN ('TestCampaign1', 'RCM Success Only (v1) Known --> Engaged', 'Update Segmentation [1001](1001)')

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	Id of the smart campaign.
ParentProgramId	Int	True		The id of the parent program. Present if smart campaign is under program or nested folder
Name	String	False		Name of the smart campaign.
Description	String	False		Description of the smart campaign.
Type	String	True		The type of the the smart campaign. Batch: has at least one filter and no triggers. Trigger: has at least one trigger. Default: has no smart list rules.
ComputedUrl	String	True		The Computed Url of the Smart Campaign
Status	String	True		The status of the smart campaign.
IsSystem	Bool	True		Whether smart campaign is system managed.
IsActive	Bool	True	=	Whether smart campaign is active.
IsRequestable	Bool	True		Whether smart campaign is requestable (is active and contains 'Campaign is Requested' trigger with Source of 'Web Service API').
IsCommunicationLimitEnabled	Bool	True		Whether smart campaign communication limit is enabled (i.e. block non-operational emails).
MaxMembers	Int	True		The smart campaign membership limit.
SmartListId	Int	True		The Id of the smart campaign's child smart list.
FlowId	Int	True		The Id of the smart campaign's child flow.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderType	String	False	=	The type of folder (Folder,Program)
WorkspaceName	String	True		Name of the workspace the smart campaign is part of.
QualificationRuleType	String	True		The type of qualification rule.
QualificationRuleInterval	Int	True		The interval of qualification rule. Only set when qualificationRuleType is 'interval'
QualificationRuleUnit	String	True		The unit of measure of qualification rule. Only set when qualificationRuleType is 'interval' = ['hour', 'day', 'week', 'month']
RecurrenceStartAt	Datetime	True		The datetime of the first scheduled campaign to run. Required if setting recurrence. Not required to create a smart campaign that has no recurrence.
RecurrenceEndAt	Datetime	True		The datetime after which no further runs will be automatically scheduled.
RecurrenceIntervalType	String	True		The recurrence interval. Not required to create a smart campaign that has no recurrence = ['Daily', 'Weekly', 'Monthly'].
RecurrenceInterval	Int	True		The number of interval units between recurrences.
RecurrenceWeekDayOnly	Bool	True		Only run smart campaign on weekdays. May only be set if intervalType is 'Daily'.
RecurrenceWeekDayMask	String	True		String array of empty or one or more of 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'. May only be set if intervalType is 'Weekly'.
RecurrenceDayOfMonth	Int	True		The day of the month to recur. Permissible range 1-31. May only be set if intervalType is 'Monthly' and dayOfWeek and weekOfMonth are unset.
RecurrenceDayOfWeek	String	True		The day of the week to recur. May only be set if dayOfMonth is not set, and weekOfMonth is set = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'].
RecurrenceWeekOfMonth	Int	True		The week of the month to recur. Permissible range 1-4. May only be set if dayOfMonth is not set, and dayOfWeek is set.
CreatedAt	Datetime	True		Datetime the smart campaign was created.
UpdatedAt	Datetime	True	=,>,<,>=,<=	Datetime the smart campaign was most recently updated.

SmartLists

Query Smart Lists for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM SmartLists WHERE Id='1093'
	SELECT * FROM SmartLists WHERE Name='LeadSmartListTest'
	SELECT * FROM SmartLists WHERE FolderId=7
	SELECT * FROM SmartLists WHERE ProgramId=6116
	SELECT * FROM SmartLists WHERE SmartCampaignId=1043
	SELECT * FROM SmartLists WHERE UpdatedAt = '2021-02-02T08:26:01Z'
	SELECT * FROM SmartLists WHERE UpdatedAt > '2021-02-02T08:26:01Z'
	SELECT * FROM SmartLists WHERE UpdatedAt >= '2021-02-02T08:26:01Z'
	SELECT * FROM SmartLists WHERE UpdatedAt <' 2022-06-08T06:17:24Z'
	SELECT * FROM SmartLists WHERE UpdatedAt <=' 2022-06-08T06:17:24Z'

Delete

	DELETE FROM SmartLists WHERE Id=3991
	DELETE FROM SmartLists WHERE ID IN (3560, 1266, 3999)
	DELETE FROM SmartLists WHERE Name='TestProgram Opportunities'
	DELETE FROM SmartLists WHERE Name IN ('test_from_ui', 'JET - email tests')

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	False	=	Id of the smart list.
Name	String	False	=	Name of the smart list.
Description	String	False		Description of the smart list.
URL	String	False		The URL of the smart list in the Marketo UI
WorkspaceName	String	False		Name of the workspace the smart list is part of.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderType	String	False	=	The type of folder (Folder,Program)
CreatedAt	Datetime	False		Datetime the smart list was created.
UpdatedAt	Datetime	False	=,>,<,>=,<=	Datetime the smart list was most recently updated.
SmartCampaignId	Int	False	=	Mirror column that can be used only as a filter. Will retrieve SmartLists related to the given SmartCampaignId.
ProgramId	Int	False	=	Mirror column that can be used only as a filter. Will retrieve SmartLists related to the given email ProgramId.

Snippets

Create, update, delete and query snippets for a Marketo organization.

GetSnippetContent can be used to get the content of a snippet.

UpdateSnippetContent can be used to update the content of a snippet.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Snippets WHERE status='approved'
	SELECT * FROM Snippets WHERE Id='9'
	SELECT * FROM Snippets WHERE Id='9' AND Status='approved'

Insert

	INSERT INTO Snippets (Name, FolderId, FolderType, Description)
	VALUES ('test insert smart snippet', '31', 'Folder', 'Test Insert Description')

Update

	UPDATE Snippets SET Description='Testing Update', IsArchive='true', Name='Test Update' WHERE Id=12

Delete

	DELETE FROM Snippets WHERE Id=7
	DELETE FROM Snippets WHERE Name='My Snippet2'
	DELETE FROM Snippets WHERE ID IN (1, 9, 111)
	DELETE FROM Snippets WHERE Name IN ('My Snippet1', 'My Snippet11')

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	The unique, Marketo-assigned identifier of the snippet.
Status [KEY]	String	True	=	Status filter for draft or approved versions.
Name	String	False		The name of the snippet.
Description	String	False		The description of the snippet.
URL	String	True		The URL of the snippet in the Marketo UI.
WorkspaceName	String	True		Workspace name of the asset.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	False	=	The type of folder (Folder,Program)
CreatedAt	Datetime	True		Datetime the snippet was created.
UpdatedAt	Datetime	True		Datetime the snippet was most recently updated.

StaticListMembership

Query relations of static lists and leads in Marketo.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM StaticListMembership WHERE ListId='1014'
	SELECT * FROM StaticListMembership WHERE LeadId='4'

Other queries partialy server-side:

	SELECT * FROM StaticListMembership WHERE ListId IN (1014, 1044, 1057)
	SELECT * FROM StaticListMembership WHERE LeadId IN (4, 9999, 1199433)
	SELECT * FROM StaticListMembership WHERE ListId=1014 AND LeadId=1199433
	SELECT * FROM StaticListMembership WHERE ListId=1014 AND LeadId IN (4, 9999, 1199433, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)

Insert

This table supports BATCH INSERT when UseBulkAPI is set to false.

	INSERT INTO StaticListMemberShip (ListId, LeadId) VALUES (1014, 4)
	INSERT INTO StaticListMemberShip (ListId, LeadId) VALUES (1014, 4), (1014, 8), (1014, 12), (1014, 21)
	INSERT INTO StaticListMemberShip (ListId, LeadId) VALUES (1014, 4), (1014, 8), (1014, 12), (1014, 21), (1349, 4), (1349, 8), (1062, 8), (1349, 21), (1349, 22)

Delete

This table supports BATCH DELETE when UseBulkAPI is set to false.

	DELETE FROM StaticListMembership WHERE ListId=1057 AND LeadId=1083278
	DELETE FROM StaticListMembership WHERE ListId=1057 AND LeadId IN (1083292, 1083293, 1199432)
	DELETE FROM StaticListMembership WHERE ListId=1057
	DELETE FROM StaticListMembership WHERE LeadId=9999
	DELETE FROM StaticListMembership WHERE ListId IN (1057, 1568) AND LeadId IN (1083292, 1083293, 1199432, 1199433, 2521698)
	DELETE FROM StaticListMembership WHERE LeadId IN (1083292, 1083293, 1199432, 1199433, 2521698, 4, 5, 6, 7, 8, 9, 10)

Columns


Name	Type	ReadOnly	Operators	Description
ListId [KEY]	Int	False	=	Id of the static list.
LeadId [KEY]	Int	False	=	Id of the Lead.

StaticLists

Query Static Lists for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM StaticLists WHERE Id='1556'
	SELECT * FROM StaticLists WHERE Name='Anti-Smart List'
	SELECT * FROM StaticLists WHERE FolderId='12'
	SELECT * FROM StaticLists WHERE FolderType='Folder'
	SELECT * FROM StaticLists WHERE FolderId='6113' AND FolderType='Program'
	SELECT * FROM StaticLists WHERE UpdatedAt = '2024-01-17T14:31:26.000'
	SELECT * FROM StaticLists WHERE UpdatedAt > '2023-06-07T08:00:01.000'
	SELECT * FROM StaticLists WHERE UpdatedAt >= '2023-06-07T08:00:01.000'
	SELECT * FROM StaticLists WHERE UpdatedAt < '2023-06-07T08:00:01.000'
	SELECT * FROM StaticLists WHERE UpdatedAt <= '2023-06-07T08:00:01.000'
	SELECT * FROM StaticLists WHERE UpdatedAt >= '2022-09-01T14:08:37.000' AND UpdatedAt < '2023-10-06T10:43:02.000'

Insert

	INSERT INTO StaticLists (Name, FolderId, FolderType, Description) VALUES ('test insert StaticLists', '6152', 'Program', 'Test Insert Description')

Update

	UPDATE StaticLists Set Name = 'UpdatedStaticList', Description = 'CData StaticList' WHERE Id = 1570

Delete

	DELETE FROM StaticLists WHERE Id=1561
	DELETE FROM StaticLists WHERE Name='test'
	DELETE FROM StaticLists WHERE ID IN (1563, 1564, 1565, 111)
	DELETE FROM StaticLists WHERE Name IN ('test46AU1gBBg1', 'asd', 'testsDxzV3BAqn')

Columns


Name	Type	ReadOnly	Operators	Description
Id [KEY]	Int	True	=	Id of the static list.
Name	String	False	=	Name of the static list.
Description	String	False		Description of the static list.
ComputedURL	String	True		Computed URL of static list.
WorkspaceName	String	True		Name of the workspace the static list is part of.
FolderId	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String	True		The name of the folder
FolderType	String	False	=	The type of folder (Folder,Program)
CreatedAt	Datetime	True		Datetime the static list was created.
UpdatedAt	Datetime	True	=,>,<,>=,<=	Datetime the static list was most recently updated.

Tokens

Create, delete, and query Tokens for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Tokens WHERE folderId=70
	SELECT * FROM Tokens WHERE folderId=70 and FolderType='Folder'

Insert

	INSERT INTO Tokens (Name, Type, Value, FolderId, FolderType) VALUES ('test insert token', 'text', 'test token value', 5365, 'Folder')

Delete

	DELETE FROM Tokens WHERE FolderId=1111 AND FolderType='Program' AND Name='testname2' AND Type='text'
	DELETE FROM Tokens WHERE FolderId=1112 AND FolderType='Program' AND Name='test'
	DELETE FROM Tokens WHERE FolderId=1112

Columns


Name	Type	ReadOnly	Operators	Description
Name [KEY]	String	False		The name of the Token.
Type [KEY]	String	False		The data type of the Token. The supported values are date, number, rich text, score, sfdc campaign and text
Value	String	False		The value of the Token.
ComputedURL	String	False		The Computed URL of the Token.
FolderId [KEY]	Int	False	=	The unique, Marketo-assigned identifier of the parent folder/program.
FolderType [KEY]	String	False	=	The type of folder (Folder,Program)

Users

Query users for a Marketo organization.

Note: Insert queries are not supported. Users can be invited using the InviteUser stored procedure. Invited users can be retrieved using the GetInvitedUserById stored procedure. Invited users can be deleted using the DeleteInvitedUser stored procedure.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following queries are processed server-side:

	SELECT * FROM Users WHERE UserId='[email protected]'

Update

	UPDATE USERS SET EmailAddress='[email protected]', FirstName='updated', LastName='updated', ExpiresAt='2024-12-12T00:00:00-01:00' WHERE UserId='[email protected]'

Delete

	DELETE FROM USERS WHERE UserId='[email protected]'

Columns


Name	Type	ReadOnly	Operators	Description
UserId [KEY]	String	True	=	The user id in the form of an email address.
Id	Integer	True		The user identifier.
EmailAddress	String	False		The user's email address.
FirstName	String	False		The user's first name.
LastName	String	False		The user's last name.
APIOnly	Boolean	True		Whether the user is API-Only.
ExpiresAt	Datetime	False		The date and time when the user login expires.
LastLoginAt	Datetime	True		The date and time of user's most recent login.
FailedLogins	Integer	True		Count of user login failures.
FailedDeviceCode	Integer	True		Device code for user login failure.
IsLocked	Boolean	True		Whether the user account is locked.
LockedReason	String	True		Reason that user account is locked.
OptedIn	Boolean	True		Whether user has opted in.
UserWorkspaceRoles	String	True		Array of user roles and workspaces.

UserWorkspaceRoles

Query user roles for each workspace in Marketo.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

For example, the following query is processed server-side:

	SELECT * FROM UserWorkspaceRoles WHERE UserId='[email protected]'

Insert

	INSERT INTO UserWorkspaceRoles (UserId, WorkspaceId, AccessRoleId) VALUES ('[email protected]', 0, 1002)

Delete

	DELETE FROM UserWorkspaceRoles WHERE UserId='[email protected]' AND AccessRoleId=1002 AND WorkspaceId=0;

Columns


Name	Type	ReadOnly	Operators	Description
UserId [KEY]	String	False	=	The user id in the form of an email address.
AccessRoleId [KEY]	Integer	False		The user role id.
AccessRoleName	String	False		The user role name.
WorkspaceId [KEY]	Integer	False		The workspace id.
WorkspaceName	String	False		The workspace name.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Marketo Connector for CData Sync ビュー


Name	Description
Activities	Retrieve activities of different types after a specific datetime.
Activities_AddtoList	Add a person/record to a list
Activities_AddtoNurture	Add a lead to a nurture program
Activities_AddtoOpportunity	Add to an Opportunity
Activities_Asksquestionsinwebinar	Lead asks questions in a webinar event
Activities_Assetdownloadsinwebinar	Lead downloads file/asset in a webinar event
Activities_Calltoactionclickedinwebinar	Lead clicks on a Call to Action Link in a webinar event
Activities_CallWebhook	Call a Webhook
Activities_ChangeDataValue	Changed attribute value for a person/record
Activities_ChangeLeadPartition	Lead partition is changed for a lead
Activities_ChangeNurtureCadence	Change the nurture cadence for a lead
Activities_ChangeNurtureTrack	Change the nurture track for a lead
Activities_ChangeProgramMemberData	Change Program Member Data
Activities_ChangeRevenueStage	Modify the value of a revenue stage field
Activities_ChangeRevenueStageManually	Revenue stage is changed manually (e.g. Lead Database or Salesforce)
Activities_ChangeScore	Modify the value of a score field
Activities_ChangeSegment	Change segment (within a segmentation) for a lead
Activities_ChangeStatusinProgression	Change a Status in an program progression
Activities_ClickEmail	User clicks on a link in a Marketo Email
Activities_ClickLink	User clicks link on a page
Activities_ClickSalesEmail	User clicks on a link in a sales Email
Activities_CreateBuyingGroup	Create Buying Group
Activities_DeleteLead	Delete lead from Marketo database
Activities_EmailBounced	Marketo Email is bounced for a lead
Activities_EmailBouncedSoft	Campaign Email is bounced soft for a lead
Activities_EmailDelivered	Marketo Email is delivered to a lead/contact
Activities_EngagedwithaConversationalFlow	Lead engages with Dynamic Chat conversational flow
Activities_EngagedwithaDialogue	Lead engages with Dynamic Chat dialogue
Activities_EngagedwithanAgentinConversationalFlow	Lead engages with an Agent in Dynamic Chat conversational flow
Activities_EngagedwithanAgentinDialogue	Lead engages with an Agent in Dynamic Chat dialogue
Activities_ExecuteCampaign	Invoke an executable campaign
Activities_FillOutForm	User fills out and submits a form on web page
Activities_Hasattendedevent	Has attended event
Activities_InteractedwithDocumentinConversationalFlow	Lead interacts with a document in Dynamic Chat conversational flow
Activities_InteractedwithDocumentinDialogue	Lead interacts with a document in Dynamic Chat dialogue
Activities_MergeLeads	Merge two or more leads into a single record
Activities_NewLead	New person/record is added to the lead database
Activities_OpenEmail	User opens Marketo Email
Activities_OpenSalesEmail	User opens a sales Email
Activities_PushLeadtoMarketo	Generated schema file.
Activities_ReachedConversationalFlowGoal	Lead reaches a goal in Dynamic Chat conversational flow
Activities_ReachedDialogueGoal	Lead reaches a goal in Dynamic Chat dialogue
Activities_ReceivedForwardtoFriendEmail	User receives forwarded Email from friend
Activities_ReceiveSalesEmail	Receive Email using Sales View (Outlook Plugin)
Activities_RemovefromList	Remove this lead from a list
Activities_RemovefromOpportunity	Remove from an Opportunity
Activities_ReplytoSalesEmail	User replies to a sales email
Activities_RequestCampaign	Campaign membership is requested for lead
Activities_Respondedtoapollinwebinar	Lead responds to a poll in a webinar event
Activities_SalesEmailBounced	Sales Email bounced
Activities_ScheduledMeetinginConversationalFlow	Lead schedules an appointment in Dynamic Chat conversational flow
Activities_ScheduledMeetinginDialogue	Lead schedules an appointment in Dynamic Chat dialogue
Activities_SendAlert	Send alert Email about a lead
Activities_SendEmail	Send Marketo Email to a person
Activities_SendSalesEmail	Send Email using Sales View (Outlook Plugin)
Activities_SentForwardtoFriendEmail	User Forwards Email to a person/record
Activities_ShareContent	Share Content
Activities_UnsubscribeEmail	Person unsubscribed from Marketo Emails
Activities_UpdateOpportunity	Update an Opportunity
Activities_VisitWebpage	User visits a web page
ActivityTypes	Get available activity types.
ActivityTypesAttributes	Get available activity type attributes.
BulkExportJobs	Returns a list of bulk export jobs that were created in the past 7 days.
Campaigns	Query Campaigns for a Marketo organization.
ChannelProgressionStatuses	Query ProgressionStatuses of Channels for a Marketo organization.
Channels	Query Channels for a Marketo organization.
DailyErrorStatistics	Retrieve the count of each error users have encountered in the current day.
DailyUsageStatistics	Retrieve the number of API calls that specific users have consumed in the current day.
EmailCCFields	Query Emails CC Fields for a Marketo organization.
EmailTemplatesUsedBy	Query email records which depend on a given email template.
Files	Query files for a Marketo organization.
FolderContents	Query Folders contents for a Marketo organization.
LandingPageTemplateContent	Query landing page template contents for a Marketo organization.
LeadChanges	Query Lead changes.
LeadChangesAttributes	Query Lead changes attributes.
LeadChangesFields	Query fields of lead changes.
LeadPartitions	Query Lead Partitions for a Marketo organization.
LeadPrograms	Query program membership for leads.
Lists	Query Static Lists for a Marketo organization from the Leads API.
ListStaticMemberShip	Query leads of a static list in Marketo.
ProgramCosts	Query, insert and delete program cost relations for a Marketo organization.
ProgramTags	Query tags relations for a Marketo organization.
Roles	Query roles. Requires permissions: 'Access User Management Api' and 'Access Users'.
Segmentations	Query segmentations for a Marketo organization.
Segments	Query segments for a Marketo organization.
SmartListFilterConditions	Query filters of smart lists in a Marketo organization.
SmartListFilters	Query filters of smart lists in a Marketo organization.
SmartListTriggers	Query rules of smart lists in a Marketo organization.
TagAllowedValues	Query allowed values for tags in a Marketo organization.
Tags	Query tags for a Marketo organization.
ThankYouList	Query form thank you pages for a Marketo organization.
WeeklyErrorStatistics	Retrieve the count of each error users have encountered in the past 7 days.
WeeklyUsageStatistics	Retrieve the number of API calls that specific users have consumed in the past 7 days.
Workspaces	Retrieve workspaces. Requires permissions: 'Access User Management Api' and 'Access Users'.

Activities

Retrieve activities of different types after a specific datetime.

Each activity type in your Marketo organization is returned as a separate table. Each table name is prefixed with 'Activities_' followed by the name of the activity type. Activities are pushed as views. Custom activities are pushed as tables CustomActivities

All activities tables support BULK SELECT when UseBulkAPI is set to true.

Select

By default, this view retrieves all activity types from the creation of Marketo.

It is advised to provide a filter for ActivityTypeId and ActivityDate, or to make use of tables such as Activities_AddtoList, Activities_AddtoNurture, Activities_AddtoOpportunity, which are linked to a specific activity type.

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Activities WHERE ActivityDate > '2024-01-01T00:00:00Z'
	SELECT * FROM Activities WHERE ActivityDate >= ' 2024-01-01T00:00:00Z' AND ActivityDate <= '2024-03-01T00:00:00Z'
	SELECT * FROM Activities WHERE ListId = '1014' AND ActivityDate > '2024-01-01T00:00:00Z'
	SELECT * FROM Activities WHERE ListId = '1014' AND ActivityTypeId = '13'
	SELECT * FROM Activities WHERE ListId = '1014' AND ActivityTypeId = '13' AND ActivityDate > ' 2024-01-01T00:00:00Z'
	SELECT * FROM Activities WHERE ActivityTypeId = 24
	SELECT * FROM Activities WHERE ActivityTypeId IN (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13)

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
ActivityTypeId	Int	=,IN	Id of the activity type.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
PrimaryAttributeValueId	Int		Id of the primary attribute field.
PrimaryAttributeValue	String		Value of the primary attribute.
Attributes	String		JSON aggregate containing the list of attribute key value pair for this activity.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.

Activities_AddtoList

Add a person/record to a list

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListID	Int	=
ListIDValue	String
Source	String

Activities_AddtoNurture

Add a lead to a nurture program

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
TrackID	Int
TrackName	String

Activities_AddtoOpportunity

Add to an Opportunity

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
OpptyID	Int
OpptyIDValue	String
IsPrimary	Bool
Role	String

Activities_Asksquestionsinwebinar

Lead asks questions in a webinar event

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
Question	String
Questionwasanswered	Bool

Activities_Assetdownloadsinwebinar

Lead downloads file/asset in a webinar event

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
Downloadedasset	String

Activities_Calltoactionclickedinwebinar

Lead clicks on a Call to Action Link in a webinar event

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
Linkclicked	String

Activities_CallWebhook

Call a Webhook

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
Webhook	Int
WebhookValue	String
ErrorType	Int
Response	String

Activities_ChangeDataValue

Changed attribute value for a person/record

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
AttributeName	Int
AttributeNameValue	String
NewValue	String
OldValue	String
Reason	String
Source	String
APIMethodName	String
ModifyingUser	String
RequestId	String

Activities_ChangeLeadPartition

Lead partition is changed for a lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
NewPartitionID	Int
NewPartitionIDValue	String
OldPartitionID	Int
Reason	String

Activities_ChangeNurtureCadence

Change the nurture cadence for a lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
NewNurtureCadence	String
PreviousNurtureCadence	String

Activities_ChangeNurtureTrack

Change the nurture track for a lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
NewTrackID	Int
PreviousTrackID	Int
TrackName	String
PreviousTrackName	String

Activities_ChangeProgramMemberData

Change Program Member Data

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
AttributeName	Int
NewValue	String
OldValue	String
Reason	String
Source	String
AttributeDisplayName	String

Activities_ChangeRevenueStage

Modify the value of a revenue stage field

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ModelID	Int
ModelIDValue	String
NewStageID	Int
OldStageID	Int
SLAExpiration	Datetime
Reason	String
NewStage	String
OldStage	String

Activities_ChangeRevenueStageManually

Revenue stage is changed manually (e.g. Lead Database or Salesforce)

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
PrimaryAttributeValueId	Int		Id of the primary attribute field.
PrimaryAttributeValue	String		Value of the primary attribute.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.

Activities_ChangeScore

Modify the value of a score field

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ScoreName	Int
ScoreNameValue	String
ChangeValue	String
NewValue	Int
OldValue	Int
Reason	String

Activities_ChangeSegment

Change segment (within a segmentation) for a lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
SegmentationID	Int
SegmentationIDValue	String
NewSegmentID	Int

Activities_ChangeStatusinProgression

Change a Status in an program progression

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
NewStatusID	Int
OldStatusID	Int
Reason	String
AcquiredBy	Bool
Success	Bool
ProgramMemberID	Int
ReachedSuccessDate	Datetime
StatusReason	String
WebinarURL	String
RegistrationCode	String
NewStatus	String
OldStatus	String

Activities_ClickEmail

User clicks on a link in a Marketo Email

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int
Link	String
TestVariant	Int
LinkID	String
IsMobileDevice	Bool
Device	String
Platform	String
UserAgent	String
CampaignRunID	Int
IsPredictive	Bool
IsBotActivity	Bool
BotActivityPattern	String
Browser	String

Activities_ClickLink

User clicks link on a page

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
LinkID	Int
LinkIDValue	String
WebpageID	Int
QueryParameters	String
ClientIPAddress	String
ReferrerURL	String
UserAgent	String
Browser	String
Platform	String
Device	String

Activities_ClickSalesEmail

User clicks on a link in a sales Email

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ArtifactID	Int
ArtifactIDValue	String
Sentby	String
Link	String
TemplateID	Int
CampaignRunID	Int
IsPredictive	Bool
Source	String
SalesTemplateURL	String
SalesCampaignURL	String
SalesTemplateName	String
SalesCampaignName	String
MarketoSalesPersonID	Int
SalesEmailURL	String
IsBotActivity	Bool
BotActivityPattern	String

Activities_CreateBuyingGroup

Create Buying Group

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
PrimaryAttributeValueId	Int		Id of the primary attribute field.
PrimaryAttributeValue	String		Value of the primary attribute.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
BuyingGroupId	Int
BuyingGroupTemplateId	Int
SolutionInterestId	Int
MarketoGUID	Int

Activities_DeleteLead

Delete lead from Marketo database

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
LeadIDValue	String
RemovefromCRM	Bool
APIMethodName	String
ModifyingUser	String
RequestId	String

Activities_EmailBounced

Marketo Email is bounced for a lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int
Category	String
Details	String
Subcategory	String
Email	String
TestVariant	Int
CampaignRunID	Int
HasPredictive	Bool
Browser	String
Platform	String
Device	String
UserAgent	String

Activities_EmailBouncedSoft

Campaign Email is bounced soft for a lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int
Category	String
Details	String
Subcategory	String
Email	String
TestVariant	Int
CampaignRunID	Int
HasPredictive	Bool
Browser	String
Platform	String
Device	String
UserAgent	String

Activities_EmailDelivered

Marketo Email is delivered to a lead/contact

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int
TestVariant	Int
CampaignRunID	Int
HasPredictive	Bool
Browser	String
Platform	String
Device	String
UserAgent	String

Activities_EngagedwithaConversationalFlow

Lead engages with Dynamic Chat conversational flow

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ConversationalFlowID	Int
ConversationalFlowIDValue	String
ConversationalFlowName	String
PageURL	String
ConversationStatus	String
ConversationTranscript	String
ConversationSummary	String
SourceType	String
SourceName	String
InteractedUIType	String
Language	String
Workspace	String
DiscussedTopics	String
ConversationScore	Int

Activities_EngagedwithaDialogue

Lead engages with Dynamic Chat dialogue

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
DialogueID	Int
DialogueIDValue	String
DialogueName	String
PageURL	String
ConversationStatus	String
ConversationTranscript	String
ConversationSummary	String
Language	String
Workspace	String
DiscussedTopics	String
ConversationScore	Int

Activities_EngagedwithanAgentinConversationalFlow

Lead engages with an Agent in Dynamic Chat conversational flow

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ConversationalFlowID	Int
ConversationalFlowIDValue	String
ConversationalFlowName	String
PageURL	String
AgentID	Int
AgentEmail	String
AgentName	String
RoutingQueueID	Int
RoutingQueueType	String
RoutingQueueName	String
ConversationTranscript	String
ConversationSummary	String
ConversationStatus	String
DiscussedTopics	String
ConversationScore	Int

Activities_EngagedwithanAgentinDialogue

Lead engages with an Agent in Dynamic Chat dialogue

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
DialogueID	Int
DialogueIDValue	String
DialogueName	String
PageURL	String
AgentID	Int
AgentEmail	String
AgentName	String
RoutingQueueID	Int
RoutingQueueType	String
RoutingQueueName	String
ConversationTranscript	String
ConversationSummary	String
ConversationStatus	String
DiscussedTopics	String
ConversationScore	Int

Activities_ExecuteCampaign

Invoke an executable campaign

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
CampaignIDValue	String
Qualified	Bool
UsedParentCampaignTokenContext	Bool
TokenContextCampaignID	Int

Activities_FillOutForm

User fills out and submits a form on web page

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
WebformID	Int
WebformIDValue	String
FormFields	String
WebpageID	Int
QueryParameters	String
ClientIPAddress	String
ReferrerURL	String
UserAgent	String
Browser	String
Platform	String
Device	String

Activities_Hasattendedevent

Has attended event

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
Numberofpollresponses	Int
Numberofansweredquestions	Int
Numberofunansweredquestions	Int
Livewatchtimebypercent	Int
NumberofCTAsclicked	Int
Numberofassetsdownloaded	Int
EventMode	String
Watchdurationinminutes	Int
WatchedDate	Datetime

Activities_InteractedwithDocumentinConversationalFlow

Lead interacts with a document in Dynamic Chat conversational flow

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
DocumentID	Int
DocumentIDValue	String
DocumentName	String
DocumentURL	String
ConversationalFlowID	Int
ConversationalFlowName	String
PageURL	String
DocumentOpened	Bool
DocumentDownloaded	Bool
SearchTerms	String
Language	String
Workspace	String

Activities_InteractedwithDocumentinDialogue

Lead interacts with a document in Dynamic Chat dialogue

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
DocumentID	Int
DocumentIDValue	String
DocumentName	String
DocumentURL	String
DialogueID	Int
DialogueName	String
PageURL	String
DocumentOpened	Bool
DocumentDownloaded	Bool
SearchTerms	String
Language	String
Workspace	String

Activities_MergeLeads

Merge two or more leads into a single record

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
LeadIDValue	String
MergeIDs	String
MasterUpdated	Bool
MergedinSales	Bool
MergeSource	String
APIMethodName	String
ModifyingUser	String
RequestId	String

Activities_NewLead

New person/record is added to the lead database

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
PrimaryAttributeValueId	Int		Id of the primary attribute field.
PrimaryAttributeValue	String		Value of the primary attribute.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
SourceType	String
FormName	String
ListName	String
SFDCType	String
LeadSource	String
CreatedDate	Date
APIMethodName	String
ModifyingUser	String
RequestId	String

Activities_OpenEmail

User opens Marketo Email

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int
TestVariant	Int
IsMobileDevice	Bool
Device	String
Platform	String
UserAgent	String
CampaignRunID	Int
HasPredictive	Bool
IsBotActivity	Bool
BotActivityPattern	String
Browser	String

Activities_OpenSalesEmail

User opens a sales Email

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ArtifactID	Int
ArtifactIDValue	String
Sentby	String
TemplateID	Int
CampaignRunID	Int
HasPredictive	Bool
Source	String
SalesTemplateURL	String
SalesCampaignURL	String
SalesTemplateName	String
SalesCampaignName	String
MarketoSalesPersonID	Int
SalesEmailURL	String
IsBotActivity	Bool
BotActivityPattern	String

Activities_PushLeadtoMarketo

Generated schema file.

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
Source	String
Reason	String
APIMethodName	String
ModifyingUser	String
RequestId	String

Activities_ReachedConversationalFlowGoal

Lead reaches a goal in Dynamic Chat conversational flow

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ConversationalFlowID	Int
ConversationalFlowIDValue	String
GoalName	String
ConversationalFlowName	String
PageURL	String
Language	String
Workspace	String

Activities_ReachedDialogueGoal

Lead reaches a goal in Dynamic Chat dialogue

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
DialogueID	Int
DialogueIDValue	String
GoalName	String
PageURL	String
DialogueName	String
Language	String
Workspace	String

Activities_ReceivedForwardtoFriendEmail

User receives forwarded Email from friend

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int

Activities_ReceiveSalesEmail

Receive Email using Sales View (Outlook Plugin)

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ArtifactID	Int
ArtifactIDValue	String
Receivedby	String
Source	String

Activities_RemovefromList

Remove this lead from a list

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListID	Int	=
ListIDValue	String
Source	String

Activities_RemovefromOpportunity

Remove from an Opportunity

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
OpptyID	Int
OpptyIDValue	String
IsPrimary	Bool
Role	String

Activities_ReplytoSalesEmail

User replies to a sales email

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ArtifactID	Int
ArtifactIDValue	String
Sentby	String
TemplateID	Int
CampaignRunID	Int
HasPredictive	Bool
Source	String
SalesTemplateURL	String
SalesCampaignURL	String
SalesTemplateName	String
SalesCampaignName	String
MarketoSalesPersonID	Int
SalesEmailURL	String

Activities_RequestCampaign

Campaign membership is requested for lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
CampaignIDValue	String
Source	String

Activities_Respondedtoapollinwebinar

Lead responds to a poll in a webinar event

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ProgramID	Int
ProgramIDValue	String
Pollquestion	String
Pollresponse	String

Activities_SalesEmailBounced

Sales Email bounced

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ArtifactID	Int
ArtifactIDValue	String
Sentby	String
Category	String
Details	String
Subcategory	String
Email	String
CampaignRunID	Int
HasPredictive	Bool
TemplateID	Int
MarketoSalesPersonID	Int
Source	String

Activities_ScheduledMeetinginConversationalFlow

Lead schedules an appointment in Dynamic Chat conversational flow

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
AgentID	Int
AgentIDValue	String
AgentEmail	String
AgentName	String
ConversationalFlowID	Int
ConversationalFlowName	String
PageURL	String
MeetingStatus	String
ScheduledFor	Datetime
RoutingQueueID	Int
RoutingQueueType	String
RoutingQueueName	String

Activities_ScheduledMeetinginDialogue

Lead schedules an appointment in Dynamic Chat dialogue

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
AgentID	Int
AgentIDValue	String
AgentEmail	String
AgentName	String
DialogueID	Int
DialogueName	String
PageURL	String
MeetingStatus	String
ScheduledFor	Datetime
RoutingQueueID	Int
RoutingQueueType	String
RoutingQueueName	String

Activities_SendAlert

Send alert Email about a lead

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
SendToOwner	String
SendToSmartList	String
SendToList	String

Activities_SendEmail

Send Marketo Email to a person

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int
TestVariant	Int
CampaignRunID	Int
HasPredictive	Bool
Browser	String
Platform	String
Device	String
UserAgent	String

Activities_SendSalesEmail

Send Email using Sales View (Outlook Plugin)

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
ArtifactID	Int
ArtifactIDValue	String
Sentby	String
TemplateID	Int
CampaignRunID	Int
HasPredictive	Bool
Source	String
SalesTemplateURL	String
SalesCampaignURL	String
SalesTemplateName	String
SalesCampaignName	String
MarketoSalesPersonID	Int
SalesEmailURL	String

Activities_SentForwardtoFriendEmail

User Forwards Email to a person/record

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
StepID	Int
ChoiceNumber	Int

Activities_ShareContent

Share Content

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
SocialAppID	Int
SocialAppIDValue	String
WebpageID	Int
SocialNetwork	String
SocialAppTypeID	Int
ShareMessage	String

Activities_UnsubscribeEmail

Person unsubscribed from Marketo Emails

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
MailingID	Int
MailingIDValue	String
WebpageID	Int
QueryParameters	String
ClientIPAddress	String
ReferrerURL	String
UserAgent	String
WebformID	Int
FormFields	String
TestVariant	Int
CampaignRunID	Int
HasPredictive	Bool
Browser	String
Platform	String
Device	String

Activities_UpdateOpportunity

Update an Opportunity

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
OpptyID	Int
OpptyIDValue	String
DataValueChanges	String
AttributeName	String
NewValue	String
OldValue	String

Activities_VisitWebpage

User visits a web page

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.
WebpageID	Int
WebpageIDValue	String
WebpageURL	String
QueryParameters	String
ClientIPAddress	String
ReferrerURL	String
UserAgent	String
SearchEngine	String
SearchQuery	String
Token	String
Browser	String
Platform	String
Device	String

ActivityTypes

Get available activity types.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM ActivityTypes WHERE Id=123

Columns


Name	Type	Operators	Description
Id [KEY]	Int		The unique, Marketo-assigned identifier of the Activity type.
Name	String		The name of the Activity type.
Description	String		The description of the Activity type.
PrimaryAttributeName	String		The name of the primary attribute.
PrimaryAttributeDatatype	String		The data type of the primary attribute.
Attributes	String		The activity attributes JSON aggregate.

ActivityTypesAttributes

Get available activity type attributes.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM ActivityTypesAttributes WHERE ActivityTypeId=123

Columns


Name	Type	Operators	Description
ActivityTypeId [KEY]	Int		The unique, Marketo-assigned identifier of the activity type.
ActivityName	String		The name of the activity type.
AttributeName [KEY]	String		The name of the attribute.
AttributeDataType	String		The data type of the attribute.

BulkExportJobs

Returns a list of bulk export jobs that were created in the past 7 days.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM BulkExportJobs WHERE Table='Leads'
	SELECT * FROM BulkExportJobs WHERE Table='Leads' AND Status='Created'

Columns


Name	Type	Operators	Description
ExportId [KEY]	String		Unique id of the export job.
Table [KEY]	String	=	Name of the table the export job was created for. Can be Activities, Leads, ProgramMembers or any CustomObject_ table.
Status	String	=	The status of the export.
Format	String		The format of the file.
CreatedAt	Datetime		The date when the export request was created.
QueuedAt	Datetime		The queue time of the export job. This column will have a value only when 'Queued' status is reached.
StartedAt	Datetime		The start time of the export job. This column will have a value only when 'Processing' status is reached.
FinishedAt	Datetime		The finish time of export job. This column will have a value only when status is 'Completed' or 'Failed'.
FileSize	Long		The size of file in bytes. This column will have a value only when status is 'Completed'.
FileChecksum	String		The checksum of the generated file.
NumberOfRecords	Long		The number of records in the export file. This column will have a value only when the status is 'Completed'.
ErrorMessage	String		The error message in case of failed status.

Campaigns

Query Campaigns for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Campaigns WHERE Id='1037'
	SELECT * FROM Campaigns WHERE Id IN (1037, 1055, 1058)
	SELECT * FROM Campaigns WHERE Name='TestCampaign1'
	SELECT * FROM Campaigns WHERE Name='test' AND WorkspaceName='Default'
	SELECT * FROM Campaigns WHERE ProgramName='Program6'

Columns


Name	Type	Operators	Description
Id [KEY]	Int	=,IN	The unique, Marketo-assigned identifier of the campaign.
Name	String	=,IN	The name of the campaign.
Description	String		The description of the campaign.
Type	String		The campaign type.
ProgramId	Int		The Id of the program associated with the campaign.
ProgramName	String	=,IN	The name of the program associated with the campaign.
WorkspaceName	String	=,IN	The name of the workspace associated with the campaign.
Active	Bool		Identifies whether the campaign is active.
CreatedAt	Datetime		The date and time the campaign was created.
UpdatedAt	Datetime		The date and time the campaign was last updated.

ChannelProgressionStatuses

Query ProgressionStatuses of Channels for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM ChannelProgressionStatuses WHERE ChannelName='Online Advertising'

Other queries:

	SELECT * FROM ChannelProgressionStatuses WHERE ChannelName IN (SELECT Channel FROM Programs WHERE id=1010)

Columns


Name	Type	Operators	Description
ChannelName [KEY]	String	=	The name of the channel.
Name [KEY]	String		Name of the status.
Description	String		Description of the program status.
Hidden	Bool		Whether the status has been hidden.
Type	String		Type of the status.
Step	Int		Step number of the status.
Success	Bool		Whether this status is a success step for program members.

Channels

Query Channels for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Channels WHERE Name='Online Advertising'

Columns


Name	Type	Operators	Description
Id [KEY]	Int		The unique, Marketo-assigned identifier of the channel.
Name	String	=	The name of the channel.
ApplicableProgramType	String		The type of program that the channel is used for.
CreatedAt	Datetime		The date and time the channel was created.
UpdatedAt	Datetime		The date and time the channel was last updated.
ProgressionStatuses	String		JSON array of progression statuses aggregates. Additionally exposed as the separate table ChannelProgressionStatuses.

DailyErrorStatistics

Retrieve the count of each error users have encountered in the current day.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM DailyErrorStatistics WHERE ErrorCode='610'

Columns


Name	Type	Operators	Description
Date	Date		The date when the error was encountered.
ErrorCode	String		The error code.
Count	Int		The error count for the particular error code.

DailyUsageStatistics

Retrieve the number of API calls that specific users have consumed in the current day.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM DailyUsageStatistics WHERE UserId='User123'

Columns


Name	Type	Operators	Description
Date	Date		The date when the API Calls were made.
UserId	String		The ID of the user.
Count	Int		The individual count for the user.

EmailCCFields

Query Emails CC Fields for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM EmailCCFields WHERE AttributeId='attribute_123'

Columns


Name	Type	Operators	Description
AttributeId [KEY]	String		The attribute identifier.
ObjectName	String		Object name. Lead or Company.
DisplayName	String		The display name.
ApiName	String		The API name.

EmailTemplatesUsedBy

Query email records which depend on a given email template.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM EmailTemplatesUsedBy WHERE EmailTemplateId=1

Columns


Name	Type	Operators	Description
EmailTemplateId [KEY]	Int	=	The id of the email template.
Id [KEY]	Int		The id of the email that uses the email template.
Name	String		The name of the email.
Type	String		The type of the asset.
Status	String		The status of the email.
UpdatedAt	Datetime		The update date time of the email.

Files

Query files for a Marketo organization.

CreateFile can be used to upload a file.

UpdateFile can be used to update the file content.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Files WHERE id='421'
	SELECT * FROM Files WHERE Name='CData.png'
	SELECT * FROM Files WHERE FolderId='34'
	SELECT * FROM Files WHERE FolderId='34' AND ParentType='Folder'

Columns


Name	Type	Operators	Description
Id [KEY]	Int	=	The unique, Marketo-assigned identifier of the file.
Name	String	=	The name of the file.
Description	String		Description of the file.
FolderId	Int	=	The unique, Marketo-assigned identifier of the folder.
FolderName	String		The Name of the folder
FolderType	String		The type of folder (Folder,Program)
MimeType	String		MIME type of the file
Size	Int		Size of the file in bytes
URL	String		The explicit URL of the asset in the designated instance.
CreatedAt	Datetime		The date and time the folder was created.
UpdatedAt	Datetime		The date and time the folder was last updated.
ParentType	String	=	Mirror column used as server side filter for the type of the parent folder. Will be ignored when filtering by Id or Name.

FolderContents

Query Folders contents for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM FolderContents WHERE FolderId=12
	SELECT * FROM FolderContents WHERE FolderId=12 AND FolderType='Folder'

Columns


Name	Type	Operators	Description
Id [KEY]	Int		The marketo-assigned identifier of the folder content.
Type	String		The type of the folder content.
FolderId	Int	=	The unique, Marketo-assigned identifier of the folder.
FolderType	String	=	The type of the folder. Folder or Program, defaults to Folder.

LandingPageTemplateContent

Query landing page template contents for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

UpdateLandingPageTemplateContent can be used to update the Landing Page Template Content.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateId=1 AND LandingPageTemplateStatus='approved'
	SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateId IN (1, 1005) AND LandingPageTemplateStatus IN ('draft', 'approved')
	SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateId IN (1, 1005)
	SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateStatus='draft'
	SELECT * FROM LandingPageTemplateContent

Columns


Name	Type	Operators	Description
LandingPageTemplateId [KEY]	Int	=	The unique, Marketo-assigned identifier of the landing page template.
LandingPageTemplateStatus [KEY]	String	=	Status of the landing page template, draft or approved versions.
Content	String		HTML content of the landing page template.
EnableMunchkin	Bool		Whether to enable munchkin on the derived pages. Defaults to true.
TemplateType	String		Type of template.

LeadChanges

Query Lead changes.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM LeadChanges WHERE ActivityDate = '2024-02-02 08:15:10.0'
	SELECT * FROM LeadChanges WHERE ActivityDate > '2024-01-17T14:32:21'
	SELECT * FROM LeadChanges WHERE ActivityDate >= '2024-01-17T14:32:21'
	SELECT * FROM LeadChanges WHERE ActivityDate > '2024-01-17T14:32:21' AND ActivityDate < '2024-02-17T14:32:21'
	SELECT * FROM LeadChanges WHERE LeadId IN (4, 14454)
	SELECT * FROM LeadChanges WHERE ListId = 1014
	SELECT * FROM LeadChanges WHERE ListId = 1014 AND ActivityDate > '2023-06-14T14:13:27Z'
	SELECT * FROM LeadChanges WHERE LeadId = 9 AND ActivityDate > '2023-06-14T14:13:27Z'

Use LeadFields to specify the Lead columns from which you want to retrieve changes. Defaults to all columns. Retrieve column names from SYS_TABLECOLUMNS and provide them as comma-separated values.

SELECT * FROM LeadChanges WHERE LeadFields = 'mobilePhone'
SELECT * FROM LeadChanges WHERE LeadId = 4 AND LeadFields = 'mobilePhone'

Columns


Name	Type	Operators	Description
ActivityId [KEY]	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
ActivityTypeId	Int		Id of the activity type.
LeadId	Int	=,IN	Id of the lead associated to the activity.
CampaignId	Int		Id of the associated Smart Campaign, if applicable.
Attributes	String		JSON aggregate containing the list of attribute key value pair for this activity.
Fields	String		JSON aggregate containing a list of changes made to lead fields.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LeadFields	String	Mirror column used to specify Lead columns for which you want to retrieve changes for. Defaults to all columns. Column names can be retrieved from SYS_TABLECOLUMNS. SELECT [ColumnName] FROM SYS_TABLECOLUMNS WHERE TableName='leads' and should be provided as comma separated values.

LeadChangesAttributes

Query Lead changes attributes.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM LeadChangesAttributes WHERE ActivityDate = '2024-02-02 08:15:10.0'
	SELECT * FROM LeadChangesAttributes WHERE ActivityDate > '2024-01-17T14:32:21'
	SELECT * FROM LeadChangesAttributes WHERE ActivityDate >= '2024-01-17T14:32:21'
	SELECT * FROM LeadChangesAttributes WHERE ActivityDate > '2024-01-17T14:32:21' AND ActivityDate < '2024-02-17T14:32:21'
	SELECT * FROM LeadChangesAttributes WHERE LeadId IN (4, 14454)
	SELECT * FROM LeadChangesAttributes WHERE ListId = 1014
	SELECT * FROM LeadChangesAttributes WHERE ListId = 1014 AND ActivityDate > '2023-06-14T14:13:27Z'
	SELECT * FROM LeadChangesAttributes WHERE LeadId = 9 AND ActivityDate > '2023-06-14T14:13:27Z'

Use LeadFields to specify the Lead columns from which you want to retrieve changes. Defaults to all columns. Retrieve column names from SYS_TABLECOLUMNS and provide them as comma-separated values.

SELECT * FROM LeadChangesAttributes WHERE LeadFields = 'mobilePhone'
SELECT * FROM LeadChangesAttributes WHERE LeadId = 4 AND LeadFields = 'mobilePhone'

Columns


Name	Type	Operators	Description
ActivityId	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
ActivityTypeId	Int		Id of the activity type.
LeadId	Int	=,IN	Id of the lead associated to the activity.
AttributeAPIName	String		API Name of the attribute
AttributeName	String		Name of the attribute
AttributeValue	String		Value of the attribute
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LeadFields	String	Mirror column used to specify Lead columns for which you want to retrieve changes for. Defaults to all columns. Column names can be retrieved from SYS_TABLECOLUMNS. SELECT [ColumnName] FROM SYS_TABLECOLUMNS WHERE TableName='leads' and should be provided as comma separated values.

LeadChangesFields

Query fields of lead changes.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM LeadChangesFields WHERE ActivityDate = '2024-02-02 08:15:10.0'
	SELECT * FROM LeadChangesFields WHERE ActivityDate > '2024-01-17T14:32:21'
	SELECT * FROM LeadChangesFields WHERE ActivityDate >= '2024-01-17T14:32:21'
	SELECT * FROM LeadChangesFields WHERE ActivityDate > '2024-01-17T14:32:21' AND ActivityDate < '2024-02-17T14:32:21'
	SELECT * FROM LeadChangesFields WHERE LeadId IN (4, 14454)
	SELECT * FROM LeadChangesFields WHERE ListId = 1014
	SELECT * FROM LeadChangesFields WHERE ListId = 1014 AND ActivityDate > '2023-06-14T14:13:27Z'
	SELECT * FROM LeadChangesFields WHERE LeadId = 9 AND ActivityDate > '2023-06-14T14:13:27Z'

Use LeadFields to specify the Lead columns from which you want to retrieve changes. Defaults to all columns. Retrieve column names from SYS_TABLECOLUMNS and provide them as comma-separated values.

SELECT * FROM LeadChangesFields WHERE LeadFields = 'mobilePhone'
SELECT * FROM LeadChangesFields WHERE LeadId = 4 AND LeadFields = 'mobilePhone'

Columns


Name	Type	Operators	Description
ActivityId	String		Unique id of the activity.
ActivityDate	Datetime	>,>=,=,<,<=	Datetime of the activity.
ActivityTypeId	Int		Id of the activity type.
LeadId	Int	=,IN	Id of the lead associated to the activity.
LeadChangeFieldId	Int		Unique integer id of the change record.
LeadChangeFieldName	String		Name of the field which was changed.
LeadChangeFieldNewValue	String		New value after the change.
LeadChangeFieldOldValue	String		Old value before the change.
ListId	Int	=	Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LeadFields	String	Mirror column used to specify Lead columns for which you want to retrieve changes for. Defaults to all columns. Column names can be retrieved from SYS_TABLECOLUMNS. SELECT [ColumnName] FROM SYS_TABLECOLUMNS WHERE TableName='leads' and should be provided as comma separated values.

LeadPartitions

Query Lead Partitions for a Marketo organization.

UpdateLeadPartition can be used to update the partition of a lead.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM LeadPartitions WHERE Id=123

Columns


Name	Type	Operators	Description
Id [KEY]	Int		The unique, Marketo-assigned identifier of the lead partition.
Name	String		The name of the partition.
Description	String		The description of the partition.

LeadPrograms

Query program membership for leads.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side. If no LeadId filter is specified, this table queries all available LeadIds. This process is time-consuming because querying the Leads table is resource-intensive.

	SELECT * FROM LeadPrograms WHERE LeadId=4

Columns


Name	Type	Operators	Description
LeadId [KEY]	Int	=	The Marketo lead id.
ProgramId [KEY]	Int		Unique integer id of a program record.
ProgressionStatus	String		Program status of the lead in the parent program.
ProgressionStatusType	String		Program status Type of the lead in the parent program.
IsExhausted	Bool		Whether the lead is currently exhausted in the stream, if applicable.
AcquiredBy	Bool		Whether the lead was acquired by the parent program.
ReachedSuccess	Bool		Whether the lead is in a success-status in the parent program.
MembershipDate	Datetime		Date the lead first became a member of the program.
UpdatedAt	Datetime		Datetime when the program was most recently updated.

Lists

Query Static Lists for a Marketo organization from the Leads API.

This table contains the same records as StaticLists, however it has different columns and server-side filters that might be of use since the tables are retrieved from differnt API endpoints.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Lists WHERE Id=1556
	SELECT * FROM Lists WHERE Id IN (1556, 1057)
	SELECT * FROM Lists WHERE Name='test0319'
	SELECT * FROM Lists WHERE ProgramName='ImportTest0407'
	SELECT * FROM Lists WHERE WorkspaceName='Default' AND Id=1014

Columns


Name	Type	Operators	Description
Id [KEY]	Int	=,IN	Id of the static list.
Name	String	=,IN	Name of the static list.
Description	String		Description of the static list.
ProgramName	String	=,IN	Name of the program.
WorkspaceId	Int		WorkspaceId of the static list.
WorkspaceName	String	=,IN	Name of the workspace the static list is part of.
CreatedAt	Datetime		Datetime the static list was created.
UpdatedAt	Datetime		Datetime the static list was most recently updated.

ListStaticMemberShip

Query leads of a static list in Marketo.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.

	SELECT * FROM ListStaticMemberShip WHERE ListId=123

Columns

Operators Description Int = Id of the static list. Int String =,IN Int String Decimal String String String String String String Bool String String String Int String =,IN String Datetime String =,IN String =,IN Date String =,IN Bool String String String =,IN Bool String Bool Datetime String =,IN String =,IN String =,IN String String String String String String String String String String String String String String String String Bool Bool String String String String String String Int =,IN Int Int Int String Int String String String Bool String String Datetime String String Bool Bool String =,IN String String Int String String String String String String Int =,IN Int String String String String Int String String String Int Int String String String String String =,IN Bool String =,IN Bool String =,IN String =,IN Bool Int =,IN String =,IN String Bool String String String String String String String Datetime Double String =,IN String />


Name	Type style="white-space:nowrap">ListId style="white-space:nowrap">Id	The lead Id. style="white-space:nowrap">AcmeAccessCode
AcquisitionProgramId
Address
AnnualRevenue
AnonymousIP
BillingCity
BillingCountry
BillingPostalCode
BillingState
BillingStreet
BlackListed
BlackListedCause
City
Company
ContactCompany
Cookies
Country
CreatedAt
Cstmfdtest1
Cstmfdtest2
DateOfBirth
Department
DoNotCall
DoNotCallReason
Ecids
Email
EmailInvalid
EmailInvalidCause
EmailSuspended
EmailSuspendedAt
EmailSuspendedCause
ExternalCompanyId
ExternalSalesPersonId
Fax
FirstName
FirstUTMCampaign
FirstUTMContent
FirstUTMMedium
FirstUTMSource
FirstUTMTerm
GdprMailableStatus
Industry
InferredCity
InferredCompany
InferredCountry
InferredMetropolitanArea
InferredPhoneAreaCode
InferredPostalCode
InferredStateRegion
IsAnonymous
IsLead
LastName
LatestUTMCampaign
LatestUTMContent
LatestUTMMedium
LatestUTMSource
LatestUTMterm
LeadPartitionId
LeadPerson
LeadRevenueCycleModelId
LeadRevenueStageId
LeadRole
LeadScore
LeadSource
LeadStatus
MainPhone
MarketingSuspended
MarketingSuspendedCause
MiddleName
MktoAcquisitionDate
MktoCompanyNotes
MktoDoNotCallCause
MktoIsCustomer
MktoIsPartner
MktoName
MktoPersonNotes
MobilePhone
NumberOfEmployees
NumberofEmployeesProspect
OriginalReferrer
OriginalSearchEngine
OriginalSearchPhrase
OriginalSourceInfo
OriginalSourceType
PersonLevelEngagementScore
PersonPrimaryLeadInterest
PersonTimeZone
PersonType
Phone
PostalCode
Priority
Rating
RegistrationSourceInfo
RegistrationSourceType
RelativeScore
RelativeUrgency
Salutation
SicCode
Site
State
Test
Test1
Test98
TestBoolean
TestCustomfieldEmail
TestFieldText1
TestInteger
TestInteger_cf
TestKpQA
Title
Unsubscribed
UnsubscribeDateFoFS
UnsubscribeDateUnleashed
UnsubscribedReason
UnsubscribeFoFS
UnsubscribeMarketing
UnsubscribeSales
UnsubscribeUnleashed
UpdatedAt
Urgency
UTMTerm
Website

ProgramCosts

Query, insert and delete program cost relations for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM ProgramCosts WHERE ProgramId='6205'

Columns


Name	Type	Operators	Description
ProgramId	Int	=	The unique, Marketo-assigned identifier of the program.
Cost	Int		Amount of the cost.
CostNote	String		Note of the cost.
CostStartDate	Datetime		Start datetime of the period cost.

ProgramTags

Query tags relations for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM ProgramTags WHERE tagType='test' AND tagValue='asd1'
	SELECT * FROM ProgramTags WHERE ProgramId=6138

Columns


Name	Type	Operators	Description
ProgramId [KEY]	Int	=	The unique, Marketo-assigned identifier of the program.
TagType [KEY]	String	=	The tag type associated with the program. Each TagType has a value associated with it which is returned via the TagValue column.
TagValue	String	=	Value of the tag type.

Roles

Query roles. Requires permissions: 'Access User Management Api' and 'Access Users'.

Select

This view does not support server-side filtering.

	SELECT * FROM Roles;

Columns


Name	Type	Operators	Description
Id [KEY]	Integer		The unique, Marketo-assigned identifier of the role.
Name	String		The name of the role.
Description	String		The description of the role.
Type	String		The type of the role.
IsHidden	Boolean		Whether the role is hidden.
IsOnlyAllZones	Boolean		Whether the role is all zones.
CreatedAt	Datetime		The date and time the role was created.
UpdatedAt	Datetime		The date and time the role was last updated.

Segmentations

Query segmentations for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Segmentations WHERE Status='draft'

Columns


Name	Type	Operators	Description
Id [KEY]	Int		Id of the segmentation.
Status [KEY]	String	=	Status of the segmentation, draft or approved.
Name	String		Name of the segmentation.
Description	String		Description of the segmentation.
URL	String		Url of the segmentation in the Marketo UI.
FolderId	Int		The unique, Marketo-assigned identifier of the parent folder/program.
FolderName	String		The name of the folder
FolderType	String		The type of folder (Folder,Program)
WorkspaceName	String		Workspace Name of the asset.
CreatedAt	Datetime		Datetime the segmentation was created.
UpdatedAt	Datetime		Datetime the segmentation was most recently updated.

Segments

Query segments for a Marketo organization.

Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM Segments WHERE SegmentationId=1001 AND Status='draft'
	SELECT * FROM Segments WHERE SegmentationId=1001

Columns


Name	Type	Operators	Description
Id [KEY]	Int		Id of the segment.
Status [KEY]	String	=	Status of the segment, draft or approved.
SegmentationId	Int	=	Id of the segmentation.
Name	String		Name of the segment.
Description	String		Description of the segmentation.
URL	String		Url of the segmentation in the Marketo UI.
CreatedAt	Datetime		Datetime segment form was created.
UpdatedAt	Datetime		Datetime the segment was most recently updated.

SmartListFilterConditions

Query filters of smart lists in a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM SmartListFilterConditions WHERE SmartListId='1093'

Columns


Name	Type	Operators	Description
FilterId	Int		Id of the smart list filter.
SmartListId	Int	=	Id of the smart list.
ActivityAttributeId	String		Id of activity attribute.
ActivityAttributeName	String		Name of activity attribute.
AttributeId	String		Id of attribute.
AttributeName	String		Name of attribute.
Operator	String		Value of operator.
Values	String		List of values.
IsPrimary	String		Whether the condition is primary or not (first condition of the smart list).
IsError	String		Whether the condition is error.
ErrorMessage	String		The error message if IsError=true.

SmartListFilters

Query filters of smart lists in a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM SmartListFilters WHERE SmartListId='3560'

Columns


Name	Type	Operators	Description
Id [KEY]	Int		Id of the smart list filter.
SmartListId	Int	=	Id of the smart list.
Name	String		The name of the smart list rule filter.
Operator	String		The operator used in the filter.
RuleType	String		The type of the rule.
RuleTypeId	Int		The Id of the rule type.
FilterMatchType	String		The rule filter match type
Conditions	String		JSON aggregate of smart list filter conditions.

SmartListTriggers

Query rules of smart lists in a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM SmartListTriggers WHERE SmartListId='3560'

Columns


Name	Type	Operators	Description
SmartListId	Int	=	Id of the smart list.
Trigger	String		Smart list trigger.

TagAllowedValues

Query allowed values for tags in a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM TagAllowedValues WHERE TagType='test'

Columns


Name	Type	Operators	Description
TagType [KEY]	String	=	The name/type of the tag.
AllowableValues	String		The acceptable values for the tag type.

ThankYouList

Query form thank you pages for a Marketo organization.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM ThankYouList WHERE FormId=1

Columns


Name	Type	Operators	Description
FormId	Int	=	Id of the form.
FollowupType	String		The follow up type.
FollowupValue	String		The follow up value.
Default	Bool		If this is the default ThankYouPage.
Operator	String		The operator for the ThankYouPage.
SubjectField	String		The subject field of the ThankYouPage.
Values	String		JSON array of values.

WeeklyErrorStatistics

Retrieve the count of each error users have encountered in the past 7 days.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM WeeklyErrorStatistics WHERE ErrorCode='610'

Columns


Name	Type	Operators	Description
Date	Date		The date when the error was encountered.
ErrorCode	String		The error code.
Count	Int		The error count for the particular error code.

WeeklyUsageStatistics

Retrieve the number of API calls that specific users have consumed in the past 7 days.

Select

Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.

	SELECT * FROM WeeklyUsageStatistics WHERE UserId='User123'

Columns


Name	Type	Operators	Description
Date	Date		The date when the API Calls were made.
UserId	String		The ID of the user.
Count	Int		The individual count for the user.

Workspaces

Retrieve workspaces. Requires permissions: 'Access User Management Api' and 'Access Users'.

Select

This view does not support server-side filtering.

	SELECT * FROM Workspaces;

Columns


Name	Type	Operators	Description
Id [KEY]	Integer		The unique, Marketo-assigned identifier of the workspace.
Name	String		The name of the workspace.
Description	String		The description of the workspace.
Status	String		The status of the workspace.
GlobalVisualization	String		The global visualization of the workspace.
CurrencyInfo	String		The currency info of the workspace.
CreatedAt	Datetime		The date and time the workspace was created.
UpdatedAt	Datetime		The date and time the workspace was last updated.

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Marketo の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMarketo から関連するレスポンスデータを返します。

Marketo Connector for CData Sync ストアドプロシージャ


Name	Description
ActivateSmartCampaign	Activates a trigger smart campaign.
ApproveAsset	Approves the asset based on the given asset type and id.
AssociateLead	Associates a known Marketo lead record to a munchkin cookie and its associated web activity history.
BulkExportActivities	A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
BulkExportCustomObjects	A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
BulkExportLeads	A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
BulkExportProgramMembers	A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
BulkImportCustomObjects	Imports the custom object records from the provided file, waits for the job to finish and returns the job completion details.
BulkImportLeads	Imports the lead records from the provided file, waits for the job to finish and returns the job completion details.
BulkImportProgramMembers	Imports the program member records from the provided file, waits for the job to finish and returns the job completion details.
CancelExportJob	Cancel a bulk export job.
CreateActivitiesExportJob	Create an activities export job based on the given filters.
CreateCustomObjectsExportJob	Create a custom object export job based on the given filters. Only 1 filter type can be specified.
CreateCustomObjectsImportJob	Imports the program custom object records from the provided file.
CreateEmailTemplate	Creates a new email template.
CreateExportJob	Create an export job for the search criteria defined via the filter aggregate input. Returns the 'JobId' which can be passed as a parameter in subsequent calls to Bulk Export Activities. Use EnqueueExportJob to queue the export job for processing. Use GetExportJobStatus to retrieve status of export job.
CreateFile	Creates a new file from the included payload.
CreateLeadsExportJob	Create a leads export job based on the given filters. Only 1 filter type can be specified.
CreateLeadsImportJob	Imports the lead records from the provided file.
CreateProgramMembersExportJob	Create a program members export job based on the given filters.
CreateProgramMembersImportJob	Imports the program member records from the provided file.
DeactivateSmartCampaign	Deactivates a trigger smart campaign.
DeleteInvitedUser	Delete pending user. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users.
EnqueueExportJob	Puts an export job in queue and starts the job when computing resources become available.
GetEmailFullContent	Returns the serialized HTML version of the email.
GetEmailTemplateContent	Returns the content for a given email template.
GetExportJobFile	Returns the file generated by the bulk job with the given Id.
GetExportJobStatus	Returns the status of an export job. Job status is available for 30 days after Completed or Failed status was reached.
GetImportJobFailures	Returns the list of failures for the import batch job
GetImportJobStatus	Returns the status of an import job.
GetImportJobWarnings	Returns the list of warnings for the import batch job
GetInvitedUserById	Retrieve a single pending user record through its Id. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users.
GetSnippetContent	Returns the content for a given snippet.
InviteUser	Send an email invitation to new user. Requires permissions: Access User Management Api and Access Users.
MergeLeads	Merges two or more known lead records into a single lead record.
PollExportJobStatus	Continuously polls the bulk API for the status of the export job until one of the following statuses is returned: Completed, Cancelled, Failed.
PollImportJobStatus	Will continuously poll the bulk API for the status of the import job until one of the following statuses is returned: Complete, Failed.
ScheduleCampaign	Passes a set of leads to a trigger campaign to run through the campaign's flow.
SendEmailSample	Sends a sample email to the given email address. Leads may be impersonated to populate data for tokens and dynamic content.
TriggerCampaign	Remotely schedules a batch campaign to run at a given time.
UnApproveAsset	Revokes approval based on the given asset type and id.
UpdateEmailContent	Updates the content of an email.
UpdateEmailFullContent	Replaces the HTML of an Email that has had its relationship broken from its template.
UpdateEmailTemplateContent	Updates the content of the given email template.
UpdateFile	Updates the content of the given file.
UpdateLandingPageTemplateContent	Updates the content for the target landing page template.
UpdateLeadPartition	Update the lead partition for a list of leads.
UpdateLeadProgramStatus	Changes the program status for a list of leads in a target program. Only existing members of the program may have their status changed with this procedure.
UpdateSnippetContent	Updates the content of a snippet.

ActivateSmartCampaign

Activates a trigger smart campaign.

Execute

Sample

	EXECUTE ActivateSmartCampaign Id=1

Input


Name	Type	Required	Description
Id	String	True	Id of the trigger smart campaign to activate.

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

ApproveAsset

Approves the asset based on the given asset type and id.

Execute

Sample

	EXECUTE ApproveAsset Id=1005, Type='LandingPage'

Input


Name	Type	Required	Description
Id	String	True	Id of the asset.
Type	String	True	Type of the asset. 使用できる値は次のとおりです。EmailTemplate, Email, Form, LandingPageTemplate, LandingPage, Snippet

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

AssociateLead

Associates a known Marketo lead record to a munchkin cookie and its associated web activity history.

Execute

Sample

	EXECUTE AssociateLead LeadId='1755', Cookie='id:063-GJP-217&token:_mch-marketo.com-1594662481190-60776'

Input


Name	Type	Required	Description
LeadId	Integer	True	Id of the Lead to associate
Cookie	String	True	The cookie value to associate

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

BulkExportActivities

A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.

Execute

Sample

	EXECUTE BulkExportActivities CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z'
	EXECUTE BulkExportActivities CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='C:/Users/cdata/export.csv'
	EXECUTE BulkExportActivities CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='/tmp/export.csv'
	EXECUTE BulkExportActivities ActivityTypeIds='1', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
	EXECUTE BulkExportActivities ActivityTypeIds='1,2,23', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
	EXECUTE BulkExportActivities ActivityTypeIds='1', PrimaryAttributeValueIds='1,2,3', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
	EXECUTE BulkExportActivities ActivityTypeIds='1', PrimaryAttributeValues='value1,value2', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'

Input


Name	Type	Required	Description
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
CreatedAtStartAt	Datetime	False	Inclusive lower bound filter for the activity creation datetime.
CreatedAtEndAt	Datetime	False	Inclusive upper bound filter for the activity creation datetime.
ActivityTypeIds	Integer	False	The id of a the activity type. Available activity types can be queried from the view ActivityTypes.
PrimaryAttributeValueIds	Integer	False	Filter based on the id of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValues.
PrimaryAttributeValues	String	False	Filter based on the values of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValueIds.
PollingInterval	Integer	False	The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.
LocalPath	String	False	The absolute path where the file will be saved.
ChunkSize	Long	False	The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once.
MaxThreads	Integer	False	The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output as BASE64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

BulkExportCustomObjects

A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.

Execute

Sample

	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z'
	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='C:/Users/cdata/export.csv'
	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='/tmp/export.csv'
	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-02-25T00:00:00Z', Columns='lead=LeadId,*'
	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', SmartListName='CDataSmartList'
	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', SmartListId=12
	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', StaticListName='ImportTest0407_csv'
	EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', StaticListId=13

Input


Name	Type	Required	Description
Table	String	True	Name of the custom object to export data for. Matches the name of custom objects listed in sys_tables.
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
UpdatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead update datetime.
UpdatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead update datetime.
StaticListId	Integer	False	The id of a static list you want to use as a filter.
StaticListName	String	False	The name of a static list you want to use as a filter.
SmartListId	Integer	False	The id of a smart list you want to use as a filter.
SmartListName	String	False	The name of a smart list you want to use as a filter.
PollingInterval	Integer	False	The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.
LocalPath	String	False	The absolute path where the file will be saved.
ChunkSize	Long	False	The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once.
MaxThreads	Integer	False	The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output as BASE64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

BulkExportLeads

A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.

Execute

Sample

	EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z'
	EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z', LocalPath='C:/Users/cdata/export.csv'
	EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z', LocalPath='/tmp/export.csv'
	EXECUTE BulkExportLeads CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-02-25T00:00:00Z', Columns='Id'
	EXECUTE BulkExportLeads CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-01-10T00:00:00Z', Columns='id=LeadID,*'
	EXECUTE BulkExportLeads SmartListName='CDataSmartList'
	EXECUTE BulkExportLeads StaticListName='ImportTest0407_csv'
	EXECUTE BulkExportLeads SmartListId=12
	EXECUTE BulkExportLeads StaticListId=13

Input


Name	Type	Required	Description
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
CreatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead creation datetime.
CreatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead creation datetime.
UpdatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead update datetime.
UpdatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead update datetime.
StaticListId	Integer	False	The id of a static list you want to use as a filter.
StaticListName	String	False	The name of a static list you want to use as a filter.
SmartListId	Integer	False	The id of a smart list you want to use as a filter.
SmartListName	String	False	The name of a smart list you want to use as a filter.
PollingInterval	Integer	False	The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.
LocalPath	String	False	The absolute path where the file will be saved.
ChunkSize	Long	False	The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once.
MaxThreads	Integer	False	The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output as BASE64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

BulkExportProgramMembers

A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.

Execute

Sample

	EXECUTE BulkExportProgramMembers ProgramId='6117'
	EXECUTE BulkExportProgramMembers ProgramId='6117,6182'
	EXECUTE BulkExportProgramMembers ProgramId='6117', Columns='acquiredBy=acqBy,*'
	EXECUTE BulkExportProgramMembers ProgramId='6117', LocalPath='/tmp/export.csv'
	EXECUTE BulkExportProgramMembers ProgramId='6117', LocalPath='C:/Users/cdata/export.csv'
	EXECUTE BulkExportProgramMembers ProgramId='6117,6182', UpdatedAtStartAt='2024-01-01', UpdatedAtEndAt='2024-01-30', IsExhausted='false', NurtureCadence='paus', StatusNames='Not in Program'

Input


Name	Type	Required	Description
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
UpdatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead update datetime.
UpdatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead update datetime.
ProgramId	String	True	Comma separated list of up to 10 program ids for which program members will be retrieved.
IsExhausted	Boolean	False	Boolean used to filter program membership records for people who have exhausted content.
NurtureCadence	String	False	Used to filter program membership records for a given nurture cadence. 使用できる値は次のとおりです。paus, norm
StatusNames	String	False	Comma separated list of program member status names to filter by.
PollingInterval	Integer	False	The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.
LocalPath	String	False	The absolute path where the file will be saved.
ChunkSize	Long	False	The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once.
MaxThreads	Integer	False	The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output as BASE64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

BulkImportCustomObjects

Imports the custom object records from the provided file, waits for the job to finish and returns the job completion details.

Execute

Sample

	EXECUTE BulkImportCustomObjects Table='CustomObject_customObject_cdatajp', LocalPath='C:/users/cdata/file.csv'
	EXECUTE BulkImportCustomObjects Table='CustomObject_customObject_cdatajp', LocalPath='/tmp/file.csv'
	EXECUTE BulkImportCustomObjects Table='CustomObject_customObject_cdatajp', FileData='bWFpbEFkZHJlc3MsbmFtZQpzdXBwb3J0X2NkYXRhLmNvLmpwMUBjZHRhLmNvbSxjZGF0YTE3CnN1cHBvcnRfY2RhdGEuY28uanAyQGNkdGEuY29tLGNkYXRhMTg='

Input


Name	Type	Required	Description
Table	String	True	The custom object table name.
Format	String	False	Format of the import file. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
LocalPath	String	False	The absolute path of the file to import.
FileData	String	False	Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import process.
RowsProcessed	Integer	The number of rows processed so far.
RowsFailed	Integer	The number of rows failed so far.
RowsWithWarning	Integer	The number of rows with a warning so far.
Message	String	The status message of the batch.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

BulkImportLeads

Imports the lead records from the provided file, waits for the job to finish and returns the job completion details.

Execute

Sample

	EXECUTE BulkImportLeads LocalPath='C:/users/cdata/file.csv'
	EXECUTE BulkImportLeads LocalPath='/tmp/file.csv'
	EXECUTE BulkImportLeads LookupField='testCustomfieldEmail', ListId=1570, PartitionName='testPartition', LocalPath='/tmp/file.csv'
	EXECUTE BulkImportLeads FileData='ZW1haWwsZmlyc3ROYW1lLGxhc3ROYW1lLHRlc3RDdXN0b21maWVsZEVtYWlsCnRlc3RAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdEB0ZXN0Q3VzdG9tZmllbGRFbWFpbC5jZGF0YS5jb20KdGVzdDEyMzFAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdDFAdGVzdEN1c3RvbWZpZWxkRW1haWwuY2RhdGEuY29t'

Input


Name	Type	Required	Description
LookupField	String	False	Field to use for deduplication. Custom fields (string, email, integer), and the following field types are supported: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Default is email. You can use id for update only operations.
PartitionName	String	False	Name of the lead partition to import to.
ListId	Integer	False	Id of the static list to import into.
Format	String	False	Format of the import file. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
LocalPath	String	False	The absolute path of the file to import.
FileData	String	False	Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import process.
RowsProcessed	Integer	The number of rows processed so far.
RowsFailed	Integer	The number of rows failed so far.
RowsWithWarning	Integer	The number of rows with a warning so far.
Message	String	The status message of the batch.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

BulkImportProgramMembers

Imports the program member records from the provided file, waits for the job to finish and returns the job completion details.

Execute

Sample

	EXECUTE BulkImportProgramMembers ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='C:/users/cdata/file.csv'
	EXECUTE BulkImportProgramMembers ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='/tmp/file.csv'
	EXECUTE BulkImportProgramMembers ProgramId=6145, ProgramMemberStatus='Influenced', FileData='Zmlyc3ROYW1lLGxhc3ROYW1lLGVtYWlsLHRpdGxlLGNvbXBhbnksbGVhZFNjb3JlCkpvYW5uYSxMYW5uaXN0ZXIsSm9hbm5hQExhbm5pc3Rlci5jb20sTGFubmlzdGVyLEhvdXNlIExhbm5pc3RlciwwClR5d2luLExhbm5pc3RlcixUeXdpbkBMYW5uaXN0ZXIuY29tLExhbm5pc3RlcixIb3VzZSBMYW5uaXN0ZXIsMA=='

Input


Name	Type	Required	Description
ProgramId	Integer	True	Id of the program to add members to.
ProgramMemberStatus	String	True	Program member status for members being added.
Format	String	False	Format of the import file. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
LocalPath	String	False	The absolute path of the file to import.
FileData	String	False	Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import process.
RowsProcessed	Integer	The number of rows processed so far.
RowsFailed	Integer	The number of rows failed so far.
RowsWithWarning	Integer	The number of rows with a warning so far.
Message	String	The status message of the batch.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CancelExportJob

Cancel a bulk export job.

Execute

Sample

	EXECUTE CancelExportJob Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE CancelExportJob Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE CancelExportJob Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE CancelExportJob Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE CancelExportJob Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'

Input


Name	Type	Required	Description
Id	String	True	The id of the export job.
Table	String	True	The table to export. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Status	String	The status of the export process.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
QueuedAt	Datetime	The date when the export job was queued.
StartedAt	Datetime	The date when the export job was started.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateActivitiesExportJob

Create an activities export job based on the given filters.

Execute

Sample

	EXECUTE CreateActivitiesExportJob CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z'
	EXECUTE CreateActivitiesExportJob ActivityTypeIds='1', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
	EXECUTE CreateActivitiesExportJob ActivityTypeIds='1,2,23', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
	EXECUTE CreateActivitiesExportJob ActivityTypeIds='1', PrimaryAttributeValueIds='1,2,3', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
	EXECUTE CreateActivitiesExportJob ActivityTypeIds='1', PrimaryAttributeValues='value1,value2', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'

Input


Name	Type	Required	Description
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
CreatedAtStartAt	Datetime	False	Inclusive lower bound filter for the activity creation datetime.
CreatedAtEndAt	Datetime	False	Inclusive upper bound filter for the activity creation datetime.
ActivityTypeIds	Integer	False	The id of a the activity type. Available activity types can be queried from the view ActivityTypes.
PrimaryAttributeValueIds	Integer	False	Filter based on the id of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValues.
PrimaryAttributeValues	String	False	Filter based on the values of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValueIds.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
Status	String	The status of the export process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateCustomObjectsExportJob

Create a custom object export job based on the given filters. Only 1 filter type can be specified.

Execute

Sample

	EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z'
	EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-02-25T00:00:00Z', Columns='lead=LeadId,*'
	EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', SmartListName='CDataSmartList'
	EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', SmartListId=12
	EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', StaticListName='ImportTest0407_csv'
	EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', StaticListId=13

Input


Name	Type	Required	Description
Table	String	True	Name of the custom object to export data for. Matches the name of custom objects listed in sys_tables.
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
UpdatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead update datetime.
UpdatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead update datetime.
StaticListId	Integer	False	The id of a static list you want to use as a filter.
StaticListName	String	False	The name of a static list you want to use as a filter.
SmartListId	Integer	False	The id of a smart list you want to use as a filter.
SmartListName	String	False	The name of a smart list you want to use as a filter.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
Status	String	The status of the export process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateCustomObjectsImportJob

Imports the program custom object records from the provided file.

Execute

Sample

	EXECUTE CreateCustomObjectsImportJob Table='CustomObject_customObject_cdatajp', LocalPath='C:/users/cdata/file.csv'
	EXECUTE CreateCustomObjectsImportJob Table='CustomObject_customObject_cdatajp', LocalPath='/tmp/file.csv'
	EXECUTE CreateCustomObjectsImportJob Table='CustomObject_customObject_cdatajp', FileData='bWFpbEFkZHJlc3MsbmFtZQpzdXBwb3J0X2NkYXRhLmNvLmpwMUBjZHRhLmNvbSxjZGF0YTE3CnN1cHBvcnRfY2RhdGEuY28uanAyQGNkdGEuY29tLGNkYXRhMTg='

Input


Name	Type	Required	Description
Table	String	True	The custom object table name.
Format	String	False	Format of the import file. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
LocalPath	String	False	The absolute path of the file to import.
FileData	String	False	Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set.
PollingInterval	Integer	False	In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateEmailTemplate

Creates a new email template.

Execute

Sample

	EXECUTE CreateEmailTemplate Name='TestTemplateNewDriver_', FileData='PGh0bWw+Cjxib2R5Pgo8aDE+VEVTVCBIVE1MPC9oMT4KPC9ib2R5Pgo8L2h0bWw+', Description='Test Create Email Template', FolderId=27, FolderType='Folder'
	EXECUTE CreateEmailTemplate Name='TestTemplateNewDriver_', LocalPath='C:/users/cdata/file.txt', Description='Test Create Email Template', FolderId=27, FolderType='Folder'
	EXECUTE CreateEmailTemplate Name='TestTemplateNewDriver_', LocalPath='/tmp/file.txt', Description='Test Create Email Template', FolderId=27, FolderType='Folder'

Input


Name	Type	Required	Description
Name	String	True	Name of the Email Template. Must be unique under the parent folder.
Description	String	False	Description of the email template.
FolderId	Integer	True	Id of the folder where the template will be created.
FolderType	String	True	Type of the folder where the template will be created.
LocalPath	String	False	The absolute path to a file where data is read from.
FileData	String	False	Base64 string representation of the file content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
Id	Integer	Id of the created email template.
URL	String	Url of the created email template.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateExportJob

Create an export job for the search criteria defined via the filter aggregate input. Returns the 'JobId' which can be passed as a parameter in subsequent calls to Bulk Export Activities. Use EnqueueExportJob to queue the export job for processing. Use GetExportJobStatus to retrieve status of export job.

Execute

Sample

	EXECUTE CreateExportJob Table='Leads', FiltersAggregate='{"createdAt": {endAt": "2023-12-01", startAt": "2023-11-01"}}'
	EXECUTE CreateExportJob Table='Leads', Columns='Id,test98,updatedAt,*', FiltersAggregate='{"createdAt": {endAt": "2023-12-01", startAt": "2023-11-01"}}'

Input


Name	Type	Required	Description
Table	String	True	The table to export. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object.
Format	String	False	Format of export file to be generated. 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that you want to retrieve. Defaults to * (all columns). You can specify different header names for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. The exported file headers will be built using API names. Exported file column names can be changed using the Columns input. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
FiltersAggregate	String	False	JSON aggregate for the filters required in the request body.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
Status	String	The status of the export process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateFile

Creates a new file from the included payload.

Execute

Sample

	EXECUTE CreateFile FileData='aGVsbG8gd29ybGQ=', Description='Test Create File', Name='newFile_0', FolderId=35, FolderType='Folder'
	EXECUTE CreateFile LocalPath='C:/users/cdata/file.txt', Description='Test Create File', Name='newFile_0', FolderId=35, FolderType='Folder'
	EXECUTE CreateFile LocalPath='/tmp/file.txt', Description='Test Create File', Name='newFile_0', FolderId=35, FolderType='Folder'

Input


Name	Type	Required	Description
Name	String	True	Name of the file. Must be unique under the parent folder.
Description	String	False	Description of the file.
FolderId	Integer	True	Id of the folder where the file will be created.
FolderType	String	True	Type of the folder where the file will be created.
InsertOnly	Boolean	False	Indicates whether the call should fail if there is already an existing file with the same name.
LocalPath	String	False	The absolute path to a file where data is read from.
FileData	String	False	Base64 string representation of the file content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
Id	Integer	Id of the created file.
URL	String	URL of the created file.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateLeadsExportJob

Create a leads export job based on the given filters. Only 1 filter type can be specified.

Execute

Sample

	EXECUTE CreateLeadsExportJob CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z'
	EXECUTE CreateLeadsExportJob CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-02-25T00:00:00Z', Columns='Id'
	EXECUTE CreateLeadsExportJob CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-01-10T00:00:00Z', Columns='id=LeadID,*'
	EXECUTE CreateLeadsExportJob SmartListName='CDataSmartList'
	EXECUTE CreateLeadsExportJob StaticListName='ImportTest0407_csv'
	EXECUTE CreateLeadsExportJob SmartListId=12
	EXECUTE CreateLeadsExportJob StaticListId=13

Input


Name	Type	Required	Description
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
CreatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead creation datetime.
CreatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead creation datetime.
UpdatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead update datetime.
UpdatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead update datetime.
StaticListId	Integer	False	The id of a static list you want to use as a filter.
StaticListName	String	False	The name of a static list you want to use as a filter.
SmartListId	Integer	False	The id of a smart list you want to use as a filter.
SmartListName	String	False	The name of a smart list you want to use as a filter.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
Status	String	The status of the export process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateLeadsImportJob

Imports the lead records from the provided file.

Execute

Sample

	EXECUTE CreateLeadsImportJob LocalPath='C:/users/cdata/file.csv'
	EXECUTE CreateLeadsImportJob LocalPath='/tmp/file.csv'
	EXECUTE CreateLeadsImportJob LookupField='testCustomfieldEmail', ListId=1570, PartitionName='testPartition', LocalPath='/tmp/file.csv'
	EXECUTE CreateLeadsImportJob FileData='ZW1haWwsZmlyc3ROYW1lLGxhc3ROYW1lLHRlc3RDdXN0b21maWVsZEVtYWlsCnRlc3RAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdEB0ZXN0Q3VzdG9tZmllbGRFbWFpbC5jZGF0YS5jb20KdGVzdDEyMzFAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdDFAdGVzdEN1c3RvbWZpZWxkRW1haWwuY2RhdGEuY29t'

Input


Name	Type	Required	Description
LookupField	String	False	Field to use for deduplication. Custom fields (string, email, integer), and the following field types are supported: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Default is email. You can use id for update only operations.
PartitionName	String	False	Name of the lead partition to import to.
ListId	Integer	False	Id of the static list to import into.
Format	String	False	Format of the import file. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
LocalPath	String	False	The absolute path of the file to import.
FileData	String	False	Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set.
PollingInterval	Integer	False	In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateProgramMembersExportJob

Create a program members export job based on the given filters.

Execute

Sample

	EXECUTE CreateProgramMembersExportJob ProgramId='6117'
	EXECUTE CreateProgramMembersExportJob ProgramId='6117,6182'
	EXECUTE CreateProgramMembersExportJob ProgramId='6117', Columns='acquiredBy=acqBy,*'
	EXECUTE CreateProgramMembersExportJob ProgramId='6117,6182', UpdatedAtStartAt='2024-01-01', UpdatedAtEndAt='2024-01-30', IsExhausted='false', NurtureCadence='paus', StatusNames='Not in Program'

Input


Name	Type	Required	Description
Format	String	False	Format of export file to be generated. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
Columns	String	False	Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,* デフォルト値は*です。
UseAPINames	Boolean	False	If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns). デフォルト値はfalseです。
UpdatedAtStartAt	Datetime	False	Inclusive lower bound filter for the lead update datetime.
UpdatedAtEndAt	Datetime	False	Inclusive upper bound filter for the lead update datetime.
ProgramId	String	True	Comma separated list of up to 10 program ids for which program members will be retrieved.
IsExhausted	Boolean	False	Boolean used to filter program membership records for people who have exhausted content.
NurtureCadence	String	False	Used to filter program membership records for a given nurture cadence. 使用できる値は次のとおりです。paus, norm
StatusNames	String	False	Comma separated list of program member status names to filter by.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
Status	String	The status of the export process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

CreateProgramMembersImportJob

Imports the program member records from the provided file.

Execute

Sample

	EXECUTE CreateProgramMembersImportJob ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='C:/users/cdata/file.csv'
	EXECUTE CreateProgramMembersImportJob ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='/tmp/file.csv'
	EXECUTE CreateProgramMembersImportJob ProgramId=6145, ProgramMemberStatus='Influenced', FileData='Zmlyc3ROYW1lLGxhc3ROYW1lLGVtYWlsLHRpdGxlLGNvbXBhbnksbGVhZFNjb3JlCkpvYW5uYSxMYW5uaXN0ZXIsSm9hbm5hQExhbm5pc3Rlci5jb20sTGFubmlzdGVyLEhvdXNlIExhbm5pc3RlciwwClR5d2luLExhbm5pc3RlcixUeXdpbkBMYW5uaXN0ZXIuY29tLExhbm5pc3RlcixIb3VzZSBMYW5uaXN0ZXIsMA=='

Input


Name	Type	Required	Description
ProgramId	Integer	True	Id of the program to add members to.
ProgramMemberStatus	String	True	Program member status for members being added.
Format	String	False	Format of the import file. Available values are: CSV, TSV, SSV 使用できる値は次のとおりです。CSV, TSV, SSV デフォルト値はCSVです。
LocalPath	String	False	The absolute path of the file to import.
FileData	String	False	Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set.
PollingInterval	Integer	False	In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import process.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

DeactivateSmartCampaign

Deactivates a trigger smart campaign.

Execute

Sample

	EXECUTE DeActivateSmartCampaign Id=1

Input


Name	Type	Required	Description
Id	String	True	Id of the trigger smart campaign to deactivate.

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

DeleteInvitedUser

Delete pending user. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users.

Execute

Sample

	EXECUTE DeleteInvitedUser UserId='[email protected]'

Input


Name	Type	Required	Description
UserId	String	True	The user id in the form of an email address.

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

EnqueueExportJob

Puts an export job in queue and starts the job when computing resources become available.

Execute

Sample

	EXECUTE EnqueueExportJob Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE EnqueueExportJob Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE EnqueueExportJob Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE EnqueueExportJob Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE EnqueueExportJob Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'

Input


Name	Type	Required	Description
Id	String	True	The id of the export job.
Table	String	True	The table to export. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object.
PollingInterval	Integer	False	In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Status	String	The status of the export process.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
QueuedAt	Datetime	The date when the export job was queued.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetEmailFullContent

Returns the serialized HTML version of the email.

Execute

Sample

	EXECUTE GetEmailFullContent Id=23685
	EXECUTE GetEmailFullContent Id=23685, EmailContentType='Text'

Input


Name	Type	Required	Description
Id	String	True	The Id of the email.
Status	String	False	Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not. 使用できる値は次のとおりです。approved, draft
LeadId	String	False	The lead id to impersonate. Email is rendered as though it was received by this lead.
EmailContentType	String	False	Email content type to return. Default is HTML. 使用できる値は次のとおりです。HTML, Text

Result Set Columns


Name	Type	Description
Id	String	The Id of the email.
Content	String	The content of the email.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetEmailTemplateContent

Returns the content for a given email template.

Execute

Sample

	EXECUTE GetEmailTemplateContent Id=1054

Input


Name	Type	Required	Description
Id	Integer	True	Id of the email template.
Status	String	False	The status of the email template to retrieve the content from. 使用できる値は次のとおりです。draft, approved

Result Set Columns


Name	Type	Description
Id	Integer	Id of the email template.
Content	String	Content of the email template.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetExportJobFile

Returns the file generated by the bulk job with the given Id.

Execute

Sample

	EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobFile Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobFile Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobFile Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobFile Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d', LocalPath='C:/users/cdata/file.txt'
	EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d', LocalPath='/tmp/file.txt'

Input


Name	Type	Required	Description
Id	String	True	The id of the export job.
Table	String	True	The exported table. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object.
LocalPath	String	False	The absolute path where the file will be saved.
ChunkSize	Long	False	The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once.
DownloadSize	Long	False	The size in bytes to download. Can be retrieved from the field fileSize of the /status.json endpoint. If not set it will be automatically resolved and the whole file will be downloaded.
MaxThreads	Integer	False	The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'.

Result Set Columns


Name	Type	Description
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output as BASE64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetExportJobStatus

Returns the status of an export job. Job status is available for 30 days after Completed or Failed status was reached.

Execute

Sample

	EXECUTE GetExportJobStatus Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobStatus Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobStatus Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobStatus Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE GetExportJobStatus Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'

Input


Name	Type	Required	Description
Id	String	True	The id of the export job.
Table	String	True	The exported table. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Status	String	The status of the export job. Applicable values: Created, Queued, Processing, Cancelled, Completed, Failed.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
QueuedAt	Datetime	The date when the export job was queued.
StartedAt	Datetime	The date when the export job was started.
FinishedAt	Datetime	The date when the export job was finished.
NumberOfRecords	Long	The number of records contained within the generated file.
FileSize	Long	The size in bytes of the generated file.
FileChecksum	String	The checksum of the generated file.
ErrorMessage	String	The error message in case of failed status.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetImportJobFailures

Returns the list of failures for the import batch job

Execute

Sample

	EXECUTE GetImportJobFailures Id=1612, Table='Leads'
	EXECUTE GetImportJobFailures Id=1612, Table='CustomObject_cdata', LocalPath='C:/users/cdata/file.txt'
	EXECUTE GetImportJobFailures Id=1612, Table='ProgramMembers ', LocalPath='/tmp/file.txt'

Input


Name	Type	Required	Description
Id	String	True	The id of the import job.
Table	String	True	The table that data was imported to. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object.
LocalPath	String	False	The absolute path where the file will be saved.

Result Set Columns


Name	Type	Description
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output as BASE64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetImportJobStatus

Returns the status of an import job.

Execute

Sample

	EXECUTE GetImportJobStatus Id=1608, Table='Leads'
	EXECUTE GetImportJobStatus Id=1609, Table='CustomObject_cdata'
	EXECUTE GetImportJobStatus Id=1610, Table='ProgramMembers'

Input


Name	Type	Required	Description
Id	String	True	The id of the import job.
Table	String	True	The table that data was imported to. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import job. Applicable values: Queued, Importing, Complete, Failed.
RowsProcessed	Integer	The number of rows processed so far.
RowsFailed	Integer	The number of rows failed so far.
RowsWithWarning	Integer	The number of rows with a warning so far.
Message	String	The status message of the batch.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetImportJobWarnings

Returns the list of warnings for the import batch job

Execute

Sample

	EXECUTE GetImportJobWarnings Id=1612, Table='Leads'
	EXECUTE GetImportJobWarnings Id=1612, Table='CustomObject_cdata', LocalPath='C:/users/cdata/file.txt'
	EXECUTE GetImportJobWarnings Id=1612, Table='ProgramMembers ', LocalPath='/tmp/file.txt'

Input


Name	Type	Required	Description
Id	String	True	The id of the import job.
Table	String	True	The table that data was imported to. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object.
LocalPath	String	False	The absolute path where the file will be saved.

Result Set Columns


Name	Type	Description
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output as BASE64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetInvitedUserById

Retrieve a single pending user record through its Id. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users.

Execute

Sample

	EXECUTE GetInvitedUserById UserId='[email protected]'

Input


Name	Type	Required	Description
UserId	String	True	The user id in the form of an email address.

Result Set Columns


Name	Type	Description
UserId	String	The user id in the form of an email address.
Id	Integer	The user identifier.
EmailAddress	String	The user's email address.
FirstName	String	The user's first name.
LastName	String	The user's last name.
SubscriptionId	String	The subscription id.
Status	String	The user status.
CreatedAt	Datetime	The date and time when the user login was created.
UpdatedAt	Datetime	The date and time when the user login was last updated.
ExpiresAt	Datetime	The date and time when the user login expires.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

GetOAuthAccessToken

Get an access token from Marketo.

Execute

Sample

	EXECUTE GetOAuthAccessToken

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The access token used for communication with Marketo.
ExpiresIn	String	The remaining lifetime of the access token.

GetSnippetContent

Returns the content for a given snippet.

Execute

Sample

	EXECUTE GetSnippetContent SnippetId=1054
	EXECUTE GetSnippetContent SnippetId=1054, Status='draft'

Input


Name	Type	Required	Description
SnippetId	Integer	True	Id of the snippet.
Status	String	False	The status of the snippet to retrieve the content from. 使用できる値は次のとおりです。draft, approved

Result Set Columns


Name	Type	Description
Content	String	Content of the snippet.
Type	String	Type of the snippet content.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

InviteUser

Send an email invitation to new user. Requires permissions: Access User Management Api and Access Users.

Execute

Sample

	EXECUTE InviteUser EmailAddress='[email protected]', FirstName='insert', LastName='api', UserWorkspaceRoles='[{"accessRoleId": 103, "workspaceId": 0}]

	EXECUTE InviteUser EmailAddress='[email protected]', FirstName='insert', LastName='api', UserWorkspaceRoles='[{"accessRoleId": 103, "workspaceId": 0}]', Reason='test', UserId='[email protected]', ApiOnly=true, ExpiresAt='2024-12-12T00:00:00-01:00'

Input


Name	Type	Required	Description
EmailAddress	String	True	The user's email address.
FirstName	String	True	The user's first name.
LastName	String	True	The user's last name.
UserWorkspaceRoles	String	True	The user roles provided as a json array of objects containing accessRoleId and workspaceId.
UserId	String	False	The user id in the form of an email address. If not specified, the emailAddress value is used.
Reason	String	False	Reason for user invitation.
ApiOnly	Boolean	False	Whether the user is API-Only. デフォルト値はfalseです。
ExpiresAt	Datetime	False	Date and time when user login expires.

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

MergeLeads

Merges two or more known lead records into a single lead record.

Execute

Sample

	EXECUTE MergeLeads WinningLeadId=1657, LosingLeadId='1665,1666,1667'

Input


Name	Type	Required	Description
WinningLeadId	Integer	True	Id of the winning lead record.
LosingLeadId	String	True	Ids of losing Lead records.
MergeInCRM	Boolean	False	Name of the new status for the program member.

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

PollExportJobStatus

Continuously polls the bulk API for the status of the export job until one of the following statuses is returned: Completed, Cancelled, Failed.

Execute

Sample

	EXECUTE PollExportJobStatus Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE PollExportJobStatus Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE PollExportJobStatus Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE PollExportJobStatus Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
	EXECUTE PollExportJobStatus Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'

Input


Name	Type	Required	Description
Id	String	True	The id of the export job.
Table	String	True	The exported table. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object.
PollingInterval	Integer	False	The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.

Result Set Columns


Name	Type	Description
Id	String	The Id of the export job.
Status	String	The status of the export process. Applicable values: Created, Queued, Processing, Cancelled, Completed, Failed.
Format	String	The format of the export job.
CreatedAt	Datetime	The date when the export job was created.
QueuedAt	Datetime	The date when the export job was queued.
StartedAt	Datetime	The date when the export job was started.
FinishedAt	Datetime	The date when the export job was finished.
NumberOfRecords	Long	The number of records contained within the generated file.
FileSize	Long	The size in bytes of the generated file.
FileChecksum	String	The checksum of the generated file.
ErrorMessage	String	The error message in case of failed status.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

PollImportJobStatus

Will continuously poll the bulk API for the status of the import job until one of the following statuses is returned: Complete, Failed.

Execute

Sample

	EXECUTE PollImportJobStatus Id=1608, Table='Leads'
	EXECUTE PollImportJobStatus Id=1609, Table='CustomObject_cdata'
	EXECUTE PollImportJobStatus Id=1610, Table='ProgramMembers'

Input


Name	Type	Required	Description
Id	String	True	The id of the import job.
Table	String	True	The table to import. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object.
PollingInterval	Integer	False	The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value.

Result Set Columns


Name	Type	Description
Id	String	The Id of the import job.
Status	String	The status of the import job. Applicable values: Queued, Importing, Complete, Failed.
RowsProcessed	Integer	The number of rows processed so far.
RowsFailed	Integer	The number of rows failed so far.
RowsWithWarning	Integer	The number of rows with a warning so far.
Message	String	The status message of the batch.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

ScheduleCampaign

Passes a set of leads to a trigger campaign to run through the campaign's flow.

Execute

Sample

	EXECUTE ScheduleCampaign CampaignId=1107, RunAt='2024-06-06T01:00:00', CloneToProgramName='Program 1', TokenName='TestingSP', TokenValue='test'
	EXECUTE ScheduleCampaign CampaignId=1107, RunAt='2024-06-06T01:00:00', TokenName='TestingSP,testTokenIndritB', TokenValue='\"test,asd\",2024-12-12'
	EXECUTE ScheduleCampaign CampaignId=1107, RunAt='2024-06-06T01:00:00', TokenName#1='TestingSP', TokenValue#1='test',  TokenName#2='testTokenIndritB', TokenValue#2='2024-12-12'

Input


Name	Type	Required	Description
CampaignId	Integer	True	Id of the campaign to schedule.
RunAt	Datetime	False	Datetime to run the campaign at. If unset, the campaign will be run five minutes after the call is made.
CloneToProgramName	String	False	Name of the resulting program. When used, this procedure is limited to 20 calls per day.
TokenName	String	False	Name of the token. Should be formatted as '{{my.name}}'.
TokenValue	String	False	Value of the token.

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

SendEmailSample

Sends a sample email to the given email address. Leads may be impersonated to populate data for tokens and dynamic content.

Execute

Sample

	EXECUTE SendEmailSample Id=23685, Email='[email protected]'

Input


Name	Type	Required	Description
Id	String	True	The Id of the email.
Email	String	True	Email address to receive the sample email.
LeadId	String	False	Id of a lead to impersonate. Tokens and dynamic content will be populated as though it were sent to the lead.
TextOnly	String	False	Set to true to send the text only version along with the HTML version. Default false/

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

TriggerCampaign

Remotely schedules a batch campaign to run at a given time.

Execute

Sample

	EXECUTE TriggerCampaign CampaignId=12
	EXECUTE TriggerCampaign CampaignId=12, LeadIds='1'
	EXECUTE TriggerCampaign CampaignId=12, LeadIds='1,2,3', TokenName='token1,token2', TokenValue='value1,value2'

Input


Name	Type	Required	Description
CampaignId	Integer	True	Id of the campaign to schedule.
LeadIds	String	False	Lead ids to run through the campaign's flow.
TokenName	String	False	Name of the token. Should be formatted as '{{my.name}}'
TokenValue	String	False	Value of the token

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UnApproveAsset

Revokes approval based on the given asset type and id.

Execute

Sample

	EXECUTE UnApproveAsset Id=1005, Type='LandingPage'

Input


Name	Type	Required	Description
Id	String	True	Id of the asset.
Type	String	True	Type of the asset. 使用できる値は次のとおりです。EmailTemplate, Email, Form, LandingPageTemplate, LandingPage, Snippet

Result Set Columns


Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' contains the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateEmailContent

Updates the content of an email.

Execute

Sample

	EXECUTE UpdateEmailContent EmailId=23685, FromEmail='[email protected]', FromName='test', Subject='test subject', ReplyTo='[email protected]'

Input


Name	Type	Required	Description
EmailId	String	True	The Id of the email.
Subject	String	False	Subject Line of the Email.
FromEmail	String	False	From-address of the Email.
FromName	String	False	From-name of the Email.
ReplyTo	String	False	Reply-To address of the Email.

Result Set Columns


Name	Type	Description
EmailId	String	The Id of the updated email content.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateEmailFullContent

Replaces the HTML of an Email that has had its relationship broken from its template.

Execute

Sample

	EXECUTE UpdateEmailFullContent EmailId=23685, FileData='aGVsbG8gd29ybGQ='
	EXECUTE UpdateEmailFullContent EmailId=23685, LocalPath='C:/users/cdata/file.txt'
	EXECUTE UpdateEmailFullContent EmailId=23685, LocalPath='/tmp/file.txt'

Input


Name	Type	Required	Description
EmailId	String	True	The Id of the email.
LocalPath	String	False	The absolute path to a file where data is read from.
FileData	String	False	Base64 string representation of the file content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
EmailId	Integer	Id of the updated email template.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateEmailTemplateContent

Updates the content of the given email template.

Execute

Sample

	EXECUTE UpdateEmailTemplateContent EmailTemplateId=1054, FileData='PGh0bWw+Cjxib2R5Pgo8aDE+VEVTVCBIVE1MIFVQREFURUQ8L2gxPgo8L2JvZHk+CjwvaHRtbD4='
	EXECUTE UpdateEmailTemplateContent EmailTemplateId=1054, LocalPath='C:/users/cdata/file.txt'
	EXECUTE UpdateEmailTemplateContent EmailTemplateId=1054, LocalPath='/tmp/file.txt'

Input


Name	Type	Required	Description
EmailTemplateId	Integer	True	Id of the email template to update.
LocalPath	String	False	The absolute path to a file where data is read from.
FileData	String	False	Base64 string representation of the file content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
EmailTemplateId	Integer	Id of the updated email template.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateFile

Updates the content of the given file.

Execute

Sample

	EXECUTE UpdateFile Id=3312, FileData='aGVsbG8gd29ybGQgdXBkYXRlZA=='
	EXECUTE UpdateFile LocalPath='C:/users/cdata/file.txt'
	EXECUTE UpdateFile LocalPath='/tmp/file.txt'

Input


Name	Type	Required	Description
Id	Integer	True	Id of the file to update.
LocalPath	String	False	The absolute path to a file where data is read from.
FileData	String	False	Base64 string representation of the file content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
Id	Integer	Id of the updated file.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateLandingPageTemplateContent

Updates the content for the target landing page template.

Execute

Sample

	EXECUTE UpdateLandingPageTemplateContent LandingPageTemplateId=1005, FileData='aGVsbG8gd29ybGQgdXBkYXRlZA=='
	EXECUTE UpdateLandingPageTemplateContent LandingPageTemplateId=1005, LocalPath='C:/users/cdata/file.txt'
	EXECUTE UpdateLandingPageTemplateContent LandingPageTemplateId=1005, LocalPath='/tmp/file.txt'

Input


Name	Type	Required	Description
LandingPageTemplateId	Integer	True	Id of the landing page template.
LocalPath	String	False	The absolute path to a file where data is read from.
FileData	String	False	Base64 string representation of the file content. Only used if LocalPath and InputStream are not set.

Result Set Columns


Name	Type	Description
LandingPageTemplateId	String	Id of the asset.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateLeadPartition

Update the lead partition for a list of leads.

Execute

Sample

	EXECUTE UpdateLeadPartition LeadId='1557', PartitionName='testPartition'
	EXECUTE UpdateLeadPartition LeadId='1557,1558,1559', PartitionName='testPartition'

Input


Name	Type	Required	Description
PartitionName	String	True	Name of the partition.
LeadId	String	True	Ids of Lead records to update.

Result Set Columns


Name	Type	Description
Id	Integer	Id of the lead.
Status	String	Status of update operation.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateLeadProgramStatus

Changes the program status for a list of leads in a target program. Only existing members of the program may have their status changed with this procedure.

Execute

Sample

	EXECUTE UpdateLeadProgramStatus LeadIds='1557,1558,1559', ProgramId=1001, StatusName='Not in Program'

Input


Name	Type	Required	Description
ProgramId	Integer	True	Id of the program.
LeadIds	String	True	Ids of Lead records to update.
StatusName	String	True	Name of the new status for the program member.

Result Set Columns


Name	Type	Description
Id	Integer	Id of the lead.
Status	String	Status of update operation.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

UpdateSnippetContent

Updates the content of a snippet.

Execute

Sample

	EXECUTE UpdateSnippetContent SnippetId=1054, Content='<h1>test<h1>', Type='HTML'

Input


Name	Type	Required	Description
SnippetId	Integer	True	The Id of the snippet.
Content	String	True	The content of the snippet.
Type	String	False	The type of the content of the snippet. 使用できる値は次のとおりです。DynamicContent, Text, HTML デフォルト値はTextです。

Result Set Columns


Name	Type	Description
Id	Integer	The Id of the updated snippet.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Connection

プロパティ	説明
URL	The URL of the Marketo instance to connect to.

OAuth

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
BulkLeadsSupportsUpdatedAt	If set to true, the updatedAt filter will be marked as server-side supported.
BulkProgramMembersSupportsUpdatedAt	If set to true, the updatedAt filter will be marked as server-side supported.
DownloadChunkSize	The size of chunks (in bytes) when downloading large files.
IsCRMEnabled	Set to true to avoid pushing tables that are not available when CRM is enabled in Marketo.
JobPollingInterval	The maxmimum wait time in milliseconds between each job status poll.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads	同時リクエスト数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がMarketo にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UploadChunkSize	The size of chunks (in bytes) when uploading large files.
UseBulkAPI	Specifies whether to use the Marketo Bulk API.
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

プロパティ	説明
URL	The URL of the Marketo instance to connect to.

URL

The URL of the Marketo instance to connect to.

解説

The URL of the REST API Service. Can be found in Admin -> Integration -> Web Services -> REST API. Example: https://123-abc-456.mktorest.com/ or https://123-abc-456.mktorest.com/rest.

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

解説

このプロパティは2つのケースで必要となります：

カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立を参照してください。

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立を参照してください。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
MD5 Thumbprint（hex 値はスペースまたはコロン区切り）	`ecadbdda5a1529c58a1e9e09828d70e4`
SHA1 Thumbprint（hex 値はスペースまたはコロン区切り）	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がMarketo への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がMarketo への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がMarketo にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

サポートされる認証の種類：

BASIC：Sync App はHTTP Basic 認証を行います。
DIGEST：Sync App はHTTP ダイジェスト認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としないことを示します。

NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note：Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。


モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Marketo Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
BulkLeadsSupportsUpdatedAt	If set to true, the updatedAt filter will be marked as server-side supported.
BulkProgramMembersSupportsUpdatedAt	If set to true, the updatedAt filter will be marked as server-side supported.
DownloadChunkSize	The size of chunks (in bytes) when downloading large files.
IsCRMEnabled	Set to true to avoid pushing tables that are not available when CRM is enabled in Marketo.
JobPollingInterval	The maxmimum wait time in milliseconds between each job status poll.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads	同時リクエスト数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がMarketo にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UploadChunkSize	The size of chunks (in bytes) when uploading large files.
UseBulkAPI	Specifies whether to use the Marketo Bulk API.
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

BulkLeadsSupportsUpdatedAt

If set to true, the updatedAt filter will be marked as server-side supported.

解説

Only some Marketo instances support the UpdatedAt filter for Leads Bulk Exports. To enable the filter you need to reach out to Marketo support.


True	The Leads.UpdatedAt filter will be processed server-side.
False	The Leads.UpdatedAt filter will be processed client-side.
Auto	The driver will execute a probe query to check if the filter is supported or not.

BulkProgramMembersSupportsUpdatedAt

If set to true, the updatedAt filter will be marked as server-side supported.

解説

Only some Marketo instances support the UpdatedAt filter for ProgramMembers Bulk Exports. To enable the filter you need to reach out to Marketo support.


True	The ProgramMembers.UpdatedAt filter will be processed server-side.
False	The ProgramMembers.UpdatedAt filter will be processed client-side.
Auto	The driver will execute a probe query to check if the filter is supported or not.

DownloadChunkSize

The size of chunks (in bytes) when downloading large files.

解説

The size of chunks (in bytes) to use when downloading large files, defaults to 3MB. To download the entire file in one chunk, set this value to -1.

IsCRMEnabled

Set to true to avoid pushing tables that are not available when CRM is enabled in Marketo.

解説


True	Tables that are not available when CRM is enabled in Marketo will not be pushed.
False	The driver will push all tables normally.
Auto	The driver will execute a probe query to check if CRM is enabled or not.

JobPollingInterval

The maxmimum wait time in milliseconds between each job status poll.

解説

Initially the wait time is 5 seconds and doubles until it reaches the given JobPollingInterval.

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。（クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

MaxThreads

同時リクエスト数を指定します。

解説

このプロパティを使用すると、複数のリクエストを同時に発行することができパフォーマンスが向上します。

Other

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

Note：特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

統合およびフォーマット


プロパティ	説明
DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT=True	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse（ローカルタイムを使用）です。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

provider がMarketo にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

解説

クエリを処理する際、Marketo でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。

Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UploadChunkSize

The size of chunks (in bytes) when uploading large files.

解説

The size of chunks (in bytes) to use when uploading large files, defaults to 10MB. To upload the entire file in one chunk, set this value to -1.

UseBulkAPI

Specifies whether to use the Marketo Bulk API.

解説


True	The Marketo Bulk API will be used to extract or import data where applicable in SELECT/UPSERT statemnts.
False	The driver will not make use of the Bulk API.
Auto	The driver will make use of the Bulk API only in cases when the REST API is not sufficient such as when querying more than 100_000 records from the ProgramMembers table.

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Leads WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。次に例を示します。

UserDefinedViews=C:\Path\To\UserDefinedViews.json

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

詳しくは、ユーザー定義ビューを参照してください。

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Marketo Connector for CData Sync

Marketo Connector for CData Sync

概要

Marketo バージョンサポート

接続の確立

Marketo への接続を追加

Marketo への接続

OAuth 資格情報の取得

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

テーブル

ビュー

ストアドプロシージャ

テーブル

Marketo Connector for CData Sync テーブル

Activities_Custom

Select

Insert

Bulk

Columns

Companies

Select

Insert

Update

Upsert

Delete

Columns

CustomObjects

Select

Insert

Update

Upsert

Delete

Bulk

Columns

Emails

Select

Insert

Update

Delete

Columns

EmailTemplates

Select

Update

Delete

Columns

Folders

Select

Insert

Update

Delete

Columns

Forms

Select

Insert

Update

Delete

Columns

LandingPageContentSection

Select

Insert

Update

Delete

Columns

LandingPages

Select

Insert

Update

Delete