Suggest CPM floor rate

Calculates a suggested CPM floor rate for a specific advertiser, campaign type, operating system, and geo targeting configuration.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do

Calculates a suggested CPM floor rate for a specific advertiser, campaign type, operating system, and geo targeting configuration. The suggested rate is computed from all matching floor rates adjusted by the advertiser's selfServeCpmFloorAdjustment multiplier. Country codes in the 'geo' parameter can be prefixed with '-' to exclude those countries instead of including them. Returns HTTP 404 if the advertiser, campaign type, or matching CPM rates cannot be found.

Query Params

campaignType string required

Self-serve campaign type. Accepts enum name or integer ID for backward compatibility

BANNER_DESKTOP

advertiser integer required

Unique numeric identifier of the advertiser whose CPM floor adjustment will be applied to the suggested rate

1001

os string

Comma-separated operating system names or IDs (e.g. 'WINDOWS,ANDROID' or '1,5'). When omitted, all operating systems are included.

WINDOWS,ANDROID

geo string

Comma-separated ISO 3166-1 alpha-2 country codes (e.g. 'US,GB,DE'). Prefix the entire value with '-' to exclude those countries instead of including them. Use '0' or '*' for global targeting. When omitted, all countries are included.

US,GB

Responses

200

JSON object with 'SuggestedCPM' key containing the calculated floor rate value

400

Missing or invalid required parameters

401

Authentication error - invalid hash, timestamp, or username

403

No VIEW share on the advertiser

404

Advertiser not found, campaign type not recognized, or no matching CPM rates exist

500

Internal server error during rate calculation

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs/suggest.do?campaignType=BANNER_DESKTOP&advertiser=1001&os=WINDOWS%2CANDROID&geo=US%2CGB")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body