List Bid strategies

GET /bid-strategies
Copied
Arrow
                https://api.ocamba.com/v2/adex/bid-strategies

Display a list of existing bid strategies

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
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
Unique bid strategy id.


Example: 1411
strategystring
Type of strategy.


Example: strategy=price_add
valuefloat
value of the bid strategy.


Example: value=2.00
is_defaultnumber (integer)
Specifying default status of bid strategy.


Example: is_default=1
pricing_modelstring
Assigning the wanted pricing model to bid strategy.


Example: pricing_model=cpc
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ bid-strategies ]
An array of all created items.
Bid Strategy
Name
Description
create_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
idstring
Unique bid strategy id.


Example: 10000
is_defaultnumber (integer)
Determines if Strategy is default.

Possible values: 0 | 1
max_valuefloat
Maximum value of the bid strategy.


Example: 11.03
namestring
Name of the bid strategy.


Example: DemoBidStrategy
pricing_modelstring
Assigning the wanted pricing model to bid strategy.


Example: cpc

Possible values: cpc | cpm
strategystring
Better description.


Example: exact

Possible values: exact | floor_add | floor_multiply | price_add | price_multiply | external_bid_add | external_bid_multiply
typestring
Type of strategy. Internal Strategy can be attached only to internal Campaign. External Strategy can be attached only to external Campaign.


Example: internal

Possible values: internal | external
update_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
valuefloat
Value of the bid strategy.


Example: 87.32
totalinteger
A total number of items.


Example: 1
tip
1 Searchable fields are name and id.
2 Sortable fields are: name, value, max_value, strategy, is_default, create_time and update_time.
3 Filterable fields are: id, name, pricing_model, is_default, percent_value, max_value, is_default, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
      {
          "id": "1411",
          "company_id": "6197120",
          "name": "123",
          "pricing_model": "cpc",
          "type": "internal",
          "strategy": "exact",
          "value": 0.5,
          "max_value": 3,
          "is_default": 1,
          "create_time": "2022-07-14 08:23:32",
          "update_time": "2022-07-22 10:39:13"
      }
  ]
}

{
  "total": 1,
  "items": [
    {
      "id": "10000",
      "name": "DemoBidStrategy",
      "pricing_model": "cpc",
      "type": "internal",
      "strategy": "exact",
      "value": 87.32,
      "max_value": 11.03,
      "create_time": "2021-09-29 15:40:10",
      "update_time": "2021-09-29 15:40:10"
    }
  ]
}