View Zone

GET /zones/{id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/zones/{id}

Retrieves the details of a Zone that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Adex API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ zone ]
An array of all created items.
Zone
Name
Description
accountobject

Name
Description
idstring
Id of the account, same as account_id.


Example: 10073337
imagestring
A link to the account image.


Example: https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png
namestring
Name of the accound holder.


Example: John Smith
statusstring
Status of the account.


Example: active
account_idstring
A unique account identifier generated by the Ocamba platform.


Example: 10073337
algo_distributionobject

Name
Description
idnumber
Search algorithm id.


Example: 1000049
ratenumber
Describes the distribution rate of a Search algorithm. Minimum value is 0, maximum value is 100.


Example: 100
statusstring
Describes the status of a Search algorithm. Possible values are active and inactive.


Example: active

Possible values: active | inactive
bid_floorfloat
Minimum value is 0, maximum is 100. Required if bid_floor_priority is 1.


Example: 32.5
bid_floor_prioritynumber (integer)
Priority over bid floor in the request.

Possible values: 0 | 1
bid_omitnumber (integer)
Value of bid is omitted from the bidResponse if set to 1.


Example: 1

Possible values: 0 | 1
campaign_prioritystring
Campaign priority.


Example: compete

Possible values: local | bacfill | unfilled | compete

Default: compete
campaign_search_algostring
Campaign algorithm to choose a campaigns competing method.


Example: round-robin

Possible values: round-robin | multi-armed-bandit | internal-sort-by-bid

Default: round-robin
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 7196310
cpv_viewabilitynumber (integer)
cpv_viewability is taken into account only if pricing model is set to cpv (Cost-Per-View).


Example: 15
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
creatorobject

Name
Description
idstring
Id of the creator, same as creator_id.


Example: 1000225
imagestring
Image of the creator.


Example: https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png
namestring
Name of the creator.


Example: John Smith
statusstring
Status of the creator.


Example: active
creator_idstring
A unique creator identifier generated by the Ocamba platform.


Example: 1000225
descriptionstring
A more detailed description of the Zone.


Example: This is my first zone.
distributionnumber (int)
Describes the status of distribution, 0 - distribution is off 1 - distribution is on.


Example: 1

Possible values: 0 | 1
external_expl_ratenumber (integer)
The approximate rate of total bidRequests to chosen algorithm. Only external campaigns are affected and rate value is expressed in percentage. Not usable on round-robin. Minimum value: 0, maximum value: 100.


Example: 15

Default: 5
filterszone-filters
Filters object.
Zone Filters
Name
Description
flash_filternumber (integer)
Passthrough/block click and report as spam if requested caller browser does not support Flash.

Possible values: 0 | 1
ip_matchnumber (integer)
Passthrough/block click and report as spam if received IP does not match the requested one.


Example: 1

Possible values: 0 | 1
java_script_filternumber (integer)
Passthrough/block click and report as spam if requested caller browser does not support JavaScript.

Possible values: 0 | 1
max_click_delaynumber (integer)
Maximum time to allow click on the link to be valid from time link was generated, if delays are matched click is considered spam. Maximum value is 86400000.


Example: 86400000
min_click_delaynumber (integer)
Minimum time to allow click to be valid from the time the link was generated if the delay is matched click is considered spam. Maximum value is 100000.


Example: 1500
non_empty_referernumber (integer)
Passthrough/block click and report as spam if received HTTP referrer is empty.

Possible values: 0 | 1
policystring
Filter click policy.


Example: block

Possible values: block | passthrough
referrer_matchnumber (integer)
Passthrough/block click and report as spam if received referrer does not match the requested one.

Possible values: 0 | 1
user_agent_matchnumber (integer)
Passthrough/block click and report as spam if the received HTTP user agent does not match requested.

Possible values: 0 | 1
valid_user_agentnumber (integer)
Passthrough/block click and report as spam if the received HTTP user agent is not in the list of valid ones.

Possible values: 0 | 1
idstring
A unique identifier generated by the Ocamba platform.


Example: 3002792
namestring
Zone name.


Example: example_zone_name
pricing_modelstring
Assigning the wanted pricing model to bid modifier.


Example: cpc

Possible values: none | cpm | cpc | cpv
response_timeoutnumber (integer)
Defines minimum and/or maximum acceptable response time, expressed in milliseconds. Minimum value is 100, maximum 1000.


Example: 250
revenue_sharenumber (integer)
Value is expressed as a percentage of income shared with an advertiser. Minimum value is 0, maximum is 100. Changing the default value is limited by the subscription plan.


Example: 30

