List External demand partners

GET /external-demand-partners
Copied
Arrow
                https://api.ocamba.com/v2/adex/external-demand-partners

Returns a list of External demand partners

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
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
namestring
Name of the object.


Example: name=ExampleName
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.
exchange_typestring
External demand type, possible values are rtb and native.


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


Example: cpc
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: 283
tip
1 Searchable field is name.
2 Sortable field is name.
3 Filterable fields are id, name, exchange_type and pricing_model.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 283,
  "items": [
      {
          "id": "1",
          "name": "Example - Push CPC",
          "type": "native",
          "pricing_model": "cpc",
          "settings": [
              {
                  "label": "feed",
                  "type": "string",
                  "required": "1"
              },
              {
                  "label": "auth",
                  "type": "string",
                  "required": "1"
              }
          ]
      },
      {
          "id": "2",
          "name": "OcambaFeed - Pop CPC",
          "type": "native",
          "pricing_model": "cpc",
          "settings": [
              {
                  "label": "feed",
                  "type": "string",
                  "required": "1"
              },
              {
                  "label": "auth",
                  "type": "string",
                  "required": "1"
              }
          ]
      }
  ]
}

{
  "total": 283,
  "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]"
    }
  ]
}