Audience API

The Audience API allows you to create different types of audiences for campaign targeting based on desired specifications.

See the Healthcare and Political verticals for specialized Audience API capabilities.

The following table describes each type of audience:

Type	Description
Matched audience	Upload a CSV or XLSX file with audience details which is then matched with IQM's user database to create a custom audience segment.
Retargeted audience	Add a tracking tag to your website allowing you to track users who visit so they can be retargeted to receive ads in the future.
Geofarmed audience	Define an audience by a custom geographical area.
Campaign audience	Retarget an audience associated with a campaign.
Segmented audience	Group users by common characteristics to reach specific target audiences.
Pre-bid audience	Select multiple pre-bid segments and group them together into an audience.
Contextual audience	IQM adds users to an audience when they visit sites featuring specified keywords or URLs.
Lookalike audience	Analyzes an existing audience and generates a new one based on specified size and similarity percentage.
ABM audience	Account Based Marketing (ABM) audience for Healthcare campaigns.
ICT audience	An Integrated Care Team (ICT) audience is a type of Matched audience intended for healthcare-audience expansion. See the Healthcare vertical for more information.
Custom Voter audience	Audiences for Political campaigns based on voter segments which are defined by a combination of demographic, psychographic, and behavioral attributes.

More resources

• Create a Contextual audience quickstart guide
• Upload a Matched audience tutorial
• Audience targeting and data management Help Center article

Authentication

Use the following header parameters for all requests:

Headers
Authentication string required	Authentication bearer token. See Sign up and authenticate.
X-IAA-OW-ID integer required	Organization Workspace ID header.

Audience details

Audience details list

POST

Get a list of audiences with basic details by desired filters.

An audience id can be used to get more details in type-specific details endpoints. For example, a "Matched audience" id can be used in the Matched audience details endpoint to get more details.

The id can also be used to perform various actions in Audience management PUT/PATCH endpoints.

Request schema
audienceIds array of integers	Audience IDs to filter by.
audienceTypeIds array of integers	Audience type IDs to filter by. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
audienceSubtypeIds array of integers	Audience subtype IDs to filter by. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
owIds array of integers	Organization Workspace IDs to filter by.
audienceStatusIds array of integers	Audience status IDs to filter by. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
includeGenericAudience boolean	Include generic audiences.
audienceTypeIdsWithAllSubtypes array of integers	Audience type IDs to include all subtypes. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
pageNo integer	Page number of retrieved data.
noOfEntries integer	Number of entries returned per page.
sortBy string	Sorts results by specified field.
searchFields array	Filter results by search fields.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceTypeId integer	Audience type ID. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
cpm number	Cost per thousand impressions.
createdAt integer	Creation timestamp (epoch milliseconds).
reach integer	Audience reach.
verticalId integer	Vertical ID. +Supported values 1 Political 2 Healthcare 3 Specialty
organizationName string	Organization name.
runningCampaignCount integer	Number of running campaigns.
pendingCampaignCount integer	Number of pending campaigns.
pausedCampaignCount integer	Number of paused campaigns.
expiredCampaignCount integer	Number of expired campaigns.
startDate integer	Start date (epoch milliseconds).
endDate integer	End date (epoch milliseconds).
timezone integer	Timezone ID.
regeneratedCount integer	Number of times regenerated.
matchRate number	Match rate percentage.
fileTotalCount integer	Total number of files.
s3FileName string	S3 file name.
approvalAccess boolean	Approval access permission.
editAccess boolean	Edit access permission.

JSON

Request sample

{
  "audienceIds": [
    1003879,
    1003880
  ],
  "audienceTypeIds": [
    1,
    2
  ],
  "audienceSubtypeIds": [
    3,
    4
  ],
  "owIds": [
    12345,
    67890
  ],
  "audienceStatusIds": [
    1,
    2
  ],
  "includeGenericAudience": true,
  "audienceTypeIdsWithAllSubtypes": [
    1,
    2
  ],
  "pageNo": 1,
  "noOfEntries": 20,
  "sortBy": "audienceName",
  "searchFields": [
    "test audience",
    123456
  ]
}

Response 200

{
    "success": true,
    "data": {
        "totalRecords": 16,
        "filteredRecords": 16,
        "audienceList": [
            {
                "audienceId": 1142228,
                "audienceName": "Copy of Matched Audience Example",
                "audienceTypeId": 1,
                "audienceStatusId": 6,
                "createdAt": 1755812128000,
                "reach": 0,
                "verticalId": 1,
                "organizationName": "Conor's Org",
                "runningCampaignCount": 0,
                "pendingCampaignCount": 0,
                "pausedCampaignCount": 0,
                "expiredCampaignCount": 0,
                "matchRate": 0.0,
                "fileTotalCount": 5,
                "s3FileName": "1743014162776_matched_audience_example.csv",
                "approvalAccess": false,
                "editAccess": false
            },
            {
                "audienceId": 1141935,
                "audienceName": "Test",
                "audienceTypeId": 2,
                "audienceStatusId": 6,
                "createdAt": 1755208780000,
                "reach": 0,
                "verticalId": 1,
                "organizationName": "Conor's Org",
                "runningCampaignCount": 0,
                "pendingCampaignCount": 0,
                "pausedCampaignCount": 0,
                "expiredCampaignCount": 0,
                "matchRate": 0.0,
                "approvalAccess": false,
                "editAccess": false
            }
        ]
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        responseObject: {
          id: number;
          audienceName: string;
          audienceType: number;
          isVoterAudience: boolean;
          status: string;
          statusDisplayName: string;
          createdOn: number;
          dataCost: number;
          uniques: number;
        }[];
      };
    };
  };
}

function getAudienceDetails(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v2/audience/list',
    params: {
      query?: {
        owIds?: `string`,
        audienceTypeIds?: `string`,
        searchField?: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Basic audience details

POST

Get a basic list of audience details.

Request schema
audienceIds array of integers	Audience IDs to filter by.
audienceTypeIds array of integers	Audience type IDs to filter by. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
audienceSubtypeIds array of integers	Audience subtype IDs to filter by. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
owIds array of integers	Organization Workspace IDs to filter by.
audienceStatusIds array of integers	Audience status IDs to filter by. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
includeGenericAudience boolean	Include generic audiences.
pageNo integer	Page number of retrieved data.
noOfEntries integer	Number of entries per page.
sortBy string	Sorts results by specified field.
searchFields array	Filter results by search fields.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceTypeId integer	Audience type ID. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
audienceSubtypeId integer	Audience subtype ID. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
isIqmIdTargeted boolean	Indicates if IQM ID targeted.
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
createdOn integer	Creation timestamp (epoch seconds).
cpm number	Cost per thousand impressions.
reach integer	Audience reach.

Request sample

{
  "audienceIds": [
    1003879,
    1003880
  ],
  "audienceTypeIds": [
    1,
    2
  ],
  "audienceSubtypeIds": [
    3,
    4
  ],
  "owIds": [
    12345,
    67890
  ],
  "audienceStatusIds": [
    1,
    2
  ],
  "includeGenericAudience": true,
  "pageNo": 1,
  "noOfEntries": 20,
  "sortBy": "audienceName",
  "searchFields": [
    "test audience",
    123456
  ]
}

Response 200

{
  "success": true,
  "data": {
    "totalRecords": 874,
    "filteredRecords": 874,
    "audienceBasicList": [
      {
        "audienceId": 1,
        "audienceName": "Sample audience name 1",
        "audienceTypeId": 1,
        "audienceSubtypeId": 1,
        "isIqmIdTargeted": true,
        "audienceStatusId": 1,
        "createdAt": 1653510068,
        "cpm": 1.5,
        "reach": 18850783
      }
    ]
  }
}

---

Audience count by status

POST

Get a count of audiences by status type.

Request schema
searchField string	Filter results by search field.
owIds string	Organization Workspace IDs.
audienceTypeIds string	Audience type IDs. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience

Response properties

audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
audienceCount integer	Audience count.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "audienceStatusId": 1,
            "audienceCount": 2
        },
        {
            "audienceStatusId": 3,
            "audienceCount": 10
        },
        {
            "audienceStatusId": 6,
            "audienceCount": 4
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          audienceStatusId: number;
          audienceCount: number;
        }[];
      };
    };
  };
}

function GetStatuswiseaudiencecount(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/count-by-status',
    params: {
      query: {
        searchField: `string`,
        owIds: `string`,
        audienceTypeIds: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Audience count by type

GET

Get an audience count by audience type.

Response properties

audienceTypeId integer	Audience type ID. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
audienceCount integer	Audience count.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "audienceTypeId": 1,
      "audienceCount": 10
    },
    {
      "audienceTypeId": 2,
      "audienceCount": 25
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          audienceTypeId: number;
          audienceCount: number;
        }[];
      };
    };
  };
}

function getAudienceTypeWiseCount(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/count-by-type',
    params: {
      query?: {
        audienceTypeIds?: `string`,
        status?: `string`,
        searchField?: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Audience count by data partner

POST

Get an audience count by data partner ID.

Request schema
audienceTypeId integer	Audience type ID. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
owIds string	Organization Workspace IDs.

Response properties

dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
audienceCount integer	Audience count.

Request sample

{
  "audienceTypeIds": [
    2,
    4
  ],
  "owIds": [
    201427,
    201865
  ]
}

Response 200

{
  "success": true,
  "data": [
    {
      "dataPartnerId": 1,
      "audienceCount": 10
    },
    {
      "dataPartnerId": 2,
      "audienceCount": 25
    }
  ]
}

---

Audience management

Update audience name

PATCH

Update the name of an existing audience.

Path parameters
audienceId integer	Audience ID to update.

Request schema
audienceName string	New audience name.

Request sample

{
  "audienceName": "Updated Audience Name"
}

Response 200

{
  "success": true,
  "data": {
    "message": "Changes saved successfully"
  }
}

---

Regenerate audience

PATCH

Regenerate a failed audience.

Path parameters
audienceId integer	Audience ID to regenerate.

Response 200

{
  "success": true,
  "data": {
    "message": "Audience regeneration initiated successfully"
  }
}

---

Get audience Insights

GET

Get a demographic and geographic profile of an audience, returned as a set of chart-ready widgets (for example, age, gender, and state distribution). Each row in a widget includes both the raw count and the percent of the audience in that segment.

This endpoint only returns insight content for audiences that resolve to an actual set of individual matched user profiles.

Path parameters
audienceId integer	Audience ID to get Insights for.

Response properties

audienceId string	Audience ID.
audienceName string	Audience name.
audienceDate string	Audience snapshot date (YYYY-MM-DD format) — not a report time period.
verticalId string	Vertical ID. +Supported values 1 Political 2 Healthcare 3 Specialty
vertical string	Vertical name.
widgets array of objects	Chart-ready insight widgets. The set of widgets, and the field names inside each widget's data rows, vary by audience and vertical, the fields below are one example (an "age" widget), not a fixed schema.
widgets object properties title string Widget dimension (e.g. age, gender, state). type string Chart type (e.g. pie, geo). data array of objects One row per segment/bucket. Field names vary by widget, shown below for an "age" widget. data object properties (example: "age" widget) srNo integer Row number. age string Segment/bucket label. Named after the widget's dimension, a state widget uses a state key here instead. audienceValue(Absolute) string Count of the audience in this segment. audienceValue(%) number Percent of the audience in this segment. nationalAvg(%) number National average for this segment, for comparison. Currently always -1 — not yet populated for any audience. delta number Difference between the audience value and the national average. Currently always -1 — not yet populated for any audience.

Response 200

{
  "success": true,
  "data": {
    "audienceId": "48703",
    "audienceName": "Segmented1",
    "audienceDate": "2026-04-10",
    "verticalId": "2",
    "vertical": "Healthcare",
    "widgets": [
      {
        "title": "age",
        "type": "pie",
        "data": [
          {"srNo": 1, "age": "18-20", "audienceValue(Absolute)": "213,109", "audienceValue(%)": 1.16, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 2, "age": "21-24", "audienceValue(Absolute)": "963,673", "audienceValue(%)": 5.24, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 3, "age": "25-34", "audienceValue(Absolute)": "1,977,732", "audienceValue(%)": 10.75, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 4, "age": "35-44", "audienceValue(Absolute)": "2,222,194", "audienceValue(%)": 12.08, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 5, "age": "45-54", "audienceValue(Absolute)": "3,008,447", "audienceValue(%)": 16.36, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 6, "age": "55-64", "audienceValue(Absolute)": "3,655,374", "audienceValue(%)": 19.88, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 7, "age": "65+", "audienceValue(Absolute)": "6,273,522", "audienceValue(%)": 34.11, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 8, "age": "Unknown", "audienceValue(Absolute)": "77,618", "audienceValue(%)": 0.42, "nationalAvg(%)": -1, "delta": -1}
        ]
      },
      {
        "title": "state",
        "type": "geo",
        "data": [
          {"srNo": 1, "state": "Alabama", "audienceValue(Absolute)": "166,606", "audienceValue(%)": 0.91, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 2, "state": "Alaska", "audienceValue(Absolute)": "15,383", "audienceValue(%)": 0.08, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 3, "state": "Arizona", "audienceValue(Absolute)": "220,809", "audienceValue(%)": 1.2, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 4, "state": "Arkansas", "audienceValue(Absolute)": "94,993", "audienceValue(%)": 0.52, "nationalAvg(%)": -1, "delta": -1},
          {"srNo": 5, "state": "California", "audienceValue(Absolute)": "1,147,806", "audienceValue(%)": 6.24, "nationalAvg(%)": -1, "delta": -1}
          ...
        ]
      }
    ]
  }
}

---

Create Audience Insights report

POST

Generate an Audience Insights report for any given audience IDs.

This is the same mechanism as the Insights API's Create Audience Insights report endpoint.

The id returned here identifies the report. Track its status through the Insights API's Get a list of Insights reports, and once ready, retrieve it via Download Insights report.

info

An audience must meet the following eligibility criteria to generate Audience Insights report:

• Must be Matched audience type
• Audience status: "ready"
• Audience reach: 10,000+
• (Recommended) Audience creation date within the last year

Request schema
audienceIds array of integers	Audience IDs.

Response properties

invalidSourceIds array of integers	Audience IDs not eligible for Insights.
insightsData object	Insights data details.
insightsData object properties id integer Insights ID. typeId integer Insights type ID. statusId integer Insights status ID. sourceName string Source audience name. name string Insights name. sourceId integer Audience ID. createdAt integer Unix epoch timestamp of Insights creation.

JSON

Response 200

{
  "success": true,
  "data": {
    "invalidSourceIds": [
      1233
    ],
    "insightsData": [
      {
        "id": 1003,
        "typeId": 1,
        "statusId": 1,
        "sourceName": "Audience - 1",
        "name": "Audience - 1_insights",
        "sourceId": 12345,
        "createdAt": 1689155409179
      },
      {
        "id": 1100,
        "typeId": 1,
        "statusId": 1,
        "sourceName": "audience 2",
        "name": "audience 2_insights",
        "sourceId": 54321,
        "createdAt": 1689155409179
      }
    ]
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          invalidSourceIds: number[];
          insightsData: {
            id: number;
            typeId: number;
            statusId: number;
            sourceName: string;
            name: string;
            sourceId: number;
            createdAt: number;
          }[];
        };
      };
    };
  };
}

