Skip to main content

IQM platform overview

IQM is a powerful DSP platform that employs many of the familiar principles of advertising technology. This page will cover the common entities, hierarchies, and relationships used by IQM.

Advertising hierarchy​

In IQM's organizational framework, insertion orders are the parent hierarchy of advertising. They are created at the Advertiser level (read more in the Organization hierarchy section) with campaigns as their child hierarchy. Campaigns are composed of creatives.

The following diagram and accompanying definitions further describe the relationships between these entities.

EntityDescription
AdvertiserA user or Customer on the IQM platform that places advertisements with a media partner.
Insertion Order (IO)A contract between an Advertiser and media partner that specifies the details and parameters of an advertising campaign. Refer to Insertion orders (IO) overview for more information.
CampaignA targeted advertising run that operates for a set period of time under specified optimization strategies. Refer to Media planning and campaign setup for more information.
CreativeThe file containing the actual ad that a user is exposed to. This is commonly in graphical, video, or audio format. Refer to Creatives and specifications for more information.

Advertising relationships​

The IQM platform contains various APIs (applications on the UI) which interact with, retrieve the details of, and modify each advertising entity.

This section will cover some of those relationships and feature tables of common actions and their associated endpoints and Help Center articles.

Insertion orders​

Insertion orders are managed in the Campaign API. You can create and modify IOs, duplicate existing IOs, adjust an IO's budget, and delete IOs.

IOs specify important parameters for their campaigns. They dictate the length of time for an advertising campaign and the budget parameters. They can also return details for campaigns grouped by IO IDs.

The Bid Model API also contains important functions for IOs. You can fine-tune advertising targeting strategies by assigning priority metrics to groups of campaigns by their IO ID.

ActionEndpointArticle
Get insertion order detailsPOST/api/v3/cmp/io/basic/listInsertion orders (IO) overview
Create an IOPOST/api/v3/cmp/io/addInsertion orders (IOs)
Update IO budgetPATCH/api/v3/cmp/io/update-budget
Assign campaign priorityPUT/api/v3/bm/io/{ioId}/bid-modelsCampaign priority overview

Campaigns​

Campaigns are primarily managed in the Campaign API: you can create campaigns, get details, and assign conversions with the Campaign API. Among other functions, campaigns specify important parameters for their associated creatives, they dictate the audience targeting, inventory placement, optimization strategies, assigning conversions, and reporting data.

These APIs also interact with campaigns in important ways:

  • Bid Model API - allows you to add Bid Model strategies to campaigns. It can also generate a metrics report by chosen dimensions to evaluate a campaign's performance.
  • Conversions API - allows you to assign created conversions to a campaign. This can also be managed in the Campaign API.
  • Insights API - allows you to generate a Voter Level Data (VLD) Insights report. A VLD Insights report evaluates ad exposure, demographic data, and voting history details.
  • Inventory API - allows you to select inventories for ad placement for a campaign.
  • Reports API - allows you to generate, manage, and send reports on campaigns.
ActionEndpointArticle
Get campaign detailsGET/api/v2/cmp/campaign/{campaignId}Campaigns overview
Create a campaignPOST/api/v2/cmp/campaigns/addCreate or manage a campaign
Create a PG campaignPOST/api/v3/cmp/pg/campaigns/add
Assign conversions to a campaignPOST/api/v3/conversion/assign-to/campaign
PATCH/api/v3/conversion/assign-to/campaign
Conversions and tracking
Upload a Matched audience for a campaignPOST/api/v2/audience/matched/addCreate or manage a matched audience
Manage a Bid ModelPUTapi/v3/bm/campaigns/{campaignId}/bid-models/{dimensionId}Manage a campaign's optimization and delivery settings
Get a metrics report for a given campaign and dimensionPOST/api/v3/bm/campaigns/{campaignId}/reports/{dimensionId}Reporting dimensions overview
Generate voter level data reportPOST/api/v3/ins/vld-reportVoter Level Data (VLD) Insights report overview
Campaign inventory targetingPOST/api/v2/inv/inventories/includeExcludeAssign Private Marketplace (PMP) deals or inventory groups to a campaign
Run a reportPOST/api/v3/ra/report/addGenerate, manage, or send a report

Creatives​

Creatives are managed in the Creative API. Users can add and manage creatives, get details, and create groups.

ActionEndpointArticle
Get creative detailsGET/api/v3/crt/creatives/{creativeId}Creatives and specifications
Add a creativePOST/api/v3/crt/creativesAdd creatives
Create a new creative groupPOST/api/v3/crt/creatives/groupsManage creatives and creative groups
Add or remove creative to/from groupPOST/api/v3/crt/creatives/groups/modify-creatives

Organization hierarchy​

Workspaces are one of the core entities of IQM's organizational hierarchy. Workspace access allows you to:

  • Manage multiple accounts within an agency on the IQM platform.
  • Manage the permissions and credentials of assigned Organizations/Advertisers (known as Customers in this relationship) so they can access reporting and audiences.
  • Perform financial operations related to margins, costs, invoices, and credits.
  • Access real-time data and reporting across assigned Customers in one place.

Organizations/Advertisers, once assigned to a Workspace User:

  • Place advertisements with the DSP service.
  • Create and manage insertion orders and campaigns.
  • Manage their own balances.

A Workspace User may have access to multiple Organizations/Advertisers, but may only have access to certain apps as determined by the Workspace.

The following diagram and accompanying definitions further describe the relationships between these entities.

EntityDescription
WorkspaceAn agency account that defines permissions and credentials for Customers.
Workspace UserAn individual who uses the platform in a Workspace. A Workspace User has Advertisers assigned as their Customers.
Organization/AdvertiserAn Organization is any company that places advertisements and is assigned to a Workspace User.
When invited as a Customer, an Organization is created with details including its name, website, and location details.

Organization relationships​

Organizations, Workspaces, and Users are primarily managed in the User Management API and the related Workspace API. The Finance API also manages the various financial relationships that exist between Workspaces and Advertisers.

ActionEndpointArticle
Send user invitationPOST/api/v3/ua/user/inviteInvite and manage users
Sign up userPOST/api/v3/ua/sign-upSign up and authentication
Add app access for userPOST/api/v3/ua/user/application/addInvite and manage users - Manage a user's app access
Create a WorkspacePOST/api/v3/ua/workspace
Organization detailsGET/api/v3/ua/organization/view-profileOrganization management
Organization managementPATCH/api/v3/ua/organization/update-profile
Get Customer detailsGET/api/v3/ua/customers/list
Invite Customer to platformPOST/api/v3/ua/customer/invite
Get Advertiser detailsGET/api/v3/ua/organization/advertisers/list
Add Advertiser profilePOST/api/v3/ua/organization/advertiser/add
Get Customer finance detailsGET/api/v3/fa/customer/payments/list
Invoice managementFinance API guidelines
Credit managementFinance API guidelines
Add payment for CustomerPOST/api/v3/fa/customer/payment/add
Have a question?
Was this page helpful?