List widgets
1 min
GET
/v1/widgets
Query Parameters
- websiteIdstringPattern\d+
- offsetintegerDescriptionDefault0Minimum0
- limitintegerrequiredDescriptionDefault100Minimum1Maximum500
- activestring<Choice>DescriptionFormatChoiceAllowedtruefalse
- typestring<Choice>DescriptionFormatChoiceAllowedpopupcalloutbarembedded
Responses
200
- Widget[]
- idinteger
- namestringrequiredMin Length1Max Length255
- clicksintegerDefault0
- viewsintegerDefault0
- conversionsintegerDefault0
- goalsReachedintegerDefault0
- valueintegerDefault0
- extraValueintegerDefault0
- submitsintegerDefault0
- completionsintegerDefault0
- contactsintegerDefault0
- createDatestring<date-time>Formatdate-time
- updateDatestring<date-time>Formatdate-time
- activebooleanDefaultfalse
- typestringrequired
- startDatestring<date-time>Formatdate-time
- endDatestring<date-time>Formatdate-time
- primaryGoalIdinteger
curl
curl --request GET \
--url '/v1/widgets?websiteId=string&offset=integer&limit=100&active=true&type=popup' \
--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?websiteId=string&offset=integer&limit=100&active=true&type=popup", 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?websiteId=string&offset=integer&limit=100&active=true&type=popup")
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?websiteId=string&offset=integer&limit=100&active=true&type=popup',
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?websiteId=string&offset=integer&limit=100&active=true&type=popup',
'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
[
{
"id": 0,
"name": "",
"clicks": 0,
"views": 0,
"conversions": 0,
"goalsReached": 0,
"value": 0,
"extraValue": 0,
"submits": 0,
"completions": 0,
"contacts": 0,
"createDate": "",
"updateDate": "",
"active": false,
"type": "",
"startDate": "",
"endDate": "",
"primaryGoalId": 0
}
]