function createInsightsForMatchedAudience(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/insights/add',
    params: {
      query: {       
        audienceIds: `string`
      }
    },
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Attach data partner

POST

Attach a data partner to a Geofarmed audience or a Contextual audience.

Request schema
audienceId integer	Audience ID.
dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID

Request sample

{
  "audienceId": 124,
  "dataPartnerId": 7
}

Response 200

{
  "success": true,
  "data": {
    "message": "Data partner attached successfully."
  }
}

---

Delete audience

DELETE

Delete an audience. This endpoint first checks two validations before deleting an audience:

1. User's access to audience IDs
2. Whether audience IDs are attached to any campaigns.

If the user is not authorized to delete an audience, or the audience IDs are attached to a campaign, the request returns an error.

Query parameters
audienceIds array of integers	Audience IDs.

Response properties

successfulAudienceIds array of integers	Audience IDs successfully deleted.
failedAudienceIds array of integers	Audience IDs not eligible for deletion.

JSON

Response 200

{
  "success": true,
  "data": {
    "successfulAudienceIds": [
      123456,
      123457
    ],
    "failedAudienceIds": []
  }
}

More responses

Response 400

{
  "statusCode": 400,
  "responseObject": {
    "errorMsg": "Request body either not provided or not valid.",
    "errorCode": 400,
    "description": "uri=/api/v2/audience/delete"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        statusCode: number;
        responseObject: {
          audienceFailedIds: string[];
          message: string;
          audienceSuccessfulIds: number[];
          status: boolean;
        };
      };
    };
  };
}

function DeleteAudience(): Promise<Responses> {
  const options = {
    method: 'PUT',
    url: 'https://api.iqm.com/api/v2/audience/delete',
    requestBody: {
      content: {
        "application/json": {
          audienceIds: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Matched audiences

Matched audience details

GET

Get Matched audience details by ID.

Path parameter
audienceId string	Matched audience ID.

Query parameters
campaignTargetingRequired boolean optional	Flag to indicate if campaign targeting details are returned, default: false.
userDetailsRequired boolean optional	Flag to indicate if user details are returned, default: false.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceSubtypeId integer	Audience subtype ID. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
cpm number	Cost per thousand impressions.
owId integer	Organization Workspace ID.
createdByUowId integer	Created by User Organization Workspace ID.
createdAt integer	Unix epoch creation date (milliseconds).
reach integer	Audience reach.
s3FileName string	Audience file name.
s3Url string	S3 URL of the audience file.
fileRowCount integer	Number of rows in the file.
matchRate number	The percentage of matched records compared to a reference set.
dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
modifiedAt string	Modified date (ISO 8601 format).
approvalAccess boolean	Indicates if user has access to approve.
editAccess boolean	Indicates if user has edit access for the requested resource.
whitelistedCampaignIds array	Array of whitelisted campaign IDs.
blacklistedCampaignIds array	Array of blacklisted campaign IDs.

JSON

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1143824,
    "audienceName": "Download - Impression _NPI Nurse_iqvia_Filtered",
    "audienceSubtypeId": 4,
    "audienceStatusId": 3,
    "cpm": 25,
    "owId": 20489,
    "createdByUowId": 0,
    "createdAt": 1762502664000,
    "reach": 242,
    "s3FileName": "17_iltered9644451186956185605.csv",
    "s3Url": "s3://test-Client=204389/Audience=1143824/1762502664252_3524Download___Impression__NPI_Nurse_iqvia_Filtered9644451186956185605.csv",
    "fileRowCount": 1829,
    "matchRate": 13.23,
    "dataPartnerId": 5,
    "modifiedAt": "2025-11-07T02:42:33.000+00:00",
    "approvalAccess": false,
    "editAccess": true
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          audienceId: number;
          audienceName: string;
          audienceSubtypeId: number;
          audienceStatusId: number;
          cpm: number;
          owId: number;
          createdByUowId: number;
          createdAt: number;
          reach: number;
          s3FileName: string;
          s3Url: string;
          fileRowCount: number;
          matchRate: number;
          dataPartnerId: number;
          modifiedAt: string;
          approvalAccess: boolean;
          editAccess: boolean;
          whitelistedCampaignIds: number[];
          blacklistedCampaignIds: number[];
        };
      };
    };
  };
}

function getMatchedAudienceDetails(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/matched/{audienceId}',
    params: {
      path: {
        audienceId: `number`
      },
      query: {
        campaignTargetingRequired: `boolean`,
        userDetailsRequired: `boolean`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Create Matched audience

POST

Create a Matched audience by uploading a file with user data. The metadata is sent as a JSON string in the audienceRequest form data field, and the file is uploaded as multipart/form-data in the file form data field.

For more information on Matched audiences and how they can serve your Healthcare, Political, or Specialty needs, refer to our Help Center articles.

Request schema
audienceRequest form data required	Audience metadata details.
file multipart/form-data required	File to be uploaded.

audienceRequest properties

audienceName string	Audience name.
fileRowCount integer	Number of rows in the file.
fileColumnCount integer	Number of columns in the file.
audienceSubtypeId integer	Audience subtype ID. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
columnMappings array	Array of column mapping objects.
columnMappings object properties columnId integer Column ID. fileColumnName string File column name. dataFormatId integer Data format ID. +Supported values 1 Raw 2 Hashed (MD5) 3 Hashed (SHA1) 4 Hashed (SHA256) 5 Hashed (SHA512) 6 Hashed (other)
dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
columnCombinationId integer	Column combination ID.
consentGiven boolean	Indicates whether consent has been given for patient data usage, required for patient subtype.

audienceRequest sample object for Political Matched audience

{
  "audienceName": "matched-audience-example-fs",
  "fileRowCount": 5,
  "fileColumnCount": 10,
  "columnMappings": [
      {
          "columnId": 5,
          "fileColumnName": "l2-voter-id",
          "dataFormatId": null
      },
      {
          "columnId": 6,
          "fileColumnName": "email",
          "dataFormatId": 1
      }
  ],
  "dataPartnerId": 2,
  "columnCombinationId": 11
}

audienceRequest sample object for Healthcare Matched audience

{
  "audienceName": "Revamped Healthcare Matched Audience 02",
  "dataPartnerId": 7,
  "audienceSubtypeId": 3,
  "columnMappings": [
      {
          "columnId": 18,
          "fileColumnName": "NPI_ID"
      }
  ],
  "fileRowCount": 19,
  "fileColumnCount": 1,
  "columnCombinationId": 14,
  "consentGiven": true
}

Select exampleForm data samplecURL sample

POST /api/v3/audience/matched HTTP/1.1
Host: api.iqm.com
Authorization: Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24
X-IAA-OW-ID: 1
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="audienceRequest"
Content-Type: application/json

{"audienceName":"Healthcare Patient Audience 2025","dataPartnerId":7,"audienceSubtypeId":3,"columnCombinationId":14,"fileRowCount":1200,"fileColumnCount":3,"consentGiven":true,"columnMappings":[{"columnId":18,"fileColumnName":"NPI_ID"},{"columnId":19,"fileColumnName":"first_name"},{"columnId":20,"fileColumnName":"last_name"}]}
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="patient-data.csv"
Content-Type: text/csv

[Binary CSV file data]
------WebKitFormBoundary7MA4YWxkTrZu0gW--

curl -X POST https://api.example.com/api/v3/audience/matched \
  -H "Authorization: Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" \
  -H "X-IAA-OW-ID: 1" \
  -F 'audienceRequest={"audienceName":"Healthcare Patient Audience 2025","dataPartnerId":7,"audienceSubtypeId":3,"columnCombinationId":14,"fileRowCount":1200,"fileColumnCount":3,"consentGiven":true,"columnMappings":[{"columnId":18,"fileColumnName":"NPI_ID"},{"columnId":19,"fileColumnName":"first_name"},{"columnId":20,"fileColumnName":"last_name"}]};type=application/json' \
  -F 'file=@/path/to/patient-data.csv;type=text/csv'

Response 200

{
  "success": true,
  "data": {
    "matchedAudienceId": 12345,
    "message": "Matched audience created successfully"
  }
}

---

Update Matched audience

PATCH

Update a Matched audience.

Path parameter
audienceId integer	Matched audience ID.

Request schema
dataCost number	Data cost.
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
rejectionReason string	Reason for rejection if updating status to Rejected.

Response properties

id integer	Audience ID.
message string	Success message.

JSON

Request sample

{
  "dataCost": 10,
  "audienceStatusId": 4,
  "rejectionReason": "Insufficient data quality."
}

Response 200

{
  "statusCode": 200,
  "responseObject": {
    "id": 1,
    "message": "Your changes have been saved successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json;charset=UTF-8": {
        statusCode: number;
        responseObject: {
          id: number;
          message: string;
        };
      };
    };
  };
}

function EditMatchedAudience(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/audience/matched/{audienceId}',
    params: {
      path: {
        audienceId: `string`
      }
    },
    requestBody: {
      content: {
        "application/json": {
          dataCost: `number`,
          audienceStatusId: `number`,
          rejectionReason: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Refresh Matched audience

PUT

Rematch/refresh an existing Matched audience's data. Rematching retriggers the audience matching process, updating the audience's reach and matchRate details. The audience must be eligible for rematch based on its status, last rematch time, and other criteria.

Refer to our Help Center articles for more information.

warning

Rematching an audience and changing its reach can impact campaign performance. Exercise caution when rematching an active audience.

Path parameter
audienceId integer	Matched audience ID to be rematched.

Response properties

audienceId integer	Audience ID.
message string	Success message.

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1119083,
    "message": "Test audience rematched successfully via Re-Match"
  }
}

Error 422

{
  "success": false,
  "errorObjects": [
    {
      "error": "No active audience found with the given Id.",
      "field": "audienceId"
    }
  ]
}

---

---

Data partners list for Matched audience

GET

Returns a list of data partners relevant for audiences based on vertical and optional subtype.

• For Advertiser users, vertical is derived from the logged-in user's OWID.
• For Workspace/super users, a vertical ID should be passed explicitly.
• Audience type ID is mandatory to fetch data partners.
  +Supported values

  1	Matched audience
  2	Segmented audience
  3	Retargeted audience
  4	Geofarmed audience
  5	Contextual audience
  6	Lookalike audience
  7	Campaign audience
  8	Pre-bid audience
  9	Account Based Marketing (ABM) audience
  10	Custom Voter audience (CVA)
  11	Integrated Care Team (ICT) audience
  12	Power Segment audience

• If a subtype ID is passed, it must be valid for the vertical.
• Data partners shown are based on active configurations.

Query parameters
audienceTypeId integer required	Audience type ID. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
audienceSubtypeIds integer	Audience subtype IDs. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
verticalId integer	Vertical ID. +Supported values 1 Political 2 Healthcare 3 Specialty
active boolean	Filter for active data partners.

Response properties

id integer	Data partner ID.
name string	Data partner name.
order integer	Display order.
displayName string	Data partner display name.
cpm integer	Cost per mille (CPM).
logoUrl string	URL to data partner logo.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "id": 7,
      "name": "hl_npi_id",
      "order": 6,
      "displayName": "Healthlink ID",
      "cpm": 10,
      "logoUrl": "https://cdn.com/data_partner/hld.png"
    },
    {
      "id": 8,
      "name": "data360_npi_id",
      "order": 7,
      "displayName": "Data360 ID",
      "cpm": 15,
      "logoUrl": "https://cdn.com/data_partner/D360.png"
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json;charset=UTF-8": {
        success: boolean;
        data: {
          id: number;
          label: string;
          keyName: string;
          audienceColumnId: number;
        }[];
      };
    };
  };
}

