OPoptimove
Customers

Campaign Engagement Metrics

Returns the details of a particular customer’s interactions with scheduled and triggered campaigns sent during a particular date range.

get/Customers/GetCampaignEngagementMetrics

Request

  • Base URL
    https://api4.optimove.net
  • URL
    https://api4.optimove.net/Customers/GetCampaignEngagementMetrics
  • Auth
    API key in header X-API-KEY

Query parameters

CustomerIDstring required

The identifier of a customer in your customer database.

StartDatestring date-time required
EndDatestring date-time required
ChannelIDinteger

The identifier of a particular campaign execution channel.

Response

Success

Datestring nullable
CampaignIDinteger
RecipientGroupIDinteger

A single numeric digit indicating a Recipient Group ID. 1 for single groups, 0 for control groups, and 1, 2, etc. for multiple groups or A/B/n campaigns.

ActionIDinteger

The Action ID is Optimove's unique ID for each action.

ChannelIDinteger

The identifier of a particular campaign execution channel.

TemplateIDinteger
EventIDinteger

Valid values for EventID are:

  • 2 = Opened
  • 3 = Clicked
  • 4 = Unsubscribed
  • 5 = Dropped
  • 6 = SpamReport
  • 9 = Bounced
  • 16 = triggered
CommunicationTypestring nullable

Valid values for CommunicationType are:

  • scheduled
  • triggered

Changes

No recorded changes to this operation across all 2 revisions of this API.