List Zones
List Zones
GET
https://api.ocamba.com/v2/adex/zones
Returns a list of ZonesQuery parameters
parametersResponse schemas
›
200
application/json
curl -X GET \
"https://api.ocamba.com/v2/adex/zones" \
-H "Authorization: Bearer {TOKEN}"const url = 'https://api.ocamba.com/v2/adex/zones';
const options = {
method: 'GET',
headers: {
Authorization: `Bearer {TOKEN}`
}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}$ch = curl_init("https://api.ocamba.com/v2/adex/zones");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer {TOKEN}"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);Responses
200 OK
{
"total": 92,
"items": [
{
"id": "3002792",
"company_id": "7196310",
"account_id": "10073337",
"account": {
"id": "10073337",
"name": "John Smith",
"status": "active",
"image": "https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png"
},
"creator_id": "1000225",
"creator": {
"id": "1000225",
"name": "John Smith",
"status": "active",
"image": "https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png"
},
"track_id": "AIvRnQAt0/M",
"tag": "dev-feed.ocmxr.com/v1/display/AIvRnQAt0/M",
"name": "example_zone_name",
"description": "This is my first zone.",
"status": "active",
"type": "rtb",
"pricing_model": "cpc",
"campaign_priority": "compete",
"campaign_search_algo": "round-robin",
"distribution": 1,
"algo_distribution": {
"id": 1000049,
"rate": 100,
"status": "active"
},
"search_algo_expl_rate": 10,
"external_expl_rate": 15,
"response_timeout": 250,
"revenue_share": 30,
"bid_floor": 32.5,
"bid_omit": 1,
"cpv_viewability": 15,
"subid_hash": {
"key": "my_key",
"enabled": 1
},
"user_cache": 1,
"widgets": [
"788"
],
"targeting": {
"countries": {
"items": [
"RS"
],
"lists": [
"1838"
],
"op": "in"
},
"regions": {
"items": [
"2661876"
],
"lists": [
"2934"
],
"op": "in"
},
"subids": {
"items": [
"fut_t10_18-24-MULTI_GG"
],
"lists": [
"1835"
],
"op": "in"
},
"ip": {
"items": [
null
],
"lists": [
"2691"
],
"op": "in"
},
"pages": {
"items": [
"ocamba.com"
],
"lists": [
"2725"
],
"op": "in"
},
"categories": {
"items": [
[
"IAB1",
"IAB1-1",
"IAB2"
]
],
"lists": [
"2725"
],
"op": "in"
},
"tags": {
"items": [
"1303"
],
"op": "in"
},
"containers": {
"items": [
"1020"
],
"op": "in"
},
"device_types": {
"items": [
"console"
],
"op": "in"
},
"device_manufacturers": {
"items": [
"13"
],
"op": "in"
},
"os": {
"items": [
{
"id": "12",
"op": "in",
"versions": [
"10.0"
]
}
]
},
"browsers": {
"items": [
{
"id": "10",
"op": "in",
"versions": [
"10.0"
]
}
]
},
"connections": {
"items": [
"1"
],
"op": "nin"
},
"time": {
"items": [
"[0,15,30,45 12,13,14 * 6 1]"
],
"op": "in"
},
"languages": {
"items": [
"sr"
],
"op": "nin"
},
"device_tracking": 1,
"has_user_data": 1
},
"filters": {
"policy": "block",
"ip_match": 1,
"max_click_delay": 86400000,
"min_click_delay": 1500
},
"seat": {
"type": "account",
"items": "12343141,23526321,98761234",
"priority": 1
},
"stats": {
"request": 229,
"fill": 341,
"impression": 111,
"click": 451,
"spam_click": 113,
"conversion": 661
},
"create_time": "2021-10-29 12:47:00",
"update_time": "2021-10-30 14:27:26"
}
]
}
Responses
Tip
Searchable fields are name and description.
Sortable fields are name, status, pricing_model, create_time, update_time.
Filterable fields are id, name, status, type, pricing_model, campaign_priority, campaign_search_algo, response_timeout, distribute, create_time and update_time.
Info
Widgets are only available for zones of type widget.
User_cache is only available for zones of type push.
The response example is representing a full view.