function getMatchedAudienceDataPartner(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/static/matched/data-partner',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Data formats list for Matched audience

GET

Get a static list of Matched audience hashed data formats.

Response properties

id integer	Data format ID.
name string	Data format name.
order integer	Display order.
displayName string	Data format display name.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Raw",
            "order": 1,
            "displayName": "Raw"
        },
        {
            "id": 2,
            "name": "MD5",
            "order": 2,
            "displayName": "Hashed (MD5)"
        },
        {
            "id": 3,
            "name": "SHA1",
            "order": 3,
            "displayName": "Hashed (SHA1)"
        },
        {
            "id": 4,
            "name": "SHA256",
            "order": 4,
            "displayName": "Hashed (SHA256)"
        },
        {
            "id": 5,
            "name": "SHA512",
            "order": 5,
            "displayName": "Hashed (SHA512)"
        },
        {
            "id": 6,
            "name": "Other",
            "order": 6,
            "displayName": "Hashed (other)"
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json;charset=UTF-8": {
        success: boolean;
        data: {
          id: number;
          label: string;
          keyName: string;
        }[];
      };
    };
  };
}

function getMatchedAudienceDataFormats(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/static/data-formats',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Matched column list

GET

Returns a list of Matched audience columns along with its supported data format IDs based on vertical and optional audience subtype.

• For Advertiser users, vertical is inferred from the logged-in user's owId.
• For Workspace/super users, vertical ID should be passed explicitly.
• If both passed and inferred vertical IDs conflict, the request is rejected.
• If a subtype is provided, it must belong to the specified vertical. Note: if there is no column combination found, it returns an empty list.

Query parameter
verticalId integer optional	Vertical ID. +Supported values 1 Political 2 Healthcare 3 Specialty
audienceTypeId integer required	Audience type ID. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
audienceSubtypeId integer optional	Audience subtype ID. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient

Response properties

id integer	Column ID.
name string	Column name.
order integer	Display order.
displayName string	Column display name.
dataFormatIds array	Array of supported data format IDs for this column. +Supported values 1 Raw 2 Hashed (MD5) 3 Hashed (SHA1) 4 Hashed (SHA256) 5 Hashed (SHA512) 6 Hashed (other)

Response 200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Voters_ID",
      "order": 1,
      "displayName": "Voter ID"
    },
    {
      "id": 2,
      "name": "Email",
      "order": 3,
      "displayName": "Email",
      "dataFormatIds": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    {
      "id": 3,
      "name": "Phone",
      "order": 4,
      "displayName": "Phone",
      "dataFormatIds": [
        1,
        2,
        3,
        4,
        5,
        6
      ]
    }
  ]
}

---

Matched column combinations

GET

Returns a list of Matched audience column combinations based on vertical and optional audience subtype.

• For Advertiser users, vertical is inferred from the logged-in user's owId.
• For Workspace/super users, vertical ID should be passed explicitly.
• If both passed and inferred vertical IDs conflict, the request is rejected.
• If a subtype is provided, it must belong to the specified vertical.

Query parameter
verticalId integer optional	Vertical ID. +Supported values 1 Political 2 Healthcare 3 Specialty
audienceSubtypeId integer optional	Audience subtype ID. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient

Response properties

id integer	Combination ID.
columnIds array	Array of Column IDs in this combination.
order integer	Display order.

Response 200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "columnIds": [
        1,
        2,
        3,
        4
      ],
      "order": 1
    },
    {
      "id": 3,
      "columnIds": [
        3,
        4,
        8,
        9
      ],
      "order": 4
    },
    {
      "id": 5,
      "columnIds": [
        7,
        8,
        4,
        9
      ],
      "order": 6
    }
  ]
}

---

Download Matched audience file

GET

Get a presigned S3 URL to download a Matched audience file.

Path parameters
audienceId integer	Matched audience ID to download file for.

Response properties

matchedAudienceFileUrl string

Presigned S3 URL to download Matched audience file.

Response 200

{
  "success": true,
  "data": {
    "matchedAudienceFileUrl": "https://cdn.com/CAM-FILES/Client%3D204389/Audience%3D1143824/1762502664252_3524Download___Impression__NPI_Nurse_iqvia_Filtere6956185605.csv?response-content-disposition=attachment%3Bfilename%3D%2217664252_3524Download___Impression__NPI_Nurse_iqvia_Filtered9185605.csv%22&response-content-type=application%2Foctet-stream&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIABRMU%2F20251205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T121547Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJAWPe%2FrI%3D&X-Amz-Signature=19fb8f0208181cd011414bad4e3e"
  }
}

Segmented audiences

Segmented audience details

GET

Get Segmented audience details by ID.

Path parameter
audienceId string	Audience ID.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
createdAt integer	Creation timestamp (epoch seconds).
uniques integer	Count of unique audiences reached.
cpm number	Cost per mille.
editAccess boolean	Indicates if user has edit access for the requested resource.
segmentPartnerName string	Segment partner name.
segmentPartnerId integer	Segment Partner ID.
segmentPartnerLogo string	Segment partner logo URL.
equation string	Equation string describing the or-and relationship between Segment groups.
segmentsList array of objects	Array of Segmented audiences.
segmentsList object properties segmentId integer Segmented audience ID. taxonomyId string Taxonomy category ID. taxonomyValue string Value associated with taxonomy category. description string Description. pathKey string A hierarchical key representing the taxonomy's path or structure. cpm number Cost per mille. modifiedAt string Date last modified. totalReach integer Total number of reach in terms of devices. reachMetadata object Reach metadata object, breakdown by device type. reachMetadata object properties iosDevicesReach integer iOS devices reach. androidDevicesReach integer Android devices reach. cookiesReach integer Cookies reach. dataAvailable boolean Indicates whether relevant data is available for this taxonomy. leafNode boolean Indicates whether this taxonomy is a final node (i.e. it has no subcategories).

JSON

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1076846,
    "audienceName": "Test kishan 19,04:50",
    "audienceStatusId": 3,
    "createdAt": 1718796428,
    "uniques": 0,
    "cpm": 1.5,
    "editAccess": true,
    "segmentPartnerName": "LiveRamp",
    "segmentPartnerId": 1,
    "segmentPartnerLogo": "https://s3.amazonaws.com/advp0had0vuj7rad3niaw1eus2/data_partner/liveramp.png",
    "equation": "((5586112|6450431)&(14005))",
    "segmentsList": [
      {
        "segmentId": 14005,
        "taxonomyId": "1000143856",
        "taxonomyValue": "Western Samoa",
        "description": null,
        "pathKey": "LiveRamp > L2 Political > L2 Voter Data > Individual Demographics > Ethnicity > Ethnic Description > Western Samoa",
        "cpm": 1.5,
        "modifiedAt": "2021-06-08 08:45:50.979634",
        "totalReach": 0,
        "reachMetadata": null,
        "dataAvailable": false,
        "leafNode": true
      },
      {
        "segmentId": 5586112,
        "taxonomyId": "1007595031",
        "taxonomyValue": "South Dakota-13",
        "description": "30 day full data refresh: Individuals living in the South Dakota-13 state senate district. For political use only.",
        "pathKey": "LiveRamp > 123Push > Optimized for CTV > Voters > State Senate District > South Dakota-13",
        "cpm": 0.75,
        "modifiedAt": "2021-06-08 08:45:50.979634",
        "totalReach": 14800,
        "reachMetadata": null,
        "dataAvailable": false,
        "leafNode": true
      },
      {
        "segmentId": 6450431,
        "taxonomyId": "1000037244",
        "taxonomyValue": "Voted In the 2004 Primary Election",
        "description": "This segment contains users who voted in the General Election of this election year",
        "pathKey": "LiveRamp > Porch Group Media (fka V12) > V12 > NEW VOTER & INCOME > Voted In the 2004 Primary Election",
        "cpm": 0.5,
        "modifiedAt": "2024-05-07 09:52:51.191186",
        "totalReach": 5100000,
        "reachMetadata": {
          "iosDevicesReach": 2200000,
          "androidDevicesReach": 2900000,
          "cookiesReach": 0
        },
        "dataAvailable": false,
        "leafNode": true
      }
    ]
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          name: string;
          status: string;
          type: number;
          includedCount: number;
          excludedCount: number;
          createdOn: number;
          organizationName: string;
          owId: number;
          createdByUowId: number;
          createdByUserEmail: string;
          uniques: number;
          dataCost: number;
          segmentsList: {
            segmentId: number;
            taxonomyId: number;
            taxonomyValue: number;
            description: string;
            pathKey: string;
            cpm: number;
            lastUpdatedDate: string;
            totalReach: number;
            reachMetadata: string;
            dataAvailable: boolean;
            leafNode: boolean;
          }[];
          segmentPartnerName: string;
          segmentPartnerId: number;
          segmentPartnerLogo: string;
          equation: string;
          segmentIdList: number[];
          editAccess: boolean;
        }
      };
    };
  };
}

