Start a campaign (sets active=true)
1 min
POST
/v1/campaigns/{id}/start
Path Parameters
- idstringrequiredPattern\d+
Query Parameters
- websiteIdstringPattern\d+
Responses
200
- Campaign
- idinteger
- namestringrequiredMin Length1Max Length255
- descriptionstringMax Length2048
- typestringDefaultpersonalization
- goalsReachedintegerDefault0
- viewsintegerDefault0
- valueintegerDefault0
- createDatestring<date-time>Formatdate-time
- updateDatestring<date-time>Formatdate-time
- startDatestring<date-time>Formatdate-time
- endDatestring<date-time>Formatdate-time
- activebooleanDefaultfalse
- controlShareintegerDefault5Minimum0Maximum100
- trafficAllocationintegerDefault10Minimum0Maximum100
- targetIdinteger
- targetModestringDefaultlive
- primaryGoalIdinteger
- significanceLevelintegerDefault90Allowed809095100
- methodologystring<bayesian | frequentist>DefaultfrequentistAllowedbayesianfrequentist
- powerintegerDefault80Minimum60Maximum99
- mdenumber<float>Default20FormatfloatMinimum1Maximum100
403
404
curl
curl --request POST \
--url '/v1/campaigns/{id}/start?websiteId=string' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("/v1/campaigns/{id}/start?websiteId=string", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("/v1/campaigns/{id}/start?websiteId=string")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = http.request(request)
puts response.read_body
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '/v1/campaigns/{id}/start?websiteId=string',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => array(
'accept: application/json',
'content-type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
nodejs
var request = require('request');
var options = {
'method': 'POST',
'url': '/v1/campaigns/{id}/start?websiteId=string',
'headers': {
'accept': 'application/json',
'content-type': 'application/json'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
200
// Campaign started
{
"id": 0,
"name": "",
"description": "",
"type": "",
"goalsReached": 0,
"views": 0,
"value": 0,
"createDate": "",
"updateDate": "",
"startDate": "",
"endDate": "",
"active": false,
"controlShare": 0,
"trafficAllocation": 0,
"targetId": 0,
"targetMode": "",
"primaryGoalId": 0,
"significanceLevel": 0,
"methodology": "",
"power": 0,
"mde": ""
}403
// Token does not have write scope
404
// Campaign not found