Get per-variation results for a widget experiment
1 min
GET
/v1/widgets/{id}/experiments/{experimentId}/results
Path Parameters
- idstringrequiredPattern\d+
- experimentIdstringrequiredPattern\d+
Query Parameters
- websiteIdstringPattern\d+
- goalstringDescriptionPattern\d+
- compareMetricstring<Choice>DescriptionFormatChoiceAllowedconversionRatecompletionRategoalConversionRatevaluePerVisitorprofitPerVisitorextraValuePerVisitor
- filtersobjectDescription
- dateFromstring<date-time>Formatdate-time
- dateTostring<date-time>Formatdate-time
- devicestring[]
- browserstring[]
- osstring[]
- countrystring[]
- regionstring[]
- citystring[]
- utmSourcestring
- utmMediumstring
- utmCampaignstring
- utmContentstring
- utmTermstring
- referrerstring
- firstVisitPagestring
- visitorTypestring<new | returning>Allowednewreturning
- goalValuenumber
- zScorenumber
Responses
200
404
curl
curl --request GET \
--url '/v1/widgets/{id}/experiments/{experimentId}/results?websiteId=string&goal=string&compareMetric=conversionRate&filters=object' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("/v1/widgets/{id}/experiments/{experimentId}/results?websiteId=string&goal=string&compareMetric=conversionRate&filters=object", 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/widgets/{id}/experiments/{experimentId}/results?websiteId=string&goal=string&compareMetric=conversionRate&filters=object")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.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/widgets/{id}/experiments/{experimentId}/results?websiteId=string&goal=string&compareMetric=conversionRate&filters=object',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
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': 'GET',
'url': '/v1/widgets/{id}/experiments/{experimentId}/results?websiteId=string&goal=string&compareMetric=conversionRate&filters=object',
'headers': {
'accept': 'application/json',
'content-type': 'application/json'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
200
// Returned when successful
404
// Widget or experiment not found