IQM Platform Overview
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 by Advertisers (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.
| Entity | Description |
|---|---|
| Advertiser | A 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. Read more about IOs in our Help Center articles. |
| Campaign | A targeted advertising run that operates for a set period of time under specified optimization strategies. Read more about Campaigns in our Help Center articles. |
| Creative | The file containing the actual advertisement that a user is exposed to. This is commonly in graphical, video, or audio format. |
Advertising Relationships
The IQM platform contains various APIs (applications on the UI) which interact with, modify, and carry the details of, 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.
Insertion Orders 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.
| Action | Endpoint | Article |
|---|---|---|
| Insertion Order Details | /api/v3/cmp/io/basic/list | What is an Insertion Order? |
| Creating an IO | /api/v3/cmp/io/add | How to Create an Insertion Order |
| Update IO Budget | /api/v3/cmp/io/update-budget | |
| Assign Campaign Priority | /api/v3/bm/io/{ioId}/bid-models | What is Campaign Priority? |
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 Modeling 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 Report. A VLD 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.
| Action | Endpoint | Article |
|---|---|---|
| Campaign Details | /api/v2/cmp/campaign/{campaignId} | What is an Insertion Order vs. Campaign? |
| Creating a Campaign | /api/v3/cmp/pg/campaigns/add | How to Create an Insertion Order |
| Assign Conversions to Campaign | /api/v3/cmp/target/conversion /api/v3/conversion/assign-to/campaign | Choose your Conversion |
| Uploading a Matched Audience for a Campaign | /api/v2/audience/matched/add | Selecting an Audience for your Campaign |
| Add Bid Modelling to a Campaign | /api/v3/bm/campaigns/{campaignId}/bid-models | Set a Bid Strategy for your Campaign |
| Get a Metrics Report for a Given Campaign and Dimension | /api/v3/bm/campaigns/{campaignId}/reports/{dimensionId} | Reporting Dimensions Overview |
| Generate Voter Level Data Report | /api/v3/ins/vld-report | VLD Insights Report Overview |
| Inventory Optimization | /api/v2/inv/inventories/includeExclude | Select Inventories for your Campaign |
| Run a Report | /api/v3/ra/report/add | Generate, Manage, or Send a Report |
Creatives
Creatives are managed in the Creative API. Users can add and manage Creatives, get details, and create groups.
| Action | Endpoint | Article |
|---|---|---|
| Creative Details | /api/v3/crt/creatives/{creativeId} | Manage your Creatives |
| Add a Creative | /api/v3/crt/creatives | Add an Image to your Creative Library
Add an Audio File to your Creative Library Upload a Video Creative Add an HTML File to your Creative Library |
| Create a New Creative Group | /api/v3/crt/creatives/groups | |
| Add or Remove Creative to/from Group | /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. A Workspace User may have access to multiple Organizations/Advertisers, but may only have access to certain apps as determined by the Workspace.Insertion Orders and Campaigns are created at the Advertiser level. Organizations/Advertisers manage their own balances.
The following diagram and accompanying definitions further describe the relationships between these entities.
| Entity Description | |
|---|---|
| Workspace | A company that provides DSP service. Defines permissions and credentials for Customers. |
| Workspace User | An individual who uses the platform in a Workspace. Has advertisers assigned as customers. |
| Organization/Advertiser | An 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.
| Action | Endpoint | Article |
|---|---|---|
| User Invitation | /api/v3/ua/user/invite | Invite and Manage Users |
| User Sign-Up | /api/v3/ua/sign-up | Sign Up and Authentication (Quickstart Guide) |
| Add App Access for User | /api/v3/ua/user/application/add | Manage App Access for User |
| Create a Workspace | /api/v3/ua/workspace | |
| Organization Details | /api/v3/ua/organization/view-profile | Manage your Organization Profile |
| Organization Management | /api/v3/ua/organization/update-profile | |
| Customer Details | /api/v3/ua/customers/list | |
| Invite Customer to Platform | /api/v3/ua/customer/invite | |
| Advertiser Details | /api/v3/ua/organization/advertisers/list | |
| Add Advertiser Profile | /api/v3/ua/organization/advertiser/add | |
| Customer Finance Details | /api/v3/fa/customer/payments/list | |
| Invoice Management | Finance API | |
| Credit Management | Finance API | |
| Add Payment for Customer | /api/v3/fa/customer/payment/add |