function getSegmentAudienceGroup(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/segment/{audienceId}',
    params: {
      path: {
        audienceId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Search Segmented audiences

POST
POST

Retrieves the segments search list based on the provided request parameters. Allows filtering segments based on various criteria such as search fields, segment IDs, provider, price range, and more. Search results can be downloaded as a CSV file using the download endpoint.

Request schema
pageNo integer	Page number for the required data, default: 1.
noOfEntries integer	Maximum number of returned results per page, default: 100.
sortBy string	Sorts results by specified field. For ascending use plus(+) sign and for descending use minus (-) sign.
searchKeywordSet array of strings	Search keywords to be searched on the 'pathKey' and 'description' of the segments with encoded special characters (required if segmentIds not given).
segmentIds array of integers	Segment IDs to filter returned data by (required if searchKeywordSet not given).
verticalIds array of integers	Vertical IDs to filter returned data by. +Supported values 1 Political 2 Healthcare 3 Specialty
partnerIds array of integers	Partner IDs to filter returned data by.
providerIds array of integers	Provider IDs to filter returned data by.
priceRangeIds array of integers	Price range IDs to filter returned data by.
reachRangeIds array of integers	Reach range IDs to filter returned data by.
showOnlyReadySegments boolean	Flag to filter segments that are ready, default: false.
showOnlyNonZeroSegments boolean	Flag to filter segments that have non-zero reach, default: false.

Response properties

segmentId integer	Segment ID.
taxonomyValue string	Taxonomy value.
description string	Description.
pathKey string	A hierarchichal key representing the taxonomy's path or structure.
cpm integer	Cost per mille.
referenceId string	Reference ID.
lastUpdateDate string	Date when last updated.
totalReach integer	Total reach.
providerId integer	Provider ID.
partnerId integer	Partner ID.
reachMetadata object	Reach metadata object details.
reachMetadata object properties iosDevicesReach integer IOS devices reach. androidDevicesReach integer Android devices reach. cookiesReach integer Cookies reach.
logoUrl string	Logo URL.

JSON

Request sample

{
  "searchKeywordSet": [
    "sample 1",
    "sample 2"
  ],
  "sortBy": "-reach",
  "verticalIds": [
    1,
    2,
    3
  ],
  "partnerIds": [
    1,
    2,
    3
  ],
  "providerIds": [
    1,
    2,
    3
  ],
  "priceRangeIds": [
    1,
    2,
    3
  ],
  "reachRangeIds": [
    1,
    2,
    3
  ],
  "segmentIds": [
    1,
    2,
    3
  ],
  "showOnlyReadySegments": true,
  "showOnlyNonZeroSegments": true
}

Response 200

{    
  "success": true,    
  "data": {        
    "filteredRecords": 45,        
    "segmentsList": [            
      {                
        "segmentId": 5830140,                
        "taxonomyValue": "Thriller/Horror",                
        "description": "This audience contains people that are likely to watch Thriller/Horror TV content & are CBD purchasers. Data leverages Comscore's deterministic, single-source cross-platform dataset derived from set-top box (STB) data from households exposed to the target viewing criteria & is cultivated from industry-leading endemic companies (Point of Sale systems, eCommerce platforms, Delivery services, and Loyalty/CRM platforms).",                
        "pathKey": "LiveRamp > Fyllo > Fyllo > Infused > Comscore > TV > Genre > Thriller/Horror",                
        "cpm": 1.5,                
        "referenceId": "a5b286f2-3b48-42b1-a0d3-1c349aa8800b",                
        "lastUpdatedDate": "2021-07-04T10:48:42.296+00:00",                
        "totalReach": 6000000,                
        "providerId": 140,                
        "partnerId": 1,                
        "dataAvailable":true,                 
        "reachMetadata": {                   
          "iosDevicesReach":120,                    
          "androidDevicesReach":120,                   
          "cookiesReach":120                
        },                
        "logoUrl": "https://s3.amazonaws.com/advp0had0vuj7rad3niaw1eus2/data_partner/liveramp.png"            
      },            
      {                
        "segmentId": 6164189,                
        "taxonomyValue": "Thriller Crime & Mystery Films",                
        "description": "ShareThis collects data from its network of 600 million publisher pages capturing site visitors' pageviews, clicks, shares, and searches.  ShareThis processes these signals and uses associated keywords and topics to build out its audience. ShareThis CTV targeting allows you to leverage this online behavioral data for CTV campaigns, merging the performance of online interest data with the impact and engagement of TV.",                
        "pathKey": "LiveRamp > ShareThis > ShareThis > ShareThis for TV > Arts & Entertainment > Movies > Thriller Crime & Mystery Films",                
        "cpm": 2.0,                
        "referenceId": "e2b856fd-8777-42f1-b916-1f3042ed290d",                
        "lastUpdatedDate": "2021-12-03T11:19:19.763+00:00",                
        "totalReach": 8600000,                
        "providerId": 21,                
        "partnerId": 1,                
        "dataAvailable":true,                 
        "reachMetadata": {                   
          "inputRecordsReach":120,                   
          "iosDevicesReach":120,                    
          "androidDevicesReach":120,                   
          "cookiesReach":120                
        },                
        "logoUrl": "https://s3.amazonaws.com/advp0had0vuj7rad3niaw1eus2/data_partner/liveramp.png"            
      }        
    ]    
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json;charset=UTF-8": {
        statusCode: number;
        responseObject: {
          "0d5fcaea-0fe3-4b10-ba62-168f3dcb0281": {
            description: string;
            cpm: number;
            isLeaf: number;
            margin: number;
            pathKey: string;
            id: string;
            taxonomy_value: string;
          }[];
        };
      };
    };
  };
}

function GetSegmentSearchResult(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/segmented/search/list',
    requestBody: {
      content: {
        "application/json": {
          pageNo?: `number`,
          noOfEntries?: `number`,
          sortBy?: `string`,
          searchKeywordSet?: `string[]`,
          segmentIds?: `number[]`,
          verticalIds?: `number[]`,
          partnerIds?: `number[]`,
          providerIds?: `number[]`,
          priceRangeIds?: `number[]`,
          reachRangeIds?: `number[]`,
          showOnlyReadySegments?: `boolean`,
          showOnlyNonZeroSegments?: `boolean`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Create Segmented audience

POST

Creates a Segmented audience based on the provided request parameters.

Using Segment IDs (Search Segmented audiences), you can build an audience with the equation field. Segment IDs in parentheses, separated by a vertical bar (|), are in an 'or' relationship, which combines the sets of Segments; groups of Segments in parentheses, separated by an ampersand (&), are in an 'and' relationship, which builds an audience based on the intersection of those groups.

You can see an example of this format in the Request sample code block on the right-hand side of the page, or you can read more in our Help Center article on Segments Groups and relationships.

Request schema
equation string required	Equation string representing the segment ID groups in AND/OR relationship.
audienceName string required	Name of the Segmented audience to be created (maximum 255 characters).

Response properties

id integer	Audience ID.
message string	Success message.

JSON

Request sample

{
  "equation": "((6388749|6388750)&(6388751|6402730|6392754|5776004))",
  "audienceName": "football-temp"
}

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1140623,
    "message": "<Audience Name> audience created successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          message: string;
        };
      };
    };
  };
}

function createSegmentAudienceGroup(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/segmented',
    requestBody: {
      content: {
        "application/json": {
          equation: `string`,
          audienceName: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Segmented audience

PUT

Updates an existing Segmented audience based on the provided request parameters. Allows modifying the details of an existing Segmented audience (name and segments).

Path parameter
audienceId integer	Audience ID.

Request schema
equation string required	Equation string representing the segment ID groups in AND/OR relationship.
audienceName string required	Name of the Segmented audience to be updated (maximum 255 characters).

Response properties

audienceId integer	Audience ID.
message string	Success message.

JSON

Request sample

{
  "equation": "((5613837|5638265)&(5613844))",
  "name": "Segment audience - 1"
}

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1140623,
    "message": "<Audience Name> audience updated successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          message: string;
        };
      };
    };
  };
}

function updateSegmentAudienceGroup(): Promise<Responses> {
  const options = {
    method: 'PUT',
    url: 'https://api.iqm.com/api/v3/audience/segment/{audienceId}',
    params: {
      path: {
        audienceId: `number`,
      }
    },
    requestBody: {
      content: {
        "application/json": {
          advertiserId?: `number`,
          dspId?: `number`,
          owId?: `number`,
          uowId?: `number`,
          name?: `string`,
          equation?: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Segment partner provider list

GET

Get a list of partners and providers with basic audience information.

Response properties

partnerId integer	Partner ID.
partnerName string	Partner name.
partnerLogoUrl string	Partner logo URL.
description string	Partner description.
verticalIds array of integers	List of Vertical IDs. +Supported values 1 Political 2 Healthcare 3 Specialty
displayOrder integer	Display order.
seatId integer	Seat ID.
providers array of objects	Array of Provider details.
providers object properties providerId integer Provider ID. providerName string Provider name. providerLogoUrl string Provider logo URL. description string Provider description. verticalIds array of integers List of Vertical IDs. +Supported values 1 Political 2 Healthcare 3 Specialty
isCustomPartner boolean	Indicates whether partner is custom.
isPartnerPublic boolean	Indicates whether partner is public (true) or private (false).

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "partnerId": 6,
      "partnerName": "IQM Political",
      "partnerLogoUrl": "https://www.sample-domain/data_partner/iqm-political-provider.svg",
      "description": "IQM Political",
      "verticalIds": [
        1
      ],
      "displayOrder": 2,
      "providers": [
        {
          "providerId": 76,
          "providerName": "AdMavin",
          "providerLogoUrl": "https://www.sample-domain.com/iqm-political-provider.svg",
          "description": "AdMavin",
          "verticalIds": [
            1
          ]
        },
        {
          "providerId": 279,
          "providerName": "Aristotle",
          "providerLogoUrl": "https://www.sample-domain.com/iqm-political-provider.svg",
          "description": "Aristotle",
          "verticalIds": [
            1
          ]
        }
      ],
      "isCustomPartner": false,
      "isPartnerPublic": false
    },
    {
      "partnerId": 13033,
      "partnerName": "OL's Healthcare",
      "partnerLogoUrl": "https://www.sample-domain.com/avatar/OH.png",
      "description": "Seat ID: 203775",
      "seatId": 203775,
      "displayOrder": 0,
      "isCustomPartner": true,
      "isPartnerPublic": false
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          partnerProviderList: {
            partnerId: number;
            partnerReferenceUuid: string;
            partnerName: string;
            partnerLogoUrl: string;
            partnerDescription: string;
            order: number;
            verticalIdList: number[];
            seatId: number;
            customPartner: boolean;
            providerList: {
              providerId: number;
              providerReferenceUuid: string;
              providerName: string;
              providerLogoUrl: string;
              verticalIdList: number[];
              providerDescription: string;
            }[];
            isPartnerPublic: boolean;
          }[];
          totalRecords: number;
          filteredRecords: number;
        }
      };
    };
  };
}

function getSegmentPartnerProviderList(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/segmented/partner-provider/list',
    requestBody: {
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Segment list by provider/partner IDs

GET

Get a list of Segments by given provider or parent ID. If parent ID is not provided, endpoint returns all direct segments of a given provider ID.

Query parameters
partnerId integer required	Partner ID.
providerId integer required	Provider ID.
parentId integer	Parent ID, if not provided returned results will include all direct segments of provided ID.
showOnlyNonZeroSegments boolean	Returns segments with reach greater than 0: true, default: false.
showOnlyReadySegments boolean	Returns segments with "ready" status: true.

Response properties

segmentId integer	Segment ID.
taxonomyValue string	Taxonomy value.
description string	Description.
pathKey string	A hierarchichal key representing the taxonomy's path or structure.
cpm number	Cost per mille.
modifiedAt string	Date last modified.
totalReach integer	Total number of reach in terms of devices.
reachMetadata object	Reach metadata object, breakdown by device type.
reachMetadata object properties iosDevicesReach integer iOS devices reach. androidDevicesReach integer Android devices reach. cookiesReach integer Cookies reach.
dataAvailable boolean	Indicates whether relevant data is available for this taxonomy.
leaf boolean	Indicates whether this taxonomy is a final node (i.e. it has no subcategories).

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "segmentId": 6192803,
      "taxonomyValue": "Giving And Investment",
      "description": "Sample description",
      "pathKey": "LiveRamp > i360 > i360 > Demographics > Giving And Investment",
      "cpm": 10,
      "modifiedAt": "2021-06-08T03:15:50.979+00:00",
      "totalReach": 360,
      "dataAvailable": true,
      "reachMetadata": {
        "iosDevicesReach": 120,
        "androidDevicesReach": 120,
        "cookiesReach": 120
      },
      "leaf": false
    },
    {
      "segmentId": 6192796,
      "taxonomyValue": "Ages 18 To 29",
      "description": "Individuals Ages 18 And 29.",
      "pathKey": "LiveRamp > i360 > i360 > Demographics > Ages 18 To 29",
      "cpm": 1,
      "modifiedAt": "2021-06-08T03:15:50.979+00:00",
      "totalReach": 360,
      "reachMetadata": {
        "iosDevicesReach": 120,
        "androidDevicesReach": 120,
        "cookiesReach": 120
      },
      "leaf": true
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          segmentId: number;
          taxonomyId: string;
          taxonomyValue: string;
          description: string;
          pathKey: string;
          cpm: number;
          referenceId: string;
          lastUpdateDate: string;
          totalReach: number;
          dataAvailable: boolean;
          reachMetadata: {
            iosDevicesReach: number;
            androidDevicesReach: number;
            cookiesReach: number;
          };
          leafNode: boolean;
        }[];
      };
    };
  };
}

function getSegmentsListByParent(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/segmented/segments/children',
    params: {
      query: {
        partnerId: `number`,
        providerId: `number`,
        parentId?: `number`,
        showOnlyNonZeroSegments?: `boolean`,
        showOnlyReadySegments?: `boolean`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Retargeted audiences

Create Retargeted audience

POST

Create a Retargeted audience.

Request schema
audienceName string	Audience name.
dateCollectionBy string	Date collection can be either month or date_range.
dateCollectionPeriod integer	Data collection period.
startDate integer	Start date in Unix epoch milliseconds, required if dateCollectionBy is set to date_range.
endDate integer	End date in Unix epoch milliseconds, required if dateCollectionBy is set to date_range.

Response properties

audienceId integer	Audience ID.
tag_script string	Tag script.
message string	Success message.

JSON

Select exampleBy monthBy date range

Request sample

{
  "audienceName": "Test audience by month",
  "dataCollectionBy": "month",
  "dataCollectionPeriod": 1
}

Request sample

{
  "audienceName": "Test audience by date_range",
  "dataCollectionBy": "date_range",
  "startDate": 1753262493020,
  "endDate": 1753900200000
}

Response 200

{
  "success": true,
  "data": {
    "tag_script": "<script src='https://pxl.stage.iqm.com/c/4c90b124-bfbe-4af1-b780-d2a1d3cb93c1' async></script>",
    "audienceId": 1140586,
    "message": "Test audience by month audience created successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          tag_script: string;
          message: string;
        };
      }
    };
  };
}

