Optimove

Optimove ETL connector for data replication

Snapshot

Features	Details
Release Status	Released
Source API Version
Table Selection	Yes
Column Selection	Yes
Edit Integration	Yes
Replication Type Selection	No
Authentication Parameters	Optimove Base URI Optimove Username Optimove Password
Replication Type	Full Replication Key Based Incremental
Replication Key	Date
Suggested Replication Frequency	24 hrs

Tables/APIs Supported
CustomerAttribute	LifecycleStageList
MicroSegmentList	MicroSegmentChangers
AllActions	ActionsByTargetGroup
Promocodes	PromocodesByCampaign
PromocodesByTargetGroup	ActionDetailsByTargetGroup
ExecutedCampaignDetails	CampaignDetails
ExecutionChannels	ExecutedCampaignChannelDetails
ExecutedCampaignsByChannel	TargetGroupByDate
TargetGroupDetails	CustomerActionsByTargetGroup
CustomerOnetimeActionsByDate	CustomerOnetimeActionsByCampaign
CustomerFutureValues	CustomerLastActionExecuted
CustomerActionDetailsByDate	CustomersActionEndedByDate
CustomersSendFDetailsByCampaign	CustomerExecutionDetailsByCampaign
ProcessedCampaignCustomers	CurrentlyTargetedCustomers
CanceledCampaignCustomers	CustomerProductDetailsByCampaign
CustomerProductDetailsByDate	CustomerProductRecommendations
CampaignInteractionCustomers	CustomerChannelInteractions
ExternalRealtimeCampaignCustomers	ValueSegments
CustomersByValueSegment	ValueSegmentChangers
Promotions	ChannelTemplates
ChannelTemplateDetails	ExternalRealtimeTriggers
ActivityEventList	TransactionalTemplateMetrics

Integrate Optimove with Daton

1. Signin to Daton

2. Select Optimove from Integrations page

3. Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later

4. Provide Optimove Base URI, Username, Password for authentication and authorize Daton to periodically extract data from Optimove

5. Post successful authentication, you will be prompted to choose from the list of available tables

6. Then select all required fields for each table

7. Submit the integration

Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse

2. Users would be able to edit/pause/re-activate/delete integration anytime

3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

Optimove Data

CustomerAttribute

Purpose: Fetch the customer details like name, age address

Source API Documentation https://docs.optimove.com/api-usage-guide/#Model-related_Functions_GetCustomerAttributeList

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
RealFieldName	STRING
Description	STRING

LifecycleStageList

Purpose: Fetch the details of all life cycles stages pertain to a customer

Source API Documentation https://docs.optimove.com/api-usage-guide/#Model-related_Functions_GetLifecycleStageList

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
StageId	INTEGER
StageName	STRING

MicroSegmentList

Purpose: Fetch the all details of microsement pertaint to a customer

Source API Documentation https://docs.optimove.com/api-usage-guide/#Model-related_Functions_GetMicrosegmentList

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
MicrosegmentID	INTEGER
MicrosegmentName	STRING
LifecycleStageID	STRING
FutureValue	FLOAT
ChurnRate	NUMERIC
ReactivationRate	NUMERIC
ConversionProbability	NUMERIC

MicroSegmentChangers

Purpose: Fetch the details of customers who changed their microsegment, along with previous microsegment details and last date for fetched data.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Model-related_Functions_GetMicrosegmentChangers

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
CustomerID	STRING
InitialMicroSegmentID	INTEGER
FinalMicroSegmentID	INTEGER

AllActions

Purpose: Fetch the details of actions names and their IDs

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetAllActions

Replication: Full Replication Replication Key: NA

Fields

Name	Target Datatype
ActionID	INTEGER
ActionName	STRING

ActionsByTargetGroup

Purpose: Fetch the details of recipent group and actions associated with particular target group of a particular date

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetActionsByTargetGroup

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
RecipientGroupID	INTEGER
ActionID	INTEGER
Date	STRING

Promocodes

Purpose: Fetch the details of target group’s , action’s and their promocodes of a particular date

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetPromoCodes

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
TargetGroupID	INTEGER
RecipientGroupID	INTEGER
ActionID	INTEGER
PromoCode	STRING
Date	STRING

