Migrate a Bid Model

Migrate a Bid Model from Beeswax to IQM by comparing each platform's API methods for creating and managing Bid Model settings.

The definitions and API comparison tables highlight the shared terminology, actions and API methods between IQM and Beeswax for creating and managing Bid Model settings. Select an endpoint to review each platform's relevant API documentation. By comparing APIs, you can migrate your workflow from Beeswax to IQM.

For a comprehensive overview of IQM's Bid Model services, see the Bid Model API guidelines.

Definitions

IQM	Beeswax	Description
Bid Model	Bid Model	The set of optimizations applied to a campaign or insertion order. These optimizations control where ads appear, manage priorities, and dimensions.
Bid Model Data	Terms	A Bid Model setting that adjusts a campaign's base bid based on specified parameters.
Dimension	Targeting Key	A property in digital advertising used to categorize, filter, or analyze audiences, campaigns or inventories. Serves as a targeting parameter for Advertisers, specifying where an ad appears.
Bid Modifier	Bid Modifier	A multiplier applied to a base bid.
Spend Ratio	Delivery Modifiers	A setting that determines how the campaign budget is distributed across targeting dimensions.
Dimension Priority	Weight	A setting that dictates the order in which a campaign should attempt to deliver impressions based on the available budget.

NOTE

IQM's Bid Model currently supports applying Bid Modifiers to the following dimensions:

• Creative: Creative ID
• Location: State, City, ZIP code
• Inventory: Open Exchange, Publisher Category*, Deal ID**
• Device: Traffic Type, Device Type
• Exchange: Exchange ID
• Audience: Audience ID***

*Spend Ratios are not supported for the Publisher Category dimension subcategory. Refer to Spend Ratio overview Help Center article for more information.

**Bid Modifiers are not supported for the Deal ID dimension subcategory. Refer to the Bid Modifier overview Help Center article for more information.

***Spend Ratios and Allowlist/Blocklist targeting are not supported for the audience dimension.

API comparison

Base URLs

  IQM: https://api.iqm.com
  
  Beeswax: https://{buzz_key}.api.beeswax.com

Action	IQM endpoint	Beeswax endpoint	Notes
Add Bid Model settings	PUT/api/v3/bm/campaigns/{campaignId}/bid-models/{dimensionId}	POST/rest/v2/bid-modifiers
Add Bid Model settings to insertion order/campaign	PUT/api/v3/bm/io/{ioId}/bid-models	POST/rest/v2/campaigns POST/rest/v2/line-items	Add Bid Model settings to an insertion order and its associated campaigns. Beeswax endpoints use the bid_modifier_id parameter when creating/updating a Campaign or Line Item to add a Bid Modifier.
Update Bid Model settings	PUT/api/v3/bm/campaigns/{campaignId}/bid-models/{dimensionId}	PATCH/rest/v2/campaigns/{id} PATCH/rest/v2/line-items/{id}
Add/update multiple Bid Model settings		PATCH/rest/v2/campaigns/bulk PATCH/rest/v2/line-items/bulk	IQM endpoint supports adding, updating, and deleting Bid Model data.
Get Bid Model details	GET/api/v3/bm/campaign/{campaignId}/dimensions/bid-models/count GET/api/v3/bm/campaigns/{campaignId}/dimension/{dimensionId}/spent POST/api/v3/bm/campaigns/{campaignId}/bid-models/dimensions/{dimensionId}	GET/rest/v2/models GET/rest/v2/bid-modifiers GET/rest/v2/bid-modifiers/{id} GET/rest/v2/bid-modifiers/{id}/campaigns GET/rest/v2/bid-modifiers/{id}/line-items	IQM endpoints get counts of dimensions, spending by dimension, and modeled items count by campaignId. Beeswax endpoints get lists of Bid Models, Bid Modifiers, and lists of Campaigns and Line items by Bid Modifier ID.
Include/exclude management	POST/api/v2/cmp/deviceType/includeExclude POST/api/v2/cmp/exchange/includeExclude POST/api/v2/cmp/trafficsource/includeExclude POST/api/v3/bm/campaigns/{campaignId}/include-Exclude/dimensions/{dimensionId}	POST/rest/v2/bid-modifiers PUT/rest/v2/bid-modifiers/{id} PATCH/rest/v2/bid-modifiers/{id}	IQM has separate endpoints for including/excluding device types, exchanges, traffic sources, and dimensions. Beeswax specifies include/exclude options with the targeting_key parameter when creating/updating a Bid Modifier.

More Bid Model resources

IQM:

• Bid Model API guidelines
• Create a Bid Model tutorial
• Advanced modeling Help Center article

Beeswax:

• Bid Modifiers
• Delivery Modifiers
• Supported Targeting Keys