function CreateRetargetedAudience(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/retargeted',
    requestBody: {
      content: {
        "application/json": {
          audienceName: `string`,
          dateCollectionBy: `string`,
          dateCollectionPeriod: `number`,
          startDate?: `number`,
          endDate?: `number`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Retargeted audience

PATCH

Update a Retargeted audience.

Path parameter
audienceId string	Retargeted audience ID.

Request schema
audienceName string	Audience name.
dateCollectionBy string	Date collection can be either month or date_range.
dateCollectionPeriod integer	Data collection period.
startDate integer	Start date in Unix epoch milliseconds, required if dateCollectionBy is set to date_range.
endDate integer	End date in Unix epoch milliseconds, required if dateCollectionBy is set to date_range.

Response properties

tag_script string	Tag script.
message string	Success message.

JSON

Select exampleBy monthBy date range

Request sample

{
  "audienceName": "Test audience by month",
  "dataCollectionBy": "month",
  "dataCollectionPeriod": 1
}

Request sample

{
  "audienceName": "Test audience by date_range",
  "dataCollectionBy": "date_range",
  "startDate": 1753262493020,
  "endDate": 1753900200000
}

Response 200

{
  "success": true,
  "data": {
    "tag_script": "<script src='https://sample.url.com/c/02e378aa-275b-40aa-9a2c-a41ce2e02c88' async></script>",
    "message": "Your changes have been saved successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          tag_script: string;
          message: string;
        };
      }
    };
  };
}

function EditRetargetAudience(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/audience/retargeted/{audienceId}',
    param: {
      path: {
        audienceId: `string`
      }
    },
    requestBody: {
      content: {
        "application/json": {
          tag_duration: `string`,
          tag_name: `string`,
          tag_time: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Retargeted audience email notification

POST

Send email with Retargeted audience pixel code to specified recipients.

Path parameter
audienceId string	Retargeted audience ID.

Request schema
recipientEmails array of strings	Recipient emails.

Response properties

message string

Success message.

JSON

Request sample

{
  "recipientEmails": [
    "test.s@gmail.com"
  ]
}

Response 200

{
  "success": true,
  "data": {
    "message": "Pixel Code emailed successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json;charset=UTF-8": {
        statusCode: number;
        responseObject: {
          message: string;
        };
      };
    };
  };
}

function RetargetAudienceemailnotify(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/retargeted/{audienceId}/email-notification',
    requestBody: {
      content: {
        "application/json": {
          pixelCode: `string`,
          recipients: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Geofarmed audiences

Geofarmed audience details

GET

Get Geofarmed audience details by ID.

Path parameter
audienceId string	Geofarmed audience ID.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
createdAt integer	Creation timestamp (epoch seconds).
reach integer	Audience reach.
cpm number	Cost per thousand impressions.
audienceSubtypeId integer	Audience subtype ID. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
dataPartnerMetrics array of objects	Data partner metrics.
dataPartnerMetrics object properties id integer Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID reach integer Reach for this data partner.
frequency integer	The frequency of visit to the geographical location.
frequencyTypeId integer	Frequency type ID. +Supported values 1 Total 2 Weekly 3 Monthly
startDate integer	Unix epoch start date (seconds).
endDate integer	Unix epoch end date (seconds).
timezoneId integer	Timezone ID.
timeRange object	Time range configuration (may be null).
locations object	Locations object.
locations object properties country integer Country ID. included object Included locations object. included object properties zipCodes array of strings Zip codes. customAreas array of objects Custom areas. locationIds array of integers Location IDs. customAreas object properties latitude integer Latitude. longitude integer Longitude. radius integer Radius (miles). address string Addresses to add to custom area. locationId integer Location ID. polypath object A set of coordinates defining the boundary of the custom area. polypath object properties lat integer Latitude. lng integer Longitude. isIncluded boolean Indicates if custom area is included in Geofarmed audience: true. cid string Country abbreviation, e.g. US. sid string State abbreviation, e.g. NY. type string Type of custom area. unit string Measurement unit for radius of area. cdId integer Congressional district ID. sdId integer Senate district ID. hdId integer House district ID. excluded object Excluded locations object. excluded object properties zipCodes array of strings Zip codes. customAreas array of objects Custom areas. locationIds array of integers Location IDs. customAreas object properties latitude integer Latitude. longitude integer Longitude. radius integer Radius (miles). address string Address. locationId integer Location ID. polypath object A set of coordinates defining the boundary of the custom area. polypath object properties lat integer Latitude. lng integer Longitude. isIncluded boolean Indicates if custom area is included in Geofarmed audience: true. cid string Country abbreviation, e.g. US. sid string State abbreviation, e.g. NY. type string Type of custom area. unit string Measurement unit for radius of area. cdId integer Congressional district ID. sdId integer Senate district ID. hdId integer House district ID. locationFileIds array of integers Location file IDs.
bulkLocationDetails object	Bulk location details object.
bulkLocationDetails object properties fileName string File name. fileType string File type. validLocations array of objects Valid locations. validLocations object properties latitude number Latitude. longitude number Longitude. radius number Radius. address string Address. locationId integer Location ID. cid string Country abbreviation, e.g. US. sid string State abbreviation, e.g. NY. cdId integer Congressional district ID. sdId integer Senate district ID. hdId integer House district ID. isIncluded boolean Is included flag. invalidLocations null Invalid locations. locationRejectionReasons null Location rejection reasons. campaignId null Campaign ID. id integer ID. rowCount null Row count. invalidLocationsCount null Invalid locations count. duplicateLocationsCount null Duplicate locations count.

JSON

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1141873,
    "audienceName": "my geo check 3",
    "audienceStatusId": 1,
    "createdAt": 1754997589,
    "reach": 14300,
    "cpm": 10,
    "audienceSubtypeId": 3,
    "dataPartnerId": 7,
    "dataPartnerMetrics": [
      {
        "id": 7,
        "reach": 14300
      },
      {
        "id": 10,
        "reach": 14142
      },
      {
        "id": 8,
        "reach": 4989
      }
    ],
    "frequency": 1,
    "frequencyTypeId": 1,
    "startDate": 1752465600,
    "endDate": 1752552000,
    "timezoneId": 29,
    "timeRange": null,
    "locations": {
      "included": {
        "zipCodes": [
          "03060"
        ],
        "customAreas": [
          {
            "latitude": 36.03264396648448,
            "longitude": -119.88024262579326,
            "radius": 0.5,
            "address": "24M9+3W Kettleman City, CA, USA",
            "locationId": 0,
            "cid": "US",
            "sid": "CA",
            "type": "circle",
            "unit": "mile",
            "cdId": 0,
            "sdId": 0,
            "hdId": 0,
            "isIncluded": true
          },
          {
            "latitude": 36.030047897646504,
            "longitude": -119.85904244573955,
            "radius": 0.5,
            "address": "24JR+29 Kettleman City, CA, USA",
            "locationId": 0,
            "cid": "US",
            "sid": "CA",
            "type": "circle",
            "unit": "mile",
            "cdId": 0,
            "sdId": 0,
            "hdId": 0,
            "isIncluded": true
          },
          {
            "latitude": 36.03107268797965,
            "longitude": -79.36266450079326,
            "radius": 31.99,
            "address": "Graham, NC 27253, USA",
            "locationId": 0,
            "polypath": [
              {
                "lat": 36.38721903107804,
                "lng": -79.62633637579326
              },
              {
                "lat": 35.53354668242086,
                "lng": -79.97789887579326
              },
              {
                "lat": 35.67646553441582,
                "lng": -78.83532075079326
              },
              {
                "lat": 36.52859869353844,
                "lng": -78.74743012579326
              }
            ],
            "cid": "US",
            "sid": "NC",
            "type": "custom",
            "unit": "mile",
            "cdId": 0,
            "sdId": 0,
            "hdId": 0,
            "isIncluded": true
          },
          {
            "latitude": 34.4534306784404,
            "longitude": -80.72496918829326,
            "radius": 20.21,
            "address": "Camden, SC 29020, USA",
            "locationId": 0,
            "polypath": [
              {
                "lat": 34.59837718611232,
                "lng": -80.41735200079326
              },
              {
                "lat": 34.59837718611232,
                "lng": -81.03258637579326
              },
              {
                "lat": 34.30848417076847,
                "lng": -81.03258637579326
              },
              {
                "lat": 34.30848417076847,
                "lng": -80.41735200079326
              }
            ],
            "cid": "US",
            "sid": "SC",
            "type": "square",
            "unit": "mile",
            "cdId": 0,
            "sdId": 0,
            "hdId": 0,
            "isIncluded": true
          }
        ],
        "locationIds": [
          1252824,
          1252825
        ]
      },
      "excluded": {
        "zipCodes": [],
        "customAreas": [],
        "locationIds": []
      },
      "locationFileIds": [
        17063
      ],
      "country": 30100001
    },
    "bulkLocationDetails": {
      "17063": {
        "fileName": "bulk-location-example.csv",
        "fileType": "location",
        "validLocations": [
          {
            "latitude": 40.7128,
            "longitude": -74.006,
            "radius": 0.5,
            "address": "230 Broadway, New York, NY 10007, USA",
            "locationId": 1252824,
            "cid": "US",
            "sid": "NY",
            "cdId": 0,
            "sdId": 0,
            "hdId": 0,
            "isIncluded": true
          },
          {
            "latitude": 36.7783,
            "longitude": -119.4179,
            "radius": 1,
            "address": "2630 Croydon Drive, Sanger, CA 93657, USA",
            "locationId": 1252825,
            "cid": "US",
            "sid": "CA",
            "cdId": 0,
            "sdId": 0,
            "hdId": 0,
            "isIncluded": true
          }
        ],
        "invalidLocations": null,
        "locationRejectionReasons": null,
        "campaignId": null,
        "id": 17063,
        "rowCount": null,
        "invalidLocationsCount": null,
        "duplicateLocationsCount": null
      }
    }
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
          success: boolean;         
          data: {             
              audienceId: number;
              audienceName: string;
              audienceStatusId: number;
              createdAt: number;
              reach: number;
              cpm: number;
              audienceSubtypeId: number;
              dataPartnerId: number;
              dataPartnerMetrics: {
                  id: number;
                  reach: number;
              }[];
              frequency: number;             
              frequencyTypeId: number;             
              startDate: number;              
              endDate: number;             
              timezoneId: number;
              timeRange: {
                  [key: string]: string;
              } | null;
              locations: {
                  included: {
                      zipCodes: string[];
                      customAreas: {
                          latitude: number;
                          longitude: number;
                          radius: number;
                          address: string;                          
                          locationId: number;
                          cid: string;
                          sid: string;
                          type: string;
                          unit: string;                         
                          cdId: number;                         
                          sdId: number;                         
                          hdId: number;
                          isIncluded: boolean;
                          polypath?: {
                              lat: number;
                              lng: number;
                          }[];
                      }[];
                      locationIds: number[];
                  };
                  excluded: {
                      zipCodes: string[];
                      customAreas: {
                          latitude: number;
                          longitude: number;
                          radius: number;
                          address: string;                         
                          locationId: number;
                          cid: string;
                          sid: string;
                          type: string;
                          unit: string;                        
                          cdId: number;                         
                          sdId: number;                         
                          hdId: number;
                          isIncluded: boolean;
                          polypath?: {
                              lat: number;
                              lng: number;
                          }[];
                      }[];
                      locationIds: number[];
                  };
                  locationFileIds: number[];                  
                  country: number;
              };
              bulkLocationDetails: {
                  [key: string]: {
                      fileName: string;
                      fileType: string;
                      validLocations: {
                          latitude: number;
                          longitude: number;
                          radius: number;
                          address: string;                        
                          locationId: number;
                          cid: string;
                          sid: string;                          
                          cdId: number;                         
                          sdId: number;                          
                          hdId: number;
                          isIncluded: boolean;
                      }[];
                      invalidLocations: null;
                      locationRejectionReasons: null;
                      campaignId: null;
                      id: number;
                      rowCount: null;
                      invalidLocationsCount: null;
                      duplicateLocationsCount: null;
                  };
              };
          };
      };
    };
  };
}

function GetGeofarmedAudienceDetails(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/geo-farmed/{audienceId}',
    params: {
      path: {
        audienceId: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Create Geofarmed audience

POST

Create a Geofarmed audience.

Request schema
audienceName string	Audience name.
frequency integer	The frequency of visit to the geographical location (1-10), based on frequencyTypeId.
frequencyTypeId integer	Frequency type ID. +Supported values 1 Total 2 Weekly 3 Monthly
timezoneId integer	Timezone ID.
startDate integer	Unix epoch start date, in milliseconds.
endDate integer	Unix epoch end date, in milliseconds.
timeRange object	Name-value pairs of day of the week (e.g. Monday: 1, Tuesday: 2, etc.) and an object containing a time range (see example below this table).
timeRangeWithTimezone object	Alternative time range configuration with timezone support.
audienceSubtypeIds array of integers	Audience subtype IDs. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
removedLocationsIds array of integers	Removed location IDs, as specified in the uploaded location file.
locations object	Locations object.
locations object properties country integer Country ID. included object Included locations object. included object properties zipCodes array of strings Zip codes. customAreas array of objects Custom areas. locationIds array of integers Location IDs. customAreas object properties latitude integer Latitude. longitude integer Longitude. radius integer Radius. address string Address. stateShortName string State short name. countryShortName string Country short name. locationId integer Location ID. rejectionReason string Rejection reason (if applicable). polypath object A set of coordinates defining the boundary of the custom area. polypath object properties lat integer Latitude. lng integer Longitude. placemarkName string Placemark name. cid string Country abbreviation, e.g. US. sid string State abbreviation, e.g. NY. type string Type of custom area. unit string Measurement unit for radius. cdId integer Congressional district ID. sdId integer Senate district ID. hdId integer House district ID. isIncluded boolean Indicates if custom area is included in Geofarmed audience. excluded object Excluded locations object. excluded object properties zipCodes array of strings Zip codes. customAreas array of objects Custom areas. locationIds array of integers Location IDs. customAreas object properties latitude integer Latitude. longitude integer Longitude. radius integer Radius. address string Address. stateShortName string State short name. countryShortName string Country short name. locationId integer Location ID. rejectionReason string Rejection reason (if applicable). polypath object A set of coordinates defining the boundary of the custom area. polypath object properties lat integer Latitude. lng integer Longitude. placemarkName string Placemark name. cid string Country abbreviation, e.g. US. sid string State abbreviation, e.g. NY. type string Type of custom area. unit string Measurement unit for radius. cdId integer Congressional district ID. sdId integer Senate district ID. hdId integer House district ID. isIncluded boolean Indicates if custom area is excluded from Geofarmed audience. locationFileIds array of integers Location file IDs.

timeRange example

"timeRange": {
  "0": [
    [
      "19:00:00",
      "22:00:00"
    ]
  ],
  "1": [
    [
      "09:00:00",
      "12:00:00"
    ],
    [
      "15:00:00",
      "18:00:00"
    ]
  ],
  "2": [
    [
      "04:00:00",
      "11:00:00"
    ]
  ],
  "4": [
    [
      "06:00:00",
      "12:00:00"
    ]
  ],
  "6": [
    [
      "01:00:00",
      "10:00:00"
    ]
  ]
},

Response properties

id integer	Audience ID.
message string	Success message.

JSON

Request sample

{
  "audienceName": "Healthcare Professionals NYC",
  "frequency": 5,
  "frequencyTypeId": 2,
  "startDate": 1697040000,
  "endDate": 1699641600,
  "timezoneId": 1,
  "audienceSubtypeIds": [
    3,
    4
  ],
  "timeRange": {
    "0": [
      [
        "09:00:00",
        "17:00:00"
      ]
    ],
    "1": [
      [
        "10:00:00",
        "18:00:00"
      ]
    ]
  },
  "locations": {
    "country": 1,
    "included": {
      "zipCodes": [
        "10001",
        "10002",
        "10003"
      ],
      "customAreas": [
        {
          "type": "circle",
          "latitude": 40.7128,
          "longitude": -74.006,
          "radius": 5,
          "unit": "mile"
        }
      ]
    },
    "locationFileIds": [
      123
    ]
  }
}

Response 200

{
  "success": true,
  "data": {
    "audienceIds": [
      1142280
    ],
    "message": "Test_aud audience created successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          message: string;
        };
      };
    };
  };
}

function CreateGeofarmedAudience(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/geo-farmed/add',
    requestBody: {
      content: {
        "application/json": {
          audienceName: `string`,
          frequency: `number`,
          frequencyType: `number`,
          startDate: `number`,
          endDate: `number`,
          timezone: `number`,
          timeRange: {
            [key: string]: `string`,
          },
          removedLocationsIds: `number[]`,
          locations: {
            country: `number`,
            included: {
              locationIds: `number[]`,
              states: `number[]`,
              counties: `number[]`,
              cities: `number[]`,
              stateSenates: `number[]`,
              stateHouses: `number[]`,
              congressionalDistricts: `number[]`,
              zipCodes: `number[]`,
              customAreas: {
                latitude: `number`,
                longitude: `number`,
                radius: `number`,
                address: `string`,
                locationId: `number`,
                isIncluded: `boolean`,
                cid: `string`,
                sid: `string`,
                type: `string`,
                unit: `string`,
                cdId: `number`,
                sdId: `number`,
                hdId: `number`,
                polypath?: {
                  lat: `number`,
                  lng: `number`,
                }[],
              }[],
            },
            excluded: {
              locationIds: `number[]`,
              cities: `number[]`,
              counties: `number[]`,
              stateSenates: `number[]`,
              stateHouses: `number[]`,
              congressionalDistricts: `number[]`,
              zipCodes: `number[]`,
              customAreas: {
                latitude: `number`,
                longitude: `number`,
                radius: `number`,
                address: `string`,
                locationId: `number`,
                isIncluded: `boolean`,
                cid: `string`,
                sid: `string`,
                type: `string`,
                unit: `string`,
                cdId: `number`,
                sdId: `number`,
                hdId: `number`,
                polypath?: {
                  lat: `number`,
                  lng: `number`,
                }[],
              }[],
            },
            locationFileIds: number[],
          }
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Contextual audiences

Contextual audience details

GET

Get Contextual audience details by ID.

Path parameter
audienceId string	Audience ID.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
cpm number	Cost per thousand impressions.
reach integer	Audience reach.
createdAt integer	Unix epoch creation date (milliseconds).
keywords array of strings	Keywords.
urls array of strings	URLs.
dataCollectionMethodId integer	Data collection method ID.
dataCollectionDays integer	Data collection days.
frequency integer	Frequency.
dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
dataPartnerMetrics array of objects	Data partner metrics.
dataPartnerMetrics object properties id integer Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID reach integer Reach for this data partner.

JSON

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1141259,
    "audienceName": "Test_aud_contextual",
    "audienceStatusId": 8,
    "cpm": 1.5,
    "reach": 0,
    "createdAt": 1753773402000,
    "keywords": [
      "Test"
    ],
    "urls": [
      "http://iqm.com"
    ],
    "dataCollectionMethodId": 2,
    "dataCollectionDays": 10,
    "frequency": 5,
    "dataPartnerId": 1,
    "dataPartnerMetrics": [
      {
        "id": 1,
        "reach": 1000
      },
      {
        "id": 2,
        "reach": 1000
      }
    ]
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
         audienceId: number;
         audienceName: string;
         audienceStatusId: number;
         cpm: number;
         reach: number;
         createdAt: number;
         keywords: string[];
         urls: string[];
         dataCollectionMethodId: number;
         dataCollectionDays: number;
         frequency: number;
         dataPartnerId: number;
         dataPartnerMetrics: {
           id: number;
           reach: number;
         }[];
        };
      };
    };
  };
}

function getContextualAudience(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/contextual/{audienceId}',
    params: {
      path: {
        audienceId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Create Contextual audience

POST

Create a Contextual audience.

Data collection period: the timeframe during which a user visits the publisher(s) relevant to one or more keywords or URLs added to the Contextual audience.

info

The start date of a Contextual audience must be within the last 180 days.

Contextual audiences support a static or dynamic data collection period of up to 90 days.

Request schema
audienceName string	Audience name.
keywords array of strings	Keywords to generate Contextual audience.
startDate integer	Unix epoch start date, in milliseconds (required if data collection method is static).
endDate integer	Unix epoch start date, in milliseconds (required if data collection method is static).
frequency integer	The number of times a user visits the publisher(s) relevant to one or more keywords or URLs added to the Contextual audience. Integer between 1-10.
urls array of strings	The publisher sites visited by a user.
timezoneId integer	Timezone ID specifies data collection start time.
dataCollectionMethodId integer	static (1) collection period in a fixed set of dates. dynamic (2) data collection period over a rolling timeframe, with data refreshes every 24 hours.
dataCollectionDays integer	Number of days for data collection timeframe when data collection method is dynamic (maximum value: 90).
audienceSubTypes integer	List of audience subtype IDs to further define the Contextual audience. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient

Response properties

audienceIds array of integers	Audience IDs.
message string	Success message.

JSON

Request sample

{
  "audienceName": "Test_aud",
  "frequency": 5,
  "startDate": 1750737600000,
  "endDate": 1753329599000,
  "keywords": [
    "Test"
  ],
  "urls": [
    "http://iqm.com"
  ],
  "timezoneId": 29,
  "dataCollectionMethodId": 1,
  "audienceSubtypes": [
    2,
    3
  ]
}

Response 200

{
  "success": true,
  "data": {
    "audienceIds": [
      1142280
    ],
    "message": "Test_aud audience created successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          message: string;
        };
      };
    };
  };
}

function createContextualAudiences(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/contextual',
    requestBody: {
      content: {
        "application/json": {
          audienceName: `string`,
          keywords?: `string[]`,
          urls?: `string[]`,
          frequency?: `number`,
          startDate?: `number`,
          endDate?: `number`,
          timezoneId?: `number`,
          dataCollectionMethodId: `number`,
          dataCollectionDays?: `number`,
          audienceSubtypes?: `number[]`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Validate URL for Contextual audience

POST

Validate given URLs to be targeted in a Contextual audience.

Request schema
URLs array of strings	URLs to validate

Response properties

success boolean	Indicates report was successfully created: true.
data array of strings	Validated URLs.

JSON

Request sample

[
  "https://sample-url-1.com",
  "https://sample-url-2.com",
  "https://sample-url-3.com"
]

Response 200

{
  "success": true,
  "data": {
    "https://sample-url-1.com": false,
    "https://sample-url-2.me": true,
    "https://sample-url-3.me": null,
    "https://sample-url-4.com": true
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: string[];
      };
    };
  };
}

function validateContextualUrl(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/contextual/programmatic/url/validate',
    requestBody: {
      content: {
        "application/json": `string[]`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Lookalike audiences

Get Lookalike audience details

GET

Get Lookalike audience details.

Path parameter
audienceId string	Lookalike audience ID.

Query parameter
isTargetingInfoRequired boolean	Includes targeting info in response (true) and targeted campaign details (type of targeting, attached campaign status), default: (false).

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
createdAt integer	Creation timestamp (epoch seconds).
organizationName string	Organization name.
owId integer	Organization Workspace ID.
createdByUowId integer	Created by User Organization Workspace ID.
createdByUser string	Created by user name.
createdByUserEmail string	Created by user email (may be null).
reach integer	Audience reach.
cpm number	Cost per thousand impressions.
sourceAudienceIds array of integers	Source audience IDs.
geoLocationDetails object	Geo location details.
geoLocationDetails object properties countryIds array of integers Country IDs. stateIds array of integers State IDs. cityIds array of integers City IDs. countyIds array of integers County IDs. senateDistrictIds array of integers Senate district IDs. houseDistrictIds array of integers House district IDs. congressionalDistrictIds array of integers Congressional district IDs.
audienceSize integer	Audience size.
targetedCampaignList array of objects	Targeted campaign list.
targetedCampaignList object properties campaignName string Campaign name. campaignId integer Campaign ID. targetingTypeId integer Targeting type ID (1=Whitelist, 2=Blacklist). campaignStatus string Campaign status.
approvedRejectedByUserName string	Approved/rejected by user name (may be null).
rejectionReason string	Rejection reason (may be null).
isApprovalAccess boolean	Indicates if user has approval access.

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1141499,
    "audienceName": "Test lookalike Audience - 90K",
    "audienceStatusId": 3,
    "createdAt": 1753882035,
    "organizationName": "Political Advertiser - Audience Bidder",
    "owId": 204472,
    "createdByUowId": 267663,
    "createdByUser": "Political Advertiser - Audience Bidder",
    "createdByUserEmail": null,
    "reach": 2000,
    "cpm": 1.5,
    "sourceAudienceIds": [123456, 123457],
    "geoLocationDetails": {
      "countryIds": [30100001],
      "stateIds": [30200001, 30200002, 30200003, 30200004],
      "cityIds": [30400001, 30400002],
      "countyIds": [30300001, 30300003],
      "senateDistrictIds": [687, 688],
      "houseDistrictIds": [5098, 5121],
      "congressionalDistrictIds": [350, 78]
    },
    "audienceSize": 10,
    "targetedCampaignList": [
      {
        "campaignName": "Audience - LookAlike Audience with IP Based",
        "campaignId": 565213,
        "targetingTypeId": 1,
        "campaignStatus": "Running"
      },
      {
        "campaignName": "Audience - LookAlike Audience with Device Based - Blacklisted",
        "campaignId": 565262,
        "targetingTypeId": 2,
        "campaignStatus": "Paused"
      }
    ],
    "approvedRejectedByUserName": null,
    "rejectionReason": null,
    "isApprovalAccess": true
  }
}

---

Create Lookalike audience

POST

Create a Lookalike audience.

Request schema
audienceName string	Audience name.
sourceAudienceIds string	Source audience IDs.
countryIds string	Country IDs.
stateIds string	State IDs.
cityIds string	City IDs.
countyIds string	County IDs.
senateDistrictIds string	Senate district IDs.
houseDistrictIds string	House district IDs.
congressionalDistrictIds string	Congressional district IDs.
audienceSize integer	Audience size.

Response properties

audienceId integer	Audience ID.
message string	Success message.

JSON

Select exampleMinimal location fields sampleAll location fields sample

Request sample

{
  "audienceName": "Test Lookalike Audience",
  "sourceAudienceIds": "12345,67890",
  "audienceSize": 5,
  "countryIds": "1",
  "stateIds": "10,20,30"
}

Request sample

{
  "audienceName": "Test Lookalike Audience with Full Geo",
  "sourceAudienceIds": "12345",
  "audienceSize": 3,
  "countryIds": "1",
  "stateIds": "10,20",
  "cityIds": "100,200,300",
  "countyIds": "50,60",
  "senateDistrictIds": "1,2,3",
  "houseDistrictIds": "10,20",
  "congressionalDistrictIds": "5,6,7"
}

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1140586,
    "message": "Test Lookalike Audience audience created successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          audienceId: number;
          message: string;
        };
      };
    };
  };
}

function CreateLookalikeAudience(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/lookalike',
    requestBody: {
      content: {
        "application/json": {
          audienceName: `string`,
          sourceAudienceIds: `string`,
          countryIds: `string`,
          stateIds: `string`,
          cityIds: `string`,
          countyIds: `string`,
          senateDistrictIds: `string`,
          houseDistrictIds: `string`,
          congressionalDistrictIds: `string`,
          audienceSize: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Campaign audiences

Campaign audience details

GET

Get Campaign audience details by ID.

Path parameter
audienceId integer	Campaign audience ID.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
audienceStatusId integer	Audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
cpm number	Cost per thousand impressions.
uniques integer	Count of unique audiences reached.
createdAt integer	Unix epoch creation date (milliseconds).
campaignDetails object	Campaign details.
campaignDetails object properties impressions array of integers Impressions array. clicks array of integers Clicks array. conversions array of integers Conversions array.
startDate integer	Unix epoch start date (milliseconds).
endDate integer	Unix epoch end date (milliseconds).

JSON

Response 200

{
  "success": true,
  "data": {
    "audienceId": 119431,
    "audienceName": "asdf",
    "audienceStatusId": 1,
    "cpm": 2.5,
    "uniques": 56590,
    "createdAt": 1740876000000,
    "campaignDetails": {
      "clicks": [],
      "conversions": [],
      "impressions": [
        56590
      ]
    },
    "startDate": 1740816000000,
    "endDate": 1753167600000
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          audienceId: number;
          audienceName: string;
          audienceStatusId: number;
          cpm: number;
          uniques: number;
          createdAt: number;
          campaignDetails: {
            clicks: any[];
            conversions: any[];
            impressions: number[];
          };
          startDate: number;
          endDate: number;
        };
      };
    };
  };
}

function GetCampaignAudienceDetails(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/campaign/{audienceId}',
    params: {
      path: {
        audienceId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Create Campaign audience

POST

Create a Campaign audience.

Request schema
audienceName string	Audience name.
startDate integer	Unix epoch start date, in milliseconds.
endDate integer	Unix epoch end date, in milliseconds.
campaignDetails object	Campaign details.
campaignDetails object properties impressions array of integers Impressions. clicks array of integers Clicks. conversions array of integers Conversions.
dataPartnerId integer	Data partner ID for cost calculation (Healthcare vertical). +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
audienceSubtypeId integer	Audience subtype ID, e.g., HCP, Nurse (Healthcare vertical). +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient

Response properties

audienceId integer	Audience ID.
message string	Success message.

JSON

Request sample

{
  "audienceName": "Sample audience name",
  "startDate": 1638316800000,
  "endDate": 1640085173000,
  "campaignDetails": {
    "impressions": [
      1,
      2
    ],
    "clicks": [
      3
    ],
    "conversions": [
      4
    ]
  },
  "dataPartnerId": 2,
  "audienceSubtypeId": 4
}

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1140606,
    "message": "Test campaign audience audience created successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          audienceId: number;
          message: string;
        };
      };
    };
  };
}

