v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB
Actions

Executed Campaign Details

Returns details of every campaign executed on a particular date.

get/Actions/GetExecutedCampaignDetails

Query parameters

datestring date-time required

Response

Success

TargetGroupIDinteger

The ID of the target group to which the campaign is sent.

CampaignTypestring nullable

Possible results for CampaignType are:

  • Test/Control
  • A/B
  • A/B/N
  • Self-Optimizing
  • No Control
Durationinteger

The number of days the campaign is measured for.

LeadTimeinteger

The number of days between the day that the customer data is used to generate a campaign and the date on which the campaign is sent to customers.

Notesstring nullable

Notes added to the campaign.

IsMultiChannelboolean

Flag to indicate if the campaign will be sent to multiple channels.

IsRecurrenceboolean

Flag to indicate if the campaign is recurring.

Statusstring nullable

Possible results for Status are:

  • Processed(means the campaign was processed for execution, but hasn’t finished yet)
  • Successful
  • Partially Run
Errorstring nullable

The error message, if the campaign failed to execute.

CampaignIDinteger

The ID of the campaign Occurrence in Optimove.