Browse the help center

Ad Server Fees API endpoints

Endpoint reference for the Ad Server Fees tag (4 endpoints): Administrators only: what the ad server charges this network — the pricing type, the fee plans with their rates, and which plan the network is on. Reading needs the Ad Server Fees console permission, changing anything needs Ad Server Fees Management

Reference network manager admin

Administrators only: what the ad server charges this network — the pricing type, the fee plans with their rates, and which plan the network is on. Reading needs the Ad Server Fees console permission, changing anything needs Ad Server Fees Management. 4 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.

GET /rest-api/ad-server-fees.do

Request examples

Read the network’s ad server fees.

No parameters beyond authentication.

Responses: 200 — {success, pricingType, activePlanId, activePlanName, editable, defaultAiPriceMultiplier, plans:[…]}. Errors follow the shared conventions.

POST /rest-api/ad-server-fees.do

Request examples

Change the pricing type or the network’s plan.

ParameterInTypeRequiredDescription
pricingTypeformstringnoHow impressions are charged: SPLIT (desktop, mobile and video rates), GLOBAL (one rate) or LEGACY Values: SPLIT, GLOBAL, LEGACY.
activePlanIdformintegernoThe plan the network is to run on; it replaces the one it is on now

Responses: 200 — {success, changed:[…], pricingType, activePlanId, activePlanName}. Errors follow the shared conventions.

GET /rest-api/ad-server-fees/months.do

Request examples

Read what each month was billed.

ParameterInTypeRequiredDescription
yearqueryintegernoOnly this calendar year
monthqueryintegernoOnly this month of the year, 1-12
limitqueryintegernoHow many months to return, 1-120. Default 12
startqueryintegernoTo page back: how many months to skip

Responses: 200 — {success, months:[{year, month, planId, planName, …charges}], returned, total, more}. Errors follow the shared conventions.

POST /rest-api/ad-server-fees/plans.do

Request examples

Change a fee plan’s rates, or add a plan.

ParameterInTypeRequiredDescription
idformintegernoThe plan to change; leave it out to add a plan
nameformstringnoWhat the plan is called, up to 128 characters
planPriceformnumbernoWhat the plan costs a month, before any overage
globalImpressionsformintegernoImpressions of every kind the plan includes; charged under GLOBAL pricing
desktopImpressionsformintegernoDesktop impressions the plan includes; charged under SPLIT pricing
mobileImpressionsformintegernoMobile impressions the plan includes; charged under SPLIT pricing
videoImpressionsformintegernoVideo impressions the plan includes; charged under SPLIT pricing
trafficAmountInGbformintegernoTraffic the plan includes, in GB
globalImpressionOverageCpmformnumbernoCharged per thousand impressions of any kind beyond what the plan includes
desktopImpressionOverageCpmformnumbernoCharged per thousand desktop impressions beyond what the plan includes
mobileImpressionOverageCpmformnumbernoCharged per thousand mobile impressions beyond what the plan includes
videoImpressionOverageCpmformnumbernoCharged per thousand video impressions beyond what the plan includes
trafficOveragePricePerGbformnumbernoCharged per GB of traffic beyond what the plan includes
premiumAccountformbooleannoWhether the plan is a premium account
premiumAccountPriceformnumbernoWhat a premium account adds to the monthly price
flexiblePriceformbooleannoCharge every impression at the prices below instead of only the ones beyond the plan
globalImpressionPriceCpmformnumbernoWith flexible pricing: charged per thousand impressions of any kind
desktopImpressionPriceCpmformnumbernoWith flexible pricing: charged per thousand desktop impressions
mobileImpressionPriceCpmformnumbernoWith flexible pricing: charged per thousand mobile impressions
videoImpressionPriceCpmformnumbernoWith flexible pricing: charged per thousand video impressions
hbFillsAsImpressionsformbooleannoCount a header-bidding fill won by other demand as an impression, at this plan’s rates
hbFillPriceCpmformnumbernoWhat a header-bidding fill costs per thousand when it is not counted as an impression
autoSwitchForwardBillingPlanIdformstringnoPlan to move up to when this one is outgrown; empty to clear
autoSwitchBackwardBillingPlanIdformstringnoPlan to fall back to when this one is not used up; empty to clear
aiEpomKeyEnabledformbooleannoLet this network run the AI assistant on the ad server’s own key, billed
aiPriceMultiplierformstringnoBilled AI cost is the list price times this, 1-100; empty for the platform default
aiPromoUntilformstringnoLast day (UTC) on which AI assistant calls cost the network nothing, yyyy-MM-dd; empty for no promo
aiPromoAllowanceUsdformstringnoWhat the promo waives for the whole network, in USD; empty for the platform default

Responses: 200 — {success, id, created, changed:[…], notCharged:{…}, plan:{…}} · 404 — No plan with that id. Errors follow the shared conventions.

Related pages

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.