function CreateCampaignAudience(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/campaign',
    requestBody: {
      content: {
        "application/json": {
          audienceName: `string`,
          startDate: `number`,
          endDate: `number`,
          campaignDetails: {
            impressions: `number[]`,
            clicks: `number[]`,
            conversions: `number[]`,
          },
          dataPartnerId: `number`,
          audienceSubtypeId: `number`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Campaign audience history

POST

Get the audience history details for specified campaigns.

Request schema
campaignId array of integers	Campaign IDs.
subTypeIds array of integers	Audience subtype IDs. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
historicalData boolean	Fetches historical data (true) or current data (false).
typeIds array of integers	Audience type IDs. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
noOfEntries integer	Number of entries per page.
pageNo integer	Page number of retrieved data.

Response properties

totalRecords integer	Total records count.
filteredRecords integer	Filtered records count.
audienceDetails array of objects	Audience details array.
audienceDetails object properties id integer Audience ID. campaignIds array of integers Campaign IDs. name string Audience name. audienceSubTypeId integer Audience subtype ID (may be null). +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient typeId integer Audience type ID. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience

Request sample

{
  "campaignId": [
    540050
  ],
  "subTypeIds": [],
  "historicalData": false,
  "typeIds": [],
  "noOfEntries": 2,
  "pageNo": 1
}

Response 200

{
  "success": true,
  "data": {
    "totalRecords": 12,
    "filteredRecords": 12,
    "audienceDetails": [
      {
        "id": 1023234,
        "campaignIds": [
          540050
        ],
        "name": "MA-1 voter id",
        "audienceSubTypeId": null,
        "typeId": 1
      },
      {
        "id": 1054138,
        "campaignIds": [
          540050
        ],
        "name": "MA With 90 K Records And 8 Columns NYSD 3 Digital Universe Csv",
        "audienceSubTypeId": null,
        "typeId": 1
      }
    ]
  }
}

Pre-bid audiences

Pre-bid audience details

GET

Get Pre-bid audience details by ID.

Path parameter
audienceId string	Pre-bid audience ID.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
owId integer	Organization Workspace ID.
createdByUowId integer	Created by User Organization Workspace ID.
cpm integer	Cost per mille.
createdAt integer	Unix epoch creation date, in milliseconds.
prebidSegmentDetails array of objects	Pre-bid segment details.
prebidSegmentDetails object properties prebidSegmentId integer Pre-bid audience segment ID. prebidSegmentName string Pre-bid audience segment name. prebidRootId integer Pre-bid audience segment root ID. description string Description. parentPathKey string Key representing parent path or category that an audience segment belongs to. cpm integer Cost per mille. creativeTypeIds array of integers Creative type ID list. +Supported values 0 All 11 Image 13 HTML 14 Video 15 Native 17 Audio leaf boolean Indicates that an audience segment is a leaf node in a hierarchical audience structure: true. providerId integer Provider ID. providerLogoUrl string Provider logo URL.

JSON

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1139208,
    "audienceName": "test",
    "cpm": 0.325,
    "owId": 201427,
    "createdByUowId": 9480,
    "createdAt": 1750866960,
    "prebidSegmentDetails": [
      {
        "prebidSegmentId": 247,
        "prebidSegmentName": "Impressions with Insufficient IAB Viewability Data",
        "description": "Impressions where DV does not have sufficient viewability performance statistics for the URL or URL can not be targeted (e.g., blinded).",
        "parentPathKey": "Viewability > Video",
        "prebidRootId": 159,
        "cpm": 0.2,
        "creativeTypeIds": [
          14,
          15
        ],
        "leaf": false,
        "providerId": 2,
        "providerLogoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/dist/audience/prebid-providers/DV-logo.svg"
      },
      {
        "prebidSegmentId": 248,
        "prebidSegmentName": "80% or Higher Viewability Rate",
        "description": "For video, this is a rate-based segment used to target the URLs that have historically achieved a 80% or higher viewability rate based on the IAB standard.",
        "parentPathKey": "Viewability > Video",
        "prebidRootId": 159,
        "cpm": 0.2,
        "creativeTypeIds": [
          14,
          15
        ],
        "leaf": false,
        "providerId": 2,
        "providerLogoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/dist/audience/prebid-providers/DV-logo.svg"
      }
    ]
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          name: string;
          status: string;
          owId: number;
          createdByUowId: number;
          cpm: number;
          createdOn: number;
          prebidSegmentData: {
            prebidAudienceSegmentId: number;
            prebidAudienceSegmentName: string;
            prebidAudienceSegmentRootId: number;
            description: string;
            parentPathKey: string;
            cpm: number;
            creativeTypeIdList: number[];
            providerId: number;
            providerName: string;
            providerLogoUrl: string;
          }[];
        };
      };
    };
  };
}

