Search CPM floor rates

Retrieves a list of self-serve CPM floor rates filtered by campaign type, operating system, world region, and geo-location country codes.

Reference

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

Retrieves a list of self-serve CPM floor rates filtered by campaign type, operating system, world region, and geo-location country codes. The query parameters are bound into a CampaignCpmFloorRateQuery object; if the region parameter is specified, the region is resolved to its constituent country codes before filtering. A missing or unknown campaignType or os is answered with a 400 naming it. Requires REST API authentication.

Query Params

campaignType integer required

Self-Serve campaign type ID (1=BANNER_DESKTOP, 2=BANNER_MOBILE, 3=BANNER_APPLICATION, 4=BANNER_NATIVE, 5=POP_UNDER, 6=INTERSTITIAL_MOBILE, 7=INTERSTITIAL_APPLICATION)

1

os integer required

Operating system ID, as listed by the operating-system targeting values

1

geo array<string>

Array of country codes, '*' being global

US

region integer

World region ID — resolves to constituent country codes

150

Responses

200

CPM floor rates retrieved successfully as a JSON array of CampaignCpmFloorRate objects

400

Missing or invalid required parameters (campaignType, os)

401

Authentication error - invalid hash, timestamp, or username

403

Insufficient permissions to access this resource

500

Internal server error during rate lookup

503

The geo service did not answer while resolving the region

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs.do?campaignType=1&os=1&geo=US&region=150' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs.do?campaignType=1&os=1&geo=US&region=150", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/floorCPMs.do?campaignType=1&os=1&geo=US&region=150', {
  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.do?campaignType=1&os=1&geo=US&region=150"))
    .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.do?campaignType=1&os=1&geo=US&region=150");
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.do?campaignType=1&os=1&geo=US&region=150", 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.do?campaignType=1&os=1&geo=US&region=150");
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.do?campaignType=1&os=1&geo=US&region=150")
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