List External demands

Copied

                https://api.ocamba.com/v2/adex/external-demands

Returns a list of External demands

query Parameters

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

pagestring

The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.

Example: page=1,10

sortstring

Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/adex/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/adex/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/adex/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Example: sort=-field1,field2

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/adex/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

idstring

External demands id.

Example: 123

typestring

Describe type of the object.

Example: type=type1

namestring

Name of the object.

Example: name=ExampleName

update_timestring

Timezone: GMT.

Example: update_time="2021-09-14"

create_timestring

Timezone: GMT.

Example: create_time="2021-09-14"

partner_idstring

External demand partner identifier generated by Ocamba.

Example: id=904

Response status codes

200 - OK

Name

Description

items[ external-demand ]

An array of all created items.

External demand

Name

Description

bid_regulatorinteger

External demand bid regulator.

Example: 70

company_idstring

A unique company identifier generated by the Ocamba platform.

Example: 1234123

create_timestring

Timezone: GMT.

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

idstring

A unique identifier generated by the Ocamba platform.

Example: 1815

ipv6_supportstring

IP version 6 support. Possible values are 0(supported) and 1(not supported).

Example: active

Possible values: 0 | 1

namestring

Name of the external demand.

Example: Demo external demand

partner_idstring

A unique partner identifier generated by Ocamba.

Example: 1234123

qpsobject

QPS object, number of queries per second by data centers. Minimal value by data center is 1, maximal 250000.

Example: { "am": 1000, "sg": 1000, "ny": 1000 }

settingsarray

Array of objects, external demand settings.

Example: [ { "label":"feed_id", "type":"string", "required":"1", "possible_values":null, "value":"123456" } ]

statusstring

External demand status. Possible values are active and verification.

Example: active

Possible values: active | verification

update_timestring

Timezone: GMT.

Example: 2021-10-30 14:27:26

totalinteger

A total number of items.

Example: 314

tip

1 Searchable field is name.

2 Sortable fields are: id, name, bid_regulator, create_time and update_time.

3 Filterable fields are: id, name, partner_id, status, create_time and update_time.

Response examples

Copied

200

{
  "total": 314,
  "items": [
    {
        "id": "123",
        "company_id": "6543210",
        "partner_id": "74",
        "name": "External demand 1",
        "settings": [
          {
              "label": "feed_id",
              "type": "string",
              "required": "1",
              "possible_values": null,
              "value": "5"
          }
        ],
        "bid_regulator": 100,
        "status": "active",
        "sync_status": "0",
        "ipv6_support": "1",
        "create_time": "2022-05-15 11:16:50",
        "qps": {
          "am": 250000,
          "ny": 1000
        }
    },
    {
        "id": "321",
        "company_id": "6543210",
        "partner_id": "108",
        "name": "External demand 2",
        "settings": [
          {
            "label": "feed_id",
            "type": "string",
            "required": "1",
            "possible_values": null,
            "value": "5"
          }
        ],
        "bid_regulator": 70,
        "status": "active",
        "sync_status": "0",
        "ipv6_support": "1",
        "create_time": "2022-05-17 11:55:19"
    }
  ]
}

{
  "total": 314,
  "items": [
    {
      "id": "1815",
      "company_id": "1234123",
      "partner_id": "1234123",
      "name": "Demo external demand",
      "settings": "[\n  {\n     \"label\":\"feed_id\",\n     \"type\":\"string\",\n     \"required\":\"1\",\n     \"possible_values\":null,\n     \"value\":\"123456\"\n  }\n] ",
      "bid_regulator": 70,
      "status": "active",
      "ipv6_support": "active",
      "qps": "{\n  \"am\": 1000,\n  \"sg\": 1000,\n  \"ny\": 1000\n}",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

List External demands

GET /external-demandsCopied https://api.ocamba.com/v2/adex/external-demands

GET /external-demands
Copied
`https://api.ocamba.com/v2/adex/external-demands`