function getPrebidAudienceDetailsByAudienceId(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/prebid/{prebidAudienceId}',
    params: {
      path: {
        prebidAudienceId: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Search Pre-bid audience details

POST

Search Pre-bid audiences by specified parameters.

Request schema
searchField string	Filter results by search field.
prebidSegmentIds array of integers	Pre-bid segment ID list.
customerOwId integer	Customer Organization Workspace ID.
showinActiveSegments boolean	Include inactive segments in results: true to include inactive segments; false to exclude inactive segments (default: false).

Response properties

prebidSegmentData array of objects	Pre-bid segment data.
prebidSegmentData object properties prebidSegmentId integer Pre-bid audience segment ID. prebidSegmentName string Pre-bid audience segment name. description string Description. parentPathKey string Parent path key. cpm integer Cost per mille. isLeaf boolean Indicates that an audience segment is a leaf node in a hierarchical audience structure: true. creativeTypeIds array of integers Creative type ID list. +Supported values 0 All 11 Image 13 HTML 14 Video 15 Native 17 Audio prebidRootId integer Pre-bid audience root ID. providerId integer Provider ID.

JSON

Select exampleAdvertiser request sampleNon-Advertiser request sample

Request sample

{
  "prebidSegmentIds": [
    156,
    157
  ],
  "searchField": "risk",
  "showInActiveSegments": true
}

Request sample

{
  "prebidSegmentIds": [
    156,
    157
  ],
  "searchField": "risk",
  "customerOwId": 201332
}

Response 200

{
  "success": true,
  "data": [
    {
      "prebidSegmentId": 158,
      "prebidSegmentName": "Avoid High and Moderate risk Alcohol content pages",
      "description": "Avoid High and Moderate risk Alcohol content pages",
      "parentPathKey": "Brand Safety > Display",
      "cpm": 0.05,
      "isLeaf": true,
      "creativeTypeIds": [
        11,
        14
      ],
      "prebidRootId": 1,
      "providerId": 1
    },
    {
      "prebidSegmentId": 156,
      "prebidSegmentName": "Avoid High and Moderate risk Adult content pages",
      "description": "Avoid High and Moderate risk Adult content pages",
      "parentPathKey": "Brand Safety > Display",
      "cpm": 0.05,
      "isLeaf": true,
      "creativeTypeIds": [
        11,
        14
      ],
      "prebidRootId": 1,
      "providerId": 1
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          totalRecords: number;
          filteredRecords: number;
          prebidSegmentData: {
            prebidAudienceSegmentId: number;
            prebidAudienceSegmentName: string;
            prebidAudienceSegmentRootId: number;
            description: string;
            parentPathKey: string;
            cpm: number;
            creativeTypeIdList: number[];
            providerId: number;
            providerName: string;
            providerLogoUrl: string;
          }[];
        };
      };
    };
  };
}

function getPrebidSegmentDetailsBySearch(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/prebid/details/search/list',
    requestBody: {
      content: {
        "application/json": {
          providerIdList?: `number[]`,
          prebidAudienceSegmentIdList?: `number[]`,
          prebidAudienceIdList?: `number[]`,
          searchField?: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Create Pre-bid audience

POST

Pre-bid audiences are groups of Fraud , Brand Safety, and Viewability pre-bid segments that you select. You can create these audiences and seamlessly integrate them into new or existing campaigns.

warning

The IQM platform supports one creative type per campaign. Pre-bid segments include both display and video that can be selected. Choose only one format for each Pre-bid audience to avoid incurring extra charges.

Request schema
audienceName string	Pre-bid audience name.
prebidSegmentIds array of integers	Pre-bid audience segment ID list.
prebidProviderId integer	Pre-bid audience provider ID.

Response properties

id integer	Audience ID.
message string	Success message.

JSON

Request sample

{
  "audienceName": "string",
  "prebidSegmentIds": [
    0
  ],
  "prebidProviderId": 1
}

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1026631,
    "message": "Test Audience audience created successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          message: string;
        };
      };
    };
  };
}

