Skip to main content
Feedback

Optimove walkthrough

Prerequisites

Optimove connection.

  1. Make sure to select the right Optimove connection. Change it or create a new one if necessary.
  2. Select a report in the Report drop-down.

Report details

#ReportEndpointSupported Filters
1Customers by Actioncustomers/GetCustomersByActionActions, Time Period
2Customer Actions by Target Groupcustomers/GetCustomerActionsByTargetGroupTarget Groups, Execution Channels, Time Period
3Customer One Time Actions by Datecustomers/GetCustomerOneTimeActionsByDateTime Period
4Customer One Time Actions by Campaigncustomers/GetCustomerOneTimeActionsByCampaignExecution Channels, Time Period
5Customer Attribute Changerscustomers/GetCustomerAttributeChangersChanged Customer Attribute
6Customer Future Valuescustomers/GetCustomerFutureValuesLifecycle Stage, OR Customer Attribute
7Customer Action Details by Datecustomers/GetCustomerActionDetailsByDateTime Period
8Customer Action Ended by Datecustomers/GetCustomersActionEndedByDateTime Period
9Customer Execution Details by Campaigncustomers/GetCustomerSendDetailsByCampaignExecution Channels, Time Period
10Customer Send Details by Campaigncustomers/GetCustomerSendDetailsByCampaignExecution Channels, Time Period
11Customer Send Details by Channelcustomers/GetCustomerSendDetailsByChannelExecution Channel, Time Period
12Currently Targeted Customerscustomers/GetCurrentlyTargetedCustomers–
13Customer Product Details by Datecustomers/GetCustomerProductDetailsByDateTime Period
14Campaign Interaction Customerscustomers/GetCampaignInteractionCustomersExecution Channels, Events, Time Period
15Customers Activity Event Attributescustomers/GetCustomersActivityEventAttributesActivity Events, Time Period
16Target Groups by Dategroups/GetTargetGroupsByDateTime Period
17Target Group Detailsgroups/GetTargetGroupDetails–
18All Actionsactions/GetAllActions–
19Actions by Target Groupactions/GetActionsByTargetGroupTarget Groups, Time Period
20Promo Codesactions/GetPromoCodesTime Period
21Promo Codes by Campaignactions/GetPromoCodesByCampaignExecution Channels, Time Period
22Promo Codes by Target Groupactions/GetPromoCodesByTargetGroupTarget Groups, Time Period
23Action Details by Target Groupactions/GetActionDetailsByTargetGroupTarget Groups, Time Period
24Executed Campaign Detailsactions/GetExecutedCampaignDetailsTime Period
25Execution Channelsactions/GetExecutionChannels–
26Executed Campaign Channel Detailsactions/GetExecutedCampaignChannelDetailsExecution Channels, Time Period
27Executed Campaigns by Channelactions/GetExecutedCampaignsByChannelExecution Channels, Time Period
info
  • The Customers by Actions report will be executed to all values of RecipientGroupID from 0 to 9.
  • For those reports that lets you specify the Customer Attributes, each Customer Attribute will be returned as a separate column. You can get up to 10 attributes at once.
  • Some Optimove endpoints support filtering by CampaignID value. Data Integration does not support this filtering: instead, you should define Date Range and Execution Channels so that the report includes the data for all Campaigns that was executed within specified Date Range via defined Execution Channels.

To learn more on the Optimove API, refer to the Usage guide.

Reports' time period

Some of the reports have date filters, so you can configure it by selecting the time period of the report.

(Two kinds of the time period filters:)
  • Date range:
    • Pulls data in the date range between the start and end date provided, including the end date.
    • You must select a start date.
    • Leaving the end date empty pulls data up to the current time of the river's run.
    • Select a timezone offset to send dates considering the offset.
    • Use the Last Days Back For Each Run to expand the start date and pull data a given number of days back before the chosen start date.
  • Predefined date- A date range defined by Data Integration:
    • Day: Yesterday.
    • Week (From Monday to Sunday): Week to date, Previous week, Previous week to date.
    • Month: Month to date, Previous month, Previous month to date.
    • Year: Year to date.

Interval chunks

Data Integration can run over the increment using chunks to make the loading efficient and precise, for large amounts of data. You can choose from:

  • Don't Split: Data Integration pulls the data from the chosen start date to the end date in one bulk.
  • Daily: The run is chunked daily from the start to the end date.
  • Monthly: The run is chunked monthly from the start to the end date.
  • Yearly (Less Recommended): The run is chunked yearly from the start to the end date.

Interval size: Set the size of each interval. For example, setting the Interval Size to 4 with a Daily Interval Chunk splits the date period into 4 days chunks. Running from the 01/01/2020 until the 08/01/2020 will be split into two intervals: from the 01/01/2020 until the 04/01/2020 and from the 05/01/2020 until the 08/01/2020.

API rate limits: Each client is limited to calling the API 2000 times per hour.

On this Page