View External demand

GET /external-demands/{id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/external-demands/{id}

Retrieves the details of an External demand that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
external demand id.


Example: 116
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[ external-demand-partners ]
An array of all created items.
External demand partners
Name
Description
exchange_typestring
External demand type, possible values are rtb and native.


Example: rtb
idstring
A unique identifier generated by the Ocamba platform.


Example: 117
namestring
Name of the exchange.


Example: MyExchange
pricing_modelstring
External demand partner pricing model, possible values are cpc and cpm.


Example: cpc
settingsarray
Array of objects, integration settings. Required parameters defined and provided by the integration partner.


Example: [ { "label": "feed", "type": "string", "required": "1" }, { "label": "auth", "type": "string", "required": "1" } ]
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the external demand id, list the external demands to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
      {
          "id": "123",
          "company_id": "6543210",
          "partner_id": "74",
          "name": "New external demand",
          "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-06-11 11:16:50",
          "qps": {
              "am": 1000,
              "sg": 1000,
              "ny": 1000
          }
      }
  ]
}

{
  "total": 1,
  "items": [
    {
      "id": "117",
      "name": "MyExchange",
      "exchange_type": "rtb",
      "pricing_model": "cpc",
      "settings": "[\n  {\n      \"label\": \"feed\",\n      \"type\": \"string\",\n      \"required\": \"1\"\n  },\n  {\n      \"label\": \"auth\",\n      \"type\": \"string\",\n      \"required\": \"1\"\n  }\n]"
    }
  ]
}