Skip to main content

Migrate a Bid Model

Overview​

The Definitions and API Comparison tables highlight the shared terminology, actions and API methods between IQM and Beeswax for creating and managing Bid Modeling. 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​

IQMBeeswaxDescription
Bid ModelBid Model The set of optimizations applied to a Campaign or Insertion Order. These optimizations control where ads appear, manage priorities, and dimensions.
Bid Model DataTermsA Bid Model setting that adjusts a Campaign's base bid based on specified parameters.
DimensionTargeting KeyA 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 ModifierBid ModifierA multiplier applied to a base bid.
Spend RatioDelivery ModifiersA setting that determines how the Campaign budget is distributed across targeting dimensions.
Dimension PriorityWeightA 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**

*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.

API Comparison​

Base URLs
  IQM: https://app.iqm.com
  
  Beeswax: https://{buzz_key}.api.beeswax.com
ActionIQM EndpointBeeswax EndpointNotes
Add Bid ModelingPOST/api/v3/bm/campaigns/{campaignId}/bid-modelsPOST/rest/v2/bid-modifiers
Add Bid Modeling to Insertion Order/CampaignPUT/api/v3/bm/io/{ioId}/bid-modelsPOST/rest/v2/campaigns
POST/rest/v2/line-items		Add Bid Modeling 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 ModelingPATCH/api/v3/bm/campaigns/{campaignId}/bid-modelsPATCH/rest/v2/campaigns/{id}
PATCH/rest/v2/line-items/{id}
Add/Update Multiple Bid ModelsPUT/api/v3/bm/campaigns/{campaignId}/bid-modelsPATCH/rest/v2/campaigns/bulk
PATCH/rest/v2/line-items/bulk		IQM endpoint supports adding, updating, and deleting Bid Model data.
Get Bid Model DetailsGET/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/ref/bid-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 ManagementPOST/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:

Beeswax: