List Bid Multipliers

πŸ“˜

GET https://api.kayzen.io/v1/campaigns/:campaign_id/bid_multipliers

Use this API to get a list of existing bid multipliers of a campaign

curl -X GET \
'https://api.kayzen.io/v1/campaigns/109451/bid_multipliers' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN'
{
    "bid_multipliers_enabled": true,
    "bid_multipliers" :[
        {  
            "type": "app_bundle",
            "key_name": "com.candycrush",
            "multiplier": 1.3
        },
        {
            "type": "app_id",
            "key_name": "12345678",
            "multiplier": 1.3
        },
        {
            "type": "auction_type",
            "key_name": "2",
            "multiplier": 1.3
        },
        {
            "type": "city_id",
            "key_name": "265148",
            "multiplier": 3.0
        },
        {
            "type": "connection_type",
            "key_name": "cellular",
            "multiplier": 3.0,
            "expiry_date": "2022-02-03 14:04:00 UTC"
        },
        {
            "type": "country_id",
            "key_name": "11",
            "multiplier": 1.1
        },
        {
            "type": "country_id",
            "key_name": "22",
            "multiplier": 1.3
        },
        {
            "type": "exchange_id",
            "key_name": "10035",
            "multiplier": 1.4,
            "expiry_date": "2022-01-24 14:04:00 UTC"
        },
        {
            "type": "has_device_id",
            "key_name": "0",
            "multiplier": 3.0
        },
        {
            "type": "state_id",
            "key_name": "99",
            "multiplier": 2.0
        },
        {
            "type": "rewarded_ad",
            "key_name": "1",
            "multiplier": 2.0
        }
    ]
}

The table below tells how to interpret key_name values for different types of bid multipliers

type

key_name values

app_bundle

App Bundle
Ex:com.instagram.android

app_id

Placement ID
Ex:10067-f0ee23ed-5017-478e-aeb8-206c3d93545f

auction_type

Auction Type

  • "1" for 1st price auction
  • "2" for 2nd price auction

exchange_id

Exchange ID, use Exchanges for reference

connection_type

Network Type

  • "cellular" for Cellular
  • "wifi" for Wi-Fi

has_device_id

Device Identifier

  • "0" No device identifier present
  • "1" Device Identifier is present

country_id

Country ID, use Countries for reference

state_id

State ID, use States for reference

city_id

City ID, use Cities for reference

rewarded_ad

Rewarded Ad

  • "0" for Non Rewarded
  • "1" for Rewarded