Create or update an "A/B test" node of a Smart Campaign

1 min

POST

https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/abtest

Create or update an "A/B test" node of a Smart Campaign. You can enable and specify optimization mode and set predecessor and successor node.

Path Parameters

clientIdstringrequired
Description
Client ID
campaignIdinteger<int64>required
Description
Smart Campaign ID
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Form Parameters

optimization.scheduledAtstring<date-time>
Description
Dispatch time of the messages
Format
date-time
optimization.sto.enabledboolean
Description
If true, send time optimization is enabled. The "sto" parameters are only considered if one of the "optimization.scheduled" parameters is provided.
optimization.sto.typestring<DAY | WEEK>
Description
Type of send time optimization (can be combined with "optimization.scheduledAt" scheduler, DAY will be set by other)
Allowed
DAYWEEK
optimization.sto.fallbackAtstring<date-time>
Description
Fallback at time of send time optimization in ISO 8601 format (can be combined with "optimization.scheduledAt" scheduler)
Format
date-time
optimization.sto.optimizationEndsAtstring<date-time>
Description
Optimization ends at time of send time optimization in ISO 8601 format (can be combined with "optimization.scheduledAt" scheduler)
Format
date-time
optimization.enabledboolean
Description
If true, the automatic optimization is activated
optimization.scheduledWithDelaystring
Example
P4DT3H2M (4 days, 3 hours, 2 minutes)
Description
Duration in ISO 8601
optimization.scheduledManuallyboolean
Description
If true, the optimization is started manually
optimization.modestring<bestOpenRate | bestUniqueClickRate | bestClickRate | lowestUniqueUnsubscribe | lowestBounceRate | byPostClickValue>
Description
Optimization mode
Allowed
bestOpenRatebestUniqueClickRatebestClickRatelowestUniqueUnsubscribelowestBounceRatebyPostClickValue
optimization.sto.periodstring
Example
PT22H30M (22 hours 30 minutes)
Description
Duration of send time optimization in ISO 8601 format (only days (max. 1), hours and minutes (can be combined with "optimization.scheduledWithDelay" and "optimization.scheduledManually" schedulers)
predecessorNodeIdstring
Description
Predecessor node
successorNodeIdstring
Description
Successor node

Responses

200

The "A/B test" node was updated successfully.

RestSplitNode
- nodeIdstring
  Description
  Node ID
- optimizationRestSplitOptimization
  - enabledboolean
    Description
    If true, automatic optimization is enabled
  - modestring<bestOpenRate | bestUniqueClickRate | bestClickRate | lowestUniqueUnsubscribe | lowestBounceRate | byPostClickValue>
    Description
    Optimization mode
    Allowed
    bestOpenRatebestUniqueClickRatebestClickRatelowestUniqueUnsubscribelowestBounceRatebyPostClickValue
  - scheduledAtstring<date-time>
    Description
    Scheduled dispatch time
    Format
    date-time
  - stoRestPersonalizedSchedule
    Description
    Send time optimization settings
    - enabledboolean
      Description
      If true, send time optimization is enabled
    - typestring<DAY | WEEK>
      Description
      Period of time that is used for optimizing the sending of messages
      Allowed
      DAYWEEK
    - fallbackAtstring<date-time>
      Description
      Fallback time
      Format
      date-time
    - optimizationEndsAtstring<date-time>
      Description
      End time
      Format
      date-time
    - periodRestDelay
      Description
      Delay time
      - daysinteger<int32>
        Format
        int32
      - hoursinteger<int32>
        Format
        int32
      - minutesinteger<int32>
        Format
        int32
  - scheduledWithDelayRestDelay
    Description
    Delay time
    - daysinteger<int32>
      Format
      int32
    - hoursinteger<int32>
      Format
      int32
    - minutesinteger<int32>
      Format
      int32
  - scheduledManuallyboolean
    Description
    If true, the optimization is started manually
- successorsRestSplitSuccessor[]
  - nodeIdstring
    Description
    Node ID
  - namestring
    Description
    Node name
  - targetGroupFilter
    - namestring
  - relativenumber<float>
    Description
    Number of relative recipients in percent
    Format
    float
  - absoluteinteger<int32>
    Description
    Number of absolute recipients
    Format
    int32
  - linksobject[]
    - uriBuilderobject
    - relsstring[]
    - relstring
    - typestring
    - paramsmap<string, string>
    - titlestring
    - uristring<uri>
      Format
      uri
- linksobject[]
  Description
  Links for further requests
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri
- gridLocationPoint
  Description
  Grid location point
  - xinteger<int32>
    Format
    int32
  - yinteger<int32>
    Format
    int32

201

The "A/B test" node was created successfully.

RestSplitNode
- nodeIdstring
  Description
  Node ID
- optimizationRestSplitOptimization
  - enabledboolean
    Description
    If true, automatic optimization is enabled
  - modestring<bestOpenRate | bestUniqueClickRate | bestClickRate | lowestUniqueUnsubscribe | lowestBounceRate | byPostClickValue>
    Description
    Optimization mode
    Allowed
    bestOpenRatebestUniqueClickRatebestClickRatelowestUniqueUnsubscribelowestBounceRatebyPostClickValue
  - scheduledAtstring<date-time>
    Description
    Scheduled dispatch time
    Format
    date-time
  - stoRestPersonalizedSchedule
    Description
    Send time optimization settings
    - enabledboolean
      Description
      If true, send time optimization is enabled
    - typestring<DAY | WEEK>
      Description
      Period of time that is used for optimizing the sending of messages
      Allowed
      DAYWEEK
    - fallbackAtstring<date-time>
      Description
      Fallback time
      Format
      date-time
    - optimizationEndsAtstring<date-time>
      Description
      End time
      Format
      date-time
    - periodRestDelay
      Description
      Delay time
      - daysinteger<int32>
        Format
        int32
      - hoursinteger<int32>
        Format
        int32
      - minutesinteger<int32>
        Format
        int32
  - scheduledWithDelayRestDelay
    Description
    Delay time
    - daysinteger<int32>
      Format
      int32
    - hoursinteger<int32>
      Format
      int32
    - minutesinteger<int32>
      Format
      int32
  - scheduledManuallyboolean
    Description
    If true, the optimization is started manually
- successorsRestSplitSuccessor[]
  - nodeIdstring
    Description
    Node ID
  - namestring
    Description
    Node name
  - targetGroupFilter
    - namestring
  - relativenumber<float>
    Description
    Number of relative recipients in percent
    Format
    float
  - absoluteinteger<int32>
    Description
    Number of absolute recipients
    Format
    int32
  - linksobject[]
    - uriBuilderobject
    - relsstring[]
    - relstring
    - typestring
    - paramsmap<string, string>
    - titlestring
    - uristring<uri>
      Format
      uri
- linksobject[]
  Description
  Links for further requests
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri
- gridLocationPoint
  Description
  Grid location point
  - xinteger<int32>
    Format
    int32
  - yinteger<int32>
    Format
    int32

curl

curl --request POST \
     --url https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/abtest \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/x-www-form-urlencoded");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/abtest", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/abtest")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/x-www-form-urlencoded"

response = https.request(request)
puts response.read_body

python

import requests

url = "https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/abtest"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// The "A/B test" node was updated successfully.
{
  "nodeId": "",
  "optimization": {
    "enabled": false,
    "mode": "",
    "scheduledAt": "",
    "sto": {
      "enabled": false,
      "type": "",
      "fallbackAt": "",
      "optimizationEndsAt": "",
      "period": {
        "days": "",
        "hours": "",
        "minutes": ""
      }
    },
    "scheduledWithDelay": {
      "days": "",
      "hours": "",
      "minutes": ""
    },
    "scheduledManually": false
  },
  "successors": [
    {
      "nodeId": "",
      "name": "",
      "targetGroup": {
        "name": ""
      },
      "relative": "",
      "absolute": "",
      "links": [
        {
          "uriBuilder": {},
          "rels": [
            ""
          ],
          "rel": "",
          "type": "",
          "params": "",
          "title": "",
          "uri": ""
        }
      ]
    }
  ],
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ],
  "gridLocation": {
    "x": "",
    "y": ""
  }
}

201

// The "A/B test" node was created successfully.
{
  "nodeId": "",
  "optimization": {
    "enabled": false,
    "mode": "",
    "scheduledAt": "",
    "sto": {
      "enabled": false,
      "type": "",
      "fallbackAt": "",
      "optimizationEndsAt": "",
      "period": {
        "days": "",
        "hours": "",
        "minutes": ""
      }
    },
    "scheduledWithDelay": {
      "days": "",
      "hours": "",
      "minutes": ""
    },
    "scheduledManually": false
  },
  "successors": [
    {
      "nodeId": "",
      "name": "",
      "targetGroup": {
        "name": ""
      },
      "relative": "",
      "absolute": "",
      "links": [
        {
          "uriBuilder": {},
          "rels": [
            ""
          ],
          "rel": "",
          "type": "",
          "params": "",
          "title": "",
          "uri": ""
        }
      ]
    }
  ],
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ],
  "gridLocation": {
    "x": "",
    "y": ""
  }
}