function createPrebidAudience(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/prebid',
    requestBody: {
      content: {
        "application/json": {
          audienceName: `string`,
          prebidSegmentIds: `number[]`,
          prebidProviderId: `number`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Pre-bid audience

PATCH

Update a Pre-bid audience.

Path parameter
audienceId string	Pre-bid audience ID.

Request schema
audienceName string	Pre-bid audience name.
prebidSegmentIds array of integers	Pre-bid audience segment ID list.
prebidProviderId integer	Pre-bid audience provider ID.

Response properties

audienceId integer	Audience ID.
message string	Success message.

JSON

Request sample

{
  "audienceName": "Test 2",
  "prebidSegmentIds": [
    163,
    164
  ],
  "prebidProviderId": 2
}

Response 200

{
  "success": true,
  "data": {
    "audienceId": 1140257,
    "message": "Changes saved successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          audienceId: number;
          message: string;
        };
      };
    };
  };
}

function editPrebidAudience(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/audience/prebid/{audienceId}',
    params: {
      path: {
        audienceId: `number`,
      }
    },
    requestBody: {
      content: {
        "application/json": {
          audienceName: `string`,
          prebidSegmentIds: `number[]`,
          prebidProviderId: `number`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get pre-bid provider child segment details

GET

Get the pre-bid provider child segment details.

Query parameter
showinActiveSegments boolean	Include inactive segments in results: true to include inactive segments; false to exclude inactive segments (default: false).

Response properties

providerId integer	Provider ID.
providerName string	Provider name.
description string	Provider description.
providerLogoUrl string	Provider logo URL.
childSegments array of objects	Child segments details.
childSegments object properties prebidSegmentId integer Pre-bid segment ID. prebidSegmentName string Pre-bid segment name. description string Pre-bid segment description. parentPathKey string Parent path key. cpm number Cost per mille. creativeTypeIdList array of integers Creative type ID list. +Supported values 0 All 11 Image 13 HTML 14 Video 15 Native 17 Audio leaf boolean Indicates that an audience segment is a leaf node in a hierarchical audience structure: true.

Response 200

{
  "success": true,
  "data": [
    {
      "providerId": 1,
      "providerName": "Integral Ad Science",
      "description": "Segments for Brand Safety, Viewability, Fraud & IVT",
      "providerLogoUrl": "http://logoUrl.com",
      "childSegments": [
        {
          "prebidSegmentId": 2,
          "prebidSegmentName": "Fraud & IVT",
          "description": "prebidSegmentDescription",
          "parentPathKey": "prebid > IAS",
          "cpm": 0,
          "creativeTypeIdList": [
            11,
            14
          ],
          "leaf": false
        },
        {
          "prebidSegmentId": 1,
          "prebidSegmentName": "Brand Safety",
          "description": "prebidSegmentDescription",
          "parentPathKey": "prebid > IAS",
          "cpm": 0,
          "creativeTypeIdList": [
            11,
            14
          ],
          "leaf": false
        }
      ]
    }
  ]
}

---

Get pre-bid child segment details

GET

Get the pre-bid child segment details based on the parent pre-bid segment ID.

Query parameter
prebidParentSegmentId integer	Parent pre-bid segment ID.

Response properties

prebidSegmentId integer	Pre-bid segment ID.
prebidSegmentName string	Pre-bid segment name.
description string	Description.
parentPathKey string	Parent path key.
cpm number	Cost per mille.
creativeTypeIds array of integers	Creative type ID list. +Supported values 0 All 11 Image 13 HTML 14 Video 15 Native 17 Audio
leaf boolean	Indicates that an audience segment is a leaf node in a hierarchical audience structure: true.

Response 200

{
  "success": true,
  "data": [
    {
      "prebidSegmentId": 4,
      "prebidSegmentName": "Display",
      "description": null,
      "parentPathKey": "IAS > Brand Safety",
      "cpm": 0,
      "creativeTypeIds": [
        11,
        14
      ],
      "leaf": false
    },
    {
      "prebidSegmentId": 5,
      "prebidSegmentName": "Video",
      "description": null,
      "parentPathKey": "IAS > Brand Safety",
      "cpm": 0,
      "creativeTypeIds": [
        11,
        14
      ],
      "leaf": false
    }
  ]
}

---

DoubleVerify Pre-bid audience segment details

GET

Get the DoubleVerify IVT Pre-bid audience segments which are free and available to an Advertiser.

Response properties

prebidSegmentId integer	Pre-bid segment ID.
providerId integer	Provider ID.
defaultSelected boolean	Indicates if segment is selected by default.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "prebidSegmentId": 234,
      "providerId": 2,
      "defaultSelected": true
    },
    {
      "prebidSegmentId": 235,
      "providerId": 2,
      "defaultSelected": true
    },
    {
      "prebidSegmentId": 236,
      "providerId": 2,
      "defaultSelected": true
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          prebidSegmentId: number;
          providerId: number;
          defaultSelected: boolean;
        }[];
      }
    }
  };
}

function getDvIvtFreePrebidSegments(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/prebid/dv-ivt/free-segments',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

More audience details

Reach range list for Segmented audiences

GET

Get a static list of the available reach range used to filter Segmented audience data.

Response properties

id integer	Reach range ID.
name string	Reach range name.
displayName string	Reach range display name.
order integer	order.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Unknown",
      "order": 1,
      "displayName": "Unknown"
    },
    {
      "id": 2,
      "name": "<10K",
      "order": 2,
      "displayName": "<10K"
    },
    {
      "id": 3,
      "name": "10K to 100K",
      "order": 3,
      "displayName": "10K to 100K"
    },
    {
      "id": 4,
      "name": "100K to 1M",
      "order": 4,
      "displayName": "100K to 1M"
    },
    {
      "id": 5,
      "name": "1M+",
      "order": 5,
      "displayName": "1M+"
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json;charset=UTF-8": {
        success: boolean;
        data: {
          displayName: string;
          id: number;
          order: string;
        }[];
      };
    };
  };
}

function getSegmentReachRange(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/static/segment/reach-range',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Price range list for Segmented audiences

GET

Get a static list of available CPM ranges used to filter Segmented audience data.

Response properties

id integer	Price range ID.
name string	Price range name.
displayName string	Price range display name.
order integer	Order.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "$0 to $1",
      "order": 1,
      "displayName": "$0 to $1"
    },
    {
      "id": 2,
      "name": "$1 to $2",
      "order": 2,
      "displayName": "$1 to $2"
    },
    {
      "id": 3,
      "name": "$2 to $5",
      "order": 3,
      "displayName": "$2 to $5"
    },
    {
      "id": 4,
      "name": "$5 to $10",
      "order": 4,
      "displayName": "$5 to $10"
    },
    {
      "id": 5,
      "name": "$10+",
      "order": 5,
      "displayName": "$10+"
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json;charset=UTF-8": {
        success: boolean;
        data: {
          displayName: string;
          id: number;
          order: string;
        }[];
      };
    };
  };
}

function getSegmentPriceRange(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/static/segment/price-range',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Audience type list

GET

Get a static list of audience types.

Response properties

id integer	Audience type ID.
name string	Audience type name.
displayName string	Audience type display name.
displayOrder integer	Order.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Matched Audience",
            "order": 1,
            "displayName": "Matched Audience"
        },
        {
            "id": 2,
            "name": "Segmented Audience",
            "order": 2,
            "displayName": "Segmented Audience"
        },
        {
            "id": 10,
            "name": "Custom Voter Audience",
            "order": 3,
            "displayName": "Custom Voter Audience"
        },
        {
            "id": 3,
            "name": "Retargeted Audience",
            "order": 4,
            "displayName": "Retargeted Audience"
        },
        {
            "id": 4,
            "name": "Geofarmed Audience",
            "order": 5,
            "displayName": "Geofarmed Audience"
        },
        {
            "id": 5,
            "name": "Contextual Audience",
            "order": 6,
            "displayName": "Contextual Audience"
        },
        {
            "id": 6,
            "name": "Lookalike Audience",
            "order": 7,
            "displayName": "Lookalike Audience"
        },
        {
            "id": 7,
            "name": "Campaign Audience",
            "order": 8,
            "displayName": "Campaign Audience"
        },
        {
            "id": 8,
            "name": "Pre-bid Audience",
            "order": 9,
            "displayName": "Pre-bid Audience"
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          displayName: string;
          displayOrder: number;
        }[];
      };
    };
  };
}

function getAudienceTypesList(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/static/audience-types',
  }

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Audience subtype list

GET

Get a static list of audience subtypes.

Query parameter
audienceTypeIds integer	Audience type IDs. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
verticalId integer	Vertical ID. +Supported values 1 Political 2 Healthcare 3 Specialty

Response properties

id integer	Audience subtype ID.
name string	Audience subtype name.
order integer	Order.
displayName string	Audience subtype display name.

Response 200

{
  "success": true,
  "data": {
    "audienceSubtypes": [
      {
        "id": 3,
        "name": "hcp",
        "order": 3,
        "displayName": "HCP"
      },
      {
        "id": 4,
        "name": "npi_nurse",
        "order": 4,
        "displayName": "Nurse"
      },
      {
        "id": 5,
        "name": "non_npi_nurse",
        "order": 5,
        "displayName": "Non-NPI Nurse"
      },
      {
        "id": 6,
        "name": "patient",
        "order": 6,
        "displayName": "Patient"
      }
    ],
    "totalRecords": 4,
    "filteredRecords": 4
  }
}

---

Audience status list

GET

Get a static list of audience statuses. If audienceTypeIds isn't provided, audience statuses for all audience types are fetched.

Query parameters
audienceTypeIds array of integers	Audience type IDs to fetch applicable audience statuses for. +Supported values 1 Matched audience 2 Segmented audience 3 Retargeted audience 4 Geofarmed audience 5 Contextual audience 6 Lookalike audience 7 Campaign audience 8 Pre-bid audience 9 Account Based Marketing (ABM) audience 10 Custom Voter audience (CVA) 11 Integrated Care Team (ICT) audience 12 Power Segment audience
verticalIds array of integers	Vertical IDs to filter audience statuses by (default: all verticals). +Supported values 1 Political 2 Healthcare 3 Specialty
deletedStatusRequired boolean	Whether to include the Deleted status in the response (default: false).

Response properties

id integer	Audience status ID.
name string	Status name.
order integer	Order.
displayName string	Audience status display name.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "id": 6,
      "name": "failed",
      "order": 1,
      "displayName": "Failed"
    },
    {
      "id": 2,
      "name": "pending",
      "order": 2,
      "displayName": "Pending"
    },
    {
      "id": 1,
      "name": "processing",
      "order": 3,
      "displayName": "Processing"
    },
    {
      "id": 7,
      "name": "fetching data",
      "order": 4,
      "displayName": "Fetching Data"
    },
    {
      "id": 8,
      "name": "data fetched",
      "order": 5,
      "displayName": "Data Fetched"
    },
    {
      "id": 4,
      "name": "rejected",
      "order": 6,
      "displayName": "Rejected"
    },
    {
      "id": 3,
      "name": "ready",
      "order": 7,
      "displayName": "Ready"
    }
]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        statusCode: number;
        responseObject: {
          id: number;
          name: string;
          order: number;
          displayName: string;
        }[];
      };
    };
  };
}

function GetAudienceStatus(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/static/audience-status',
    params: {
      query: {
        audienceTypeIds: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Frequency type list

GET

Get a static list of Geofarmed audience frequency types.

Response properties

id integer	Frequency ID.
name string	Frequency name.
displayName string	Frequency display name.
order integer	Order.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "total",
      "displayName": "Total",
      "order": 1
    },
    {
      "id": 2,
      "name": "weekly",
      "displayName": "Weekly",
      "order": 2
    },
    {
      "id": 3,
      "name": "monthly",
      "displayName": "Monthly",
      "order": 3
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        statusCode: number;
        responseObject: {
          id: number;
          status: string;
          displayName: string;
        }[];
      };
    };
  };
}

function GetGeofarmedFrequencyTypes(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/static/frequency-types',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---