IQM Developer Documentation

website·Indexed 35 days ago

https://developers.iqm.com

Technical documentation and API guidelines for the IQM platform. Includes detailed references for the Campaign, Creative, Reports, Insights, Finance, Workspace, and Asset APIs. Provides tutorials for creating Programmatic Guaranteed (PG) campaigns, managing matched audiences, and optimizing inventory, as well as migration guides for transitioning from Xandr, The Trade Desk, and Beeswax.

Tokens
96.5K
Snippets
452
Records
641
Agent score
57%

What's inside IQM

  1. Overview of IQM Conversion Types

    The Conversions API supports three distinct tracking methods for ad campaign user traffic:

    • Pixel: Client-side tracking with advanced settings for fine-tuned optimization.
    • Postback: Server-to-server tracking that sends data directly from the user's server to IQM, bypassing browser-based JavaScript or cookies.
    • Universal Pixel: Client-side tracking using a single JavaScript snippet to track multiple conversion events across a site without requiring separate per-page pixels.
  2. Overview of IQM Bid Model tools

    The Bid Model API allows for the optimization of advertising campaigns by fine-tuning where ads appear, managing priority, and subdividing campaigns by dimensions. It provides three primary tools:

    • Spend Ratio: Distributes the campaign budget across dimensions as a percentage. It can be Strict (budget is allocated up to the percentage but may underspend) or Flexible (budget reallocates if the specified percentage cannot be fulfilled).
    • Dimension Priority: Sets the bidding sequence for targeting dimensions using a range of 1-10.
    • Bid Modifier: Adjusts the campaign's base bid for a specific dimension using a multiplier ranging from 0.1 to 100.
  3. Overview of IQM Contextual Audiences

    IQM Contextual audiences group users based on their online activity. Users are added to an audience when they visit sites relevant to specified keywords and/or URLs within a target timeframe.

    There are two types of data collection periods:

    • Static: A fixed timeframe between two dates within the last 180 days (maximum duration of 90 days).
    • Dynamic: A rolling timeframe of up to the last 90 days from the current date, with data refreshing every 24 hours.
  4. Overview of IQM Insights Report Types

    IQM provides several analytics tools to identify trends and adjust campaigns. The available report types include:

    • Audience Quality (AQ) Insights: Uses PurpleLab third-party healthcare data to confirm audience exposure based on prescriptions, diagnoses, and procedures.
    • Script Lift Study (SLS) Insights: Details prescribing behaviors and the influence of healthcare campaigns.
    • Provider Level Data (PLD) Insights: Details about targeted healthcare professionals, adhering to privacy regulations.
    • Nurse Level Data (NLD) Insights: Visibility into Non-NPI nurse engagement, including ad-exposure, demographics, and physician-specialty data.
    • Integrated Care Team (ICT) Insights: Details about targeted ICT audiences.

    Note: PLD, SLS, and AQ reports are not accessible to Advertiser users by default and must be enabled by an administrator. Access can be verified via the Get Customer config details endpoint.

  5. Overview of IQM Audience Types

    The Audience API supports various audience types for campaign targeting based on specific data sources and behaviors:

    • Matched audience: Created by uploading CSV or XLSX files matched against IQM's user database.
    • Retargeted audience: Based on tracking tags installed on a website to retarget visitors.
    • Geofarmed audience: Defined by custom geographical areas.
    • Campaign audience: Retargets an audience associated with a specific campaign.
    • Segmented audience: Groups users by common characteristics.
    • Pre-bid audience: Groups multiple pre-bid segments together.
    • Contextual audience: Users added based on visits to sites with specific keywords or URLs.
    • Lookalike audience: Generated based on an existing audience with specified size and similarity.
    • ABM audience: Account Based Marketing audience for Healthcare campaigns.
    • ICT audience: Integrated Care Team audience (a type of Matched audience) for healthcare expansion.
    • Custom Voter audience: Political campaign audiences based on demographic, psychographic, and behavioral attributes.
  6. Overview of IQM Reporting API

    The IQM APIs provide ad-serving reporting data in JSON format. Reports are categorized as either daily (includes date as a dimension) or aggregated.

    Data Constraints:

    • Most dimension combinations support up to three months of data.
    • The campaign dimension supports up to one year of data.
    • If more data is required, multiple reports must be executed.
  7. Overview of IQM Reports API

    The IQM Reports API allows developers to create customized reports using ad-serving reporting data in JSON format. Reports can be 'daily' (including date as a dimension for data breakdown) or 'aggregated'.

    Data Constraints:

    • Maximum of three months of data for most dimension combinations.
    • Maximum of one year of data specifically for the campaign dimension.
    • If more data is required, multiple reports must be executed.
  8. Overview of the IQM Dashboard API

    The Dashboard API enables the creation and management of dashboard configurations. It allows users to monitor real-time campaign performance and customize filters and metrics. Additionally, it provides access to CampaignPulse, which surfaces automated diagnostic checks and severity counts to monitor campaign health.
  9. Overview of IQM Private Deal Types

    IQM offers two types of private deals via the Inventory API:

    1. Private Marketplace (PMP): An invitation-only auction where advertisers purchase ad inventory.
    2. Programmatic Guaranteed (PG): A direct negotiation between one publisher and one advertiser for a fixed amount of inventory at a pre-negotiated price, providing budget predictability and avoiding auction volatility.
  10. Overview of IQM Insights report types

    IQM Insights reports provide analytics to identify trends and optimize campaign results. Available report types include:

    • Campaign Bidding Insights: Analyzes rejected campaigns by reason to identify limiting parameters.
    • Audience Insights: Detailed reports on audience characteristics, interests, and behaviors.
    • Power Segment Insights (PSI): Audience data for political personality segments (available to political vertical Advertisers only).
    • Audience Quality (AQ) Insights: Uses PurpleLab healthcare data to confirm exposure based on prescriptions, diagnoses, and procedures.
    • Voter Level Data (VLD) Insights: Targeting info for political campaigns, including ad exposure, engagement, demographics, and voting history.
    • Script Lift Study (SLS) Insights: Details on prescribing behaviors influenced by healthcare campaigns.
    • Provider Level Data (PLD) Insights: Details on targeted healthcare professionals.
    • Nurse Level Data (NLD) Insights: Engagement, demographic, and physician-specialty data for Non-NPI nurses.
    • Integrated Care Team (ICT) Insights: Details on targeted ICT Audiences.

    Note: VLD, PLD, SLS, and AQ reports are disabled by default and require administrator enablement. Access can be verified via the Get Customer config details endpoint.

  11. Overview of Campaign API concepts

    The Campaign API is used to create and manage campaigns and insertion orders (IOs).

    • Campaigns: Targeted ad runs that operate for a specific period using defined optimization strategies.
    • Insertion orders (IOs): The parent hierarchy to campaigns; these define the contracts between an Advertiser and a media partner, as well as the general parameters of an ad campaign.