PromocodesByCampaign

Purpose: Fetch the details of recipient group’s , action’s and their promocodes of a particular campaign

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetPromoCodesByCampaign

Replication: Key-Based Replication

Replication Key: campaignid

Fields

Name	Target Datatype
RecipientGroupID	INTEGER
ActionID	INTEGER
PromoCode	STRING
CampaignId	INTEGER

PromocodesByTargetGroup

Purpose: Fetch the details of all recipient group IDs, action IDs and promo codes associated with a given target group on a particular date

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetPromoCodesByTargetGroup

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
RecipientGroupID	INTEGER
ActionID	INTEGER
PromoCode	STRING
Date	STRING
TargetGroupId	INTEGER

ActionDetailsByTargetGroup

Purpose: Fetch the details of action and their duration(in days & in days) and the execution channels associated with a given target group on a particular date

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetActionDetailsByTargetGroup

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
RecipientGroupID	INTEGER
ActionID	INTEGER
Duration	INTEGER
LeadTime	INTEGER
ChannelID	INTEGER
Date	STRING
TargetGroupId	INTEGER

ExecutedCampaignDetails

Purpose: Fetch the details of all campaign that were executed in a particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetExecutedCampaignDetails

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CampaignID	INTEGER
TargetGroupID	INTEGER
CampaignType	STRING
Duration	INTEGER
LeadTime	INTEGER
Notes	STRING
IsMultiChannel	BOOLEAN
IsRecurrence	BOOLEAN
Status	STRING
Error	STRING
Date	STRING

CampaignDetails

Purpose: Fetch the details of particular campaign details

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetCampaignDetails

Replication: Key-Based Replication

Replication Key: campaignid

Fields

Name	Target Datatype
TargetGroupID	INTEGER
CampaignType	STRING
Duration	INTEGER
LeadTime	INTEGER
Notes	STRING
IsMultiChannel	BOOLEAN
IsRecurrence	BOOLEAN
Status	STRING
Error	STRING
Tags	STRING
CampaignID	INTEGER

ExecutionChannels

Purpose: Fetch the details of all executable channels.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetExecutionChannels

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
ChannelId	INTEGER
ChannelName	STRING

ExecutedCampaignChannelDetails

Purpose: Fetch the details of a particular campaign exceuted on particular channel

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetExecutedCampaignChannelDetails

Replication: Key-Based Replication

Replication Key: campaignid, channelid

Fields

Name	Target Datatype
SendID	STRING
TemplateID	INTEGER
ScheduledTime	STRING
CampaignID	INTEGER
ChannelID	INTEGER

ExecutedCampaignsByChannel

Purpose: Fetch the details of campaigns executed for a particular channel on particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Action-related_Functions_GetExecutedCampaignsByChannel

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CampaignID	INTEGER
ChannelID	INTEGER
Date	STRING

TargetGroupByDate

Purpose: Fetch the details of a group for which the actions were performed on particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Target_Group-related_Functions_GetTargetGroupsByDate

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
TargetGroupID	INTEGER
Date	STRING

TargetGroupDetails

Purpose: Fetch the details of all target groups

Source API Documentation https://docs.optimove.com/api-usage-guide/#Target_Group-related_Functions_GetTargetGroupDetails

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
TargetGroupID	INTEGER
TargetGroupName	STRING
TargetGroupPriority	INTEGER

CustomerActionsByTargetGroup

Purpose: Fetch the details of customers and their marketing actions on a particular group on a particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomerActionsByTargetGroup

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CustomerID	STRING
ActionID	INTEGER
ChannelID	INTEGER
RecipientGroupID	INTEGER
CustomerAttributes	STRING
Date	STRING
TargetGroupID	INTEGER

CustomerOnetimeActionsByDate

Purpose: Fetch the details of customers and their marketing actions as a part of one time campaign on a particular group on a particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomerOneTimeActionsByDate

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CustomerID	STRING
ActionID	INTEGER
ChannelID	INTEGER
Date	STRING

CustomerOnetimeActionsByCampaign