Default: 100
search_algo_expl_ratenumber (integer)
The approximate rate of total bidRequests to chosen algorithm. Only internal campaigns are affected and rate value is expressed in percentage. Not usable on round-robin. Minimum value: 0, maximum value: 100.


Example: 10

Default: 5
seatzone-seats
Seat object.
Zone Seat
Name
Description
itemsarray
If type is "account" every item must be unique and a valid account id. If type is "campaign" every item must be unique and a valid campaign id. If type is "campaign-group" every item must be unique and a valid group id. Maximum length is limited by subscription plan.


Example: 12343141,23526321,98761234
prioritynumber (integer)
Priority over query in request.


Example: 1

Possible values: 0 | 1

Default: 1
typestring
Describes type of zone seats.


Example: account

Possible values: account | campaign | campaign_group
statsobject

Name
Description
clicknumber
Number of clicks.


Example: 451
conversionnumber
Number of conversions.


Example: 661
fillnumber
Number of fills.


Example: 341
impressionnumber
Number of impressions.


Example: 111
requestnumber
Number of requests.


Example: 229
spam_clicknumber
Number of spam clicks.


Example: 113
statusstring
Zone status.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived
subid_hashobject

Name
Description
enabledinteger
Apply subid hashing to all campaigns.


Example: 1

Possible values: 0 | 1
keystring
Hashing key. The key may only contain letters, numbers, dashes and underscores.


Example: my_key
tagstring
Tag calculated by the Adex application.


Example: dev-feed.ocmxr.com/v1/display/AIvRnQAt0/M
targetingzone-targeting
Targeting object.
Zone Targeting
Name
Description
browsersobject

Name
Description
items[ object ]
Array of browser items, maximum length limited by subscription plan.
categoriesobject

Name
Description
items[ string ]
Array of valid category names supported by Ocamba, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type category, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
connectionsobject

Name
Description
items[ string ]
Array of valid connection types supported by Ocamba.
opstring



Example: nin

Possible values: in | nin
containersobject

Name
Description
items[ string ]
Array of strings containing containers ids. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
countriesobject

Name
Description
items[ string ]
Array of country codes supported by ocamba (ISO 3166-1, 2 letter country codes), maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type country, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
device_manufacturersobject

Name
Description
items[ string ]
Array of device manufacturer ids, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in | nin
device_trackingnumber (integer)
Describes the status of device tracking.


Example: 1

Possible values: 0 | 1
device_typesobject

Name
Description
items[ string ]
Array of device types, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in | nin
has_user_datanumber (integer)
Describes the availability of user data


Example: 1

Possible values: 0 | 1
ipobject

Name
Description
items[ string ]
Array of ips, each element must be a valid ipv4, ipv6 or cidr format for both v4 and v6, maximum length limited by subscription plan. Required if lists is not present.


Example: 123.523.123.4,123.523.123.4/12,2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23,2301:01b8:f5a3:43a1:afc2:8c2e:0370:7334
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type ip, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
languagesobject

Name
Description
items[ string ]
Array of unique strings. Each element must be a valid 2-letter language code supported by Ocamba platform, maximum number of items limited by subscription plan.
opstring



Example: nin

Possible values: in | nin
osobject

Name
Description
items[ object ]
Array of os items, maximum length limited by subscription plan.
pagesobject

Name
Description
items[ string ]
Array of domains, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type domain, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
regionsobject

Name
Description
items[ string ]
Array of region ids generated by the Ocamba platform, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type region, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
subidsobject

Name
Description
items[ string ]
Array of subids, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type subid, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
tagsobject

Name
Description
items[ string ]
Array of tag ids, maximum length limited by subscription plan. This field is deprecated and will be removed in future. Please use container as a replacement.
opstring



Example: in

Possible values: in | nin
timeobject

Name
Description
items[ string ]
Array of valid cron expressions, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in
track_idstring
A unique identifier generated by the Adex application.


Example: AIvRnQAt0/M
typestring
Zone type.


Example: rtb

Possible values: rtb | display | native | vast | widget | push | mobile-sdk | smartlink
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
user_cachenumber (integer)
Turn on/off user cache. Only available on push zones.


Example: 1

Possible values: 0 | 1
widgets[ string ]
Array of widget ids, created on the Ocamba platform, max 10 items. Available only for zones of type Widget.
totalinteger
A total number of items.


Example: 1

tip
1 If you don't know the zone id, list the zones to find it.
info
1 Widgets are only available for zones of type widget.
2 User_cache is only available for zones of type push.
3 The response example is representing a full view.

Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "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"
    }
  ]
}