Purpose: Fetch the details of customers and the details associated with a particular one-time campaign.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomerOneTimeActionsByCampaign

Replication: Key-Based Replication

Replication Key: campaignid

Fields

Name	Target Datatype
CustomerID	STRING
RecipientGroupID	INTEGER
ActionID	INTEGER
ChannelID	INTEGER
CustomerAttributes	STRING
CampaignID	INTEGER

CustomerFutureValues

Purpose: Fetch the details of future customers and their future values.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomerFutureValues

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
CustomerID	STRING
FutureValue	FLOAT

CustomerLastActionExecuted

Purpose: Fetch the details of last action executed for a particular customer.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomerLastActionExecuted

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
Date	STRING
ActionID	INTEGER
Duration	INTEGER
TargetGroupID	INTEGER
CustomerID	STRING

CustomerActionDetailsByDate

Purpose: Fetch the details of customer IDs and details of the campaigns sent to them on a particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomerActionDetailsByDate

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CustomerID	STRING
RecipientGroupID	INTEGER
ActionID	INTEGER
ChannelID	INTEGER
Date	STRING

CustomersActionEndedByDate

Purpose: Fetch the details of customer IDs and details of the campaigns they received, for action durations which ended on a particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomersActionEndedByDate

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CustomerID	STRING
ActionID	INTEGER
ChannelID	INTEGER
Date	STRING
Duration	INTEGER
TargetGroupID	INTEGER

CustomersSendFDetailsByCampaign

Purpose: Fetch the details of all customers and channels and their send times and channel send details for a particular campaign.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCustomerSendDetailsByCampaign

Replication: Key-Based Replication

Replication Key: campaignid

Fields

Name	Target Datatype
CustomerID	STRING
ChannelID	INTEGER
ScheduledTime	STRING
SendID	STRING
CampaignID	INTEGER

CustomerExecutionDetailsByCampaign

Purpose: Fetch the details of all customers and the details associated with each customer for a particular campaign.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCustomerExecutionDetailsByCampaign

Replication: Key-Based Replication

Replication Key: campaignid

Fields

Name	Target Datatype
CustomerID	STRING
ActionID	INTEGER
ChannelID	INTEGER
TemplateID	STRING
ScheduleTime	STRING
PromoCode	STRING
CampaignID	INTEGER

ProcessedCampaignCustomers

Purpose: Fetch the details od all customers and associated promotion codes for a particular campaign

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetProcessedCampaignCustomers

Replication: Key-Based Replication

Replication Key: campaignid

Fields

Name	Target Datatype
CustomerID	STRING
PromoCode	STRING
CampaignID	INTEGER

CurrentlyTargetedCustomers

Purpose: Fetch the details of customers and who are currently included in one or more campaigns

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCurrentlyTargetedCustomers

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
CustomerID	STRING
ActionID	INTEGER
CampaignID	INTEGER
StartDate	STRING
EndDate	STRING

CanceledCampaignCustomers

Purpose: Fetch the details of customers who’s campaignes were cancelled along with the associated actions and promo codes.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCanceledCampaignCustomers

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
CustomerID	STRING
ActionID	INTEGER
PromoCode	STRING
CampaignID	INTEGER

CustomerProductDetailsByCampaign

Purpose: Fetch the details of customers and recommended products for each customer targeted by a particular product recommendation campaign

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCustomerProductDetailsByCampaign

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
CustomerID	STRING
ProductID	STRING
ProductAttributes	STRING
CampaignID	INTEGER

CustomerProductDetailsByDate

Purpose: Fetch the details of customers and recommended products for each customer targeted by any product recommendation campaign on a particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCustomerProductDetailsByDate

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CustomerID	STRING
ProductID	STRING
ProductAttributes	STRING
Date	STRING

CustomerProductRecommendations

Purpose: Fetch the details of product recommendations generated for customers by Optimove

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCustomerProductRecommendations

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
CustomerID	STRING
ProductId	STRING
RecommendationType	INTEGER

CampaignInteractionCustomers

Purpose: Fetch the details of customers and their marketing actions as a part of one time campaign on a particular group on a particular date.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCampaignInteractionCustomers

Replication: Key-Based Replication

Replication Key: date

Fields

Name	Target Datatype
CampaignID	INTEGER
Date	STRING
ChannelID	INTEGER
TemplateID	INTEGER
EventID	INTEGER
CustomerID	STRING

CustomerChannelInteractions

Purpose: Fetch the details of customers and their templates , campaigns. For each customer who performed a particular interaction with a campaign that was delivered on a particular date via a particular channel.

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetCustomerChannelInteractions

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
CampaignID	INTEGER
Date	STRING
RecipientGroupID	INTEGER
ActionID	INTEGER
ChannelID	INTEGER
TemplateID	INTEGER
EventID	INTEGER
CustomerID	STRING

ExternalRealtimeCampaignCustomers

Purpose: Fetch the details of customers who scheduled to receive a realtime campaign by an external system on a particular date, along with associated details

Source API Documentation https://docs.optimove.com/api-usage-guide/#Customer-related_Functions_GetExternalRealtimeCampaignCustomers

Replication: Key-Based Replication

Replication Key: execution_date

Fields

Name	Target Datatype
CampaignID	INTEGER
CustomerID	STRING
PromoCode	STRING
TriggerID	INTEGER
ActionID	INTEGER
TargetGroupID	INTEGER
RecipientGroupID	INTEGER
CustomerAttributes	STRING
Date	STRING

ValueSegments

Purpose: Fetch the details of value segment details.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetValueSegments

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
ValueSegmentName	STRING
ValueSegmentID	INTEGER

CustomersByValueSegment

Purpose: Fetch the details of customers and their particular value segment at current time.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetCustomersByValueSegment

Replication: Key-Based Replication

Replication Key: valuesegmentid

Fields

Name	Target Datatype
CustomerID	STRING
ValueSegmentID	INTEGER

ValueSegmentChangers

Purpose: Fetch the details of customers in the database which changed value segments, along with their before and after value segment

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetValueSegmentChangers

Replication: Key-Based Replication

Replication Key: startdate

Fields

Name	Target Datatype
CustomerID	INTEGER
InitialValueSegmentID	INTEGER
FinalValueSegmentID	INTEGER

Promotions

Purpose: Fetch the details of promo codes and associated names and their updations and deletions

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetPromotions

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
PromoCode	STRING
PromotionName	STRING

ChannelTemplates

Purpose: Fetch the details of template and associated names that will be associated with a specified channel

Source API Documentation https://docs.optimove.com/api-usage-guide/#External_System_Integration_Functions_GetChannelTemplates

Replication: Key-Based Replication

Replication Key: channelid

Fields

Name	Target Datatype
TemplateID	INTEGER
TemplateName	STRING
ChannelID	INTEGER

ChannelTemplateDetails

Purpose: Fetch the details of content and attributes of a specific template for a specific channel

Source API Documentation https://docs.optimove.com/api-usage-guide/#External_System_Integration_Functions_GetChannelTemplateDetails

Replication: Key-Based Replication

Replication Key: channelid

Fields

Name	Target Datatype
TemplateID	INTEGER
TemplateContent	STRING
ChannelID	INTEGER

ExternalRealtimeTriggers

Purpose: Fetch the details of realtime triggers handled by an external system

Source API Documentation https://docs.optimove.com/api-usage-guide/#External_System_Integration_Functions_GetExternalRealtimeTriggers

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
TriggerID	STRING
TriggerName	STRING

ActivityEventList

Purpose: Fetch the details of all available custom SDK events with each event parameter's name and type.

Source API Documentation https://docs.optimove.com/api-usage-guide/#External_System_Integration_Functions_GetActivityEventList

Replication: Full Replication

Replication Key: NA

Fields

Name	Target Datatype
id	INTEGER
name	STRING
Event_Parameters	RECORD

TransactionalTemplateMetrics

Purpose: Fetch the details of post-execution metrics for a specific transactional mail template over time.

Source API Documentation https://docs.optimove.com/api-usage-guide/#GetTransactionalTemplateMetrics

Replication: Key-Based Replication

Replication Key: templateid

Fields

Name | Target Datatype --- | ---