Audience API

The Audience API allows you to create different types of audiences for Healthcare campaigns.

The following table describes some of the audience types:

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.
ABM audience	Account Based Marketing for Healthcare campaigns.
ICT audience	Integrated Care Team audiences are a type of Matched audience intended for Healthcare-audience expansion.
Geofarmed audience	Define an audience by a custom geographical area.
Contextual audience	IQM adds users to an audience when they visit sites featuring specified keywords or URLs.
Campaign audience	Retarget an audience associated with a campaign. Healthcare Advertisers can specify a Campaign audience type during creation, ensuring only campaigns with relevant targeted audiences are selected.

More resources

See our full Audience API documentation or review these Help Center articles for more information on how to use audiences for your Healthcare campaigns:

• What is NPI matching?
• Matched audience
• Account Based Marketing (ABM) audience
• Integrated Care Team (ICT) audience overview
• Create a Contextual audience (Healthcare)
• Create a Geofarmed audience (Healthcare)
• Audience targeting

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
    }
  ]
}

---

Healthcare data details

Healthcare titles list

GET

Get a list of Healthcare titles.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
searchField string	Filter results by search field.
audienceSubtypeIds array of integers	List of audience subtype IDs to filter the Healthcare titles. Comma-separated string of IDs is also allowed. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
includeGenericAudience boolean	When true, includes records with no audience subtype alongside any matched subtype IDs. Default: false.

Response properties

id integer	Title ID.
displayName string	Title name.
displayOrder integer	Display order.
reach integer	Unique reach for this title.
audienceSubtypeId integer	Audience subtype ID associated with this record. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient

JSON

Response 200

{
  "success": true,
  "data": {
    "titleList": [
      {
        "id": 1,
        "displayName": "Healthcare Title 1",
        "displayOrder": 1,
        "reach": 12345,
        "audienceSubtypeId": 3
      },
      {
        "id": 2,
        "displayName": "Healthcare Title 2",
        "displayOrder": 20,
        "reach": 54321,
        "audienceSubtypeId": null
      }
    ],
    "filteredRecords": 5,
    "totalRecords": 3294
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

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

function getHealthcareTitleList(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/titles',
    params: {
      query: {
        dataProviderIds: `number[]`,
        pageNo?: `number`,
        noOfEntries?: `number`,
        searchField?: `string`,
      }
    }
  }

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

---

Healthcare specialties list

GET

Get a list of Healthcare specialties.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
searchField string	Filter results by search field.
audienceSubtypeIds array of integers	List of audience subtype IDs to filter the Healthcare specialties. Comma-separated string of IDs is also allowed. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
includeGenericAudience boolean	When true, includes records with no audience subtype alongside any matched subtype IDs. Default: false.

Response properties

id integer	Specialty ID.
displayName string	Specialty name.
displayOrder integer	Display order.
reach integer	Unique reach for this specialty.
audienceSubtypeId integer	Audience subtype ID associated with this record. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient

JSON

Response 200

{
  "success": true,
  "data": {
    "specialityList": [
      {
        "id": 1,
        "displayName": "Healthcare Speciality 1",
        "displayOrder": 1,
        "reach": 12345,
        "audienceSubtypeId": 3
      },
      {
        "id": 2,
        "displayName": "Healthcare Speciality 2",
        "displayOrder": 20,
        "reach": 54321,
        "audienceSubtypeId": null
      }
    ],
    "filteredRecords": 5,
    "totalRecords": 3294
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

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

function getHealthcareSpecialityList(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/specialities',
    params: {
      query: {
        dataProviderIds: `number[]`,
        pageNo?: `number`,
        noOfEntries?: `number`,
        searchField?: `string`,
      }
    }
  }

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

---

Healthcare systems list

GET

Get a list of Healthcare systems.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
searchField string	Filter results by search field.
audienceSubtypeIds array of integers	List of audience subtype IDs to filter the Healthcare systems. Comma-separated string of IDs is also allowed. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
includeGenericAudience boolean	When true, includes records with no audience subtype alongside any matched subtype IDs. Default: false.

Response properties

id integer	System ID.
displayName string	System name.
displayOrder integer	Display order.
reach integer	Unique reach for this system.
audienceSubtypeId integer	Audience subtype ID associated with this record. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient

JSON

Response 200

{
  "success": true,
  "data": {
    "healthcareSystemList": [
      {
        "id": 1,
        "displayName": "Healthcare System 1",
        "displayOrder": 1,
        "reach": 1000,
        "audienceSubtypeId": 3
      },
      {
        "id": 2,
        "displayName": "Healthcare System 2",
        "displayOrder": 20,
        "reach": 2000,
        "audienceSubtypeId": 3
      }
    ],
    "filteredRecords": 5,
    "totalRecords": 3294
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

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

function getHealthcareSystemList(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/healthcare-systems',
    params: {
      query: {
        dataProviderIds: `number[]`,
        pageNo?: `number`,
        noOfEntries?: `number`,
        searchField?: `string`,
      }
    }
  }

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

---

Healthcare data

POST

Get a Healthcare data list by specified filters.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
healthCareSystemIds array of integers	Healthcare system IDs.
accountNameIds array of integers	Healthcare account name IDs.
accountTypeIds array of integers	Healthcare account type IDs.
accountSubTypeIds array of integers	Healthcare account subtype IDs.
countryIds array of integers	Country IDs.
stateIds array of integers	State IDs.
cityIds array of integers	City IDs.
titleIds array of integers	Healthcare title IDs.
specialityIds array of integers	Healthcare specialty IDs.
ids array of integers	IDs.
audienceSubtypeIds array of integers	Audience subtype IDs to filter the records. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
includeGenericAudience boolean	When true, includes records with no audience subtype alongside any matched subtype IDs. Default: false.

Response properties

id integer	Audience ID.
cost integer	Charges for a specific segment.
reach integer	Unique reach of segments (i.e., audience reach).
healthCareSystemId integer	Healthcare system ID.
healthCareSystemName string	Healthcare system name.
accountId integer	Healthcare account ID.
accountName string	Healthcare account name.
accountTypeId integer	Healthcare account type ID.
accountTypeName string	Healthcare account type name.
accountSubTypeId integer	Healthcare account subtype ID.
accountSubTypeName string	Healthcare account subtype name.
titleId integer	Healthcare title ID.
titleName string	Healthcare title name.
specialityId integer	Healthcare specialty ID.
specialityName string	Healthcare specialty name.
countryId integer	Country ID.
countryName string	Country name.
stateId integer	State ID.
stateName string	State name.
cityId integer	City ID.
cityName string	City name.
dataProviderId integer	Data provider ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
dataProviderName string	Data provider name.

JSON

Request sample

{
  "dataProviderIds": [
    1
  ],
  "healthCareSystemIds": [
    40100004,
    40100007
  ],
  "accountIds": [
    40208104,
    40628423
  ],
  "accountTypeIds": [
    40300003
  ],
  "accountSubTypeIds": [
    40400001,
    40400010
  ],
  "countryIds": [
    30100001
  ],
  "stateIds": [
    30200028,
    30200043
  ],
  "cityIds": [
    30430356,
    30447825,
    30447952,
    30448122
  ],
  "titleIds": [
    40500099
  ],
  "specialityIds": [
    40500014,
    40500086
  ],
  "ids": [
    1,
    2,
    3
  ],
  "pageNo": 1,
  "noOfEntries": 2,
  "audienceSubtypeIds": [3],
  "includeGenericAudience": false
}

Response 200

{
  "success": true,
  "data": {
    "totalRecords": 52265,
    "filteredRecords": 5,
    "healthCareData": [
      {
        "id": 1,
        "cost": 10,
        "reach": 1,
        "healthCareSystemId": 40100004,
        "healthCareSystemName": "ABCD PEDIATRICS",
        "accountId": 40628423,
        "accountName": "Stepping Stone Pediatrics PA",
        "accountTypeId": 40300003,
        "accountTypeName": "Group Practice",
        "accountSubTypeId": 40400010,
        "accountSubTypeName": "Telephone/E-Mail Order Pharmacy",
        "titleId": 40500099,
        "titleName": "MD",
        "specialityId": 40500086,
        "specialityName": "Gastroenterology",
        "countryId": 30100001,
        "countryName": "United States",
        "stateId": 30200043,
        "stateName": "Tennessee",
        "cityId": 30447952,
        "cityName": "Franklin, TN",
        "dataProviderId": 1,
        "dataProviderName": "HealthCarelink",
        "audienceSubtypeId": 3
      },
      {
        "id": 2,
        "cost": 10,
        "reach": 1,
        "healthCareSystemId": 40100004,
        "healthCareSystemName": "ABCD PEDIATRICS",
        "accountId": 40628423,
        "accountName": "Stepping Stone Pediatrics PA",
        "accountTypeId": 40300003,
        "accountTypeName": "Group Practice",
        "accountSubTypeId": 40400010,
        "accountSubTypeName": "Telephone/E-Mail Order Pharmacy",
        "titleId": 40500099,
        "titleName": "MD",
        "specialityId": 40500086,
        "specialityName": "Gastroenterology",
        "countryId": 30100001,
        "countryName": "United States",
        "stateId": 30200043,
        "stateName": "Tennessee",
        "cityId": 30447825,
        "cityName": "Brentwood, TN",
        "dataProviderId": 1,
        "dataProviderName": "HealthCarelink",
        "audienceSubtypeId": 3
      }
    ]
  }
}

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;
          healthCareData: {
            id: number;
            cost: number;
            reach: number;
            healthCareSystemId: number;
            healthCareSystemName: string;
            accountId: number;
            accountName: string;
            accountTypeId: number;
            accountTypeName: string;
            accountSubTypeId: number;
            accountSubTypeName: string;
            titleId: number;
            titleName: string;
            specialityId: number;
            specialityName: string;
            countryId: number;
            countryName: string;
            stateId: number;
            stateName: string;
            cityId: number;
            cityName: string;
            dataProviderId: number;
            dataProviderName: string;
          }[];
        }
      };
    };
  };
}

function getHealthCareData(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data',
    requestBody: {
      content: {
        "application/json": {
          searchBy?: `string[]`,
          ids?: `number[]`,
          dataProviderIds?: `number[]`,
          healthCareSystemIds?: `number[]`,
          accountIds?: `number[]`,
          accountTypeIds?: `number[]`,
          accountSubTypeIds?: `number[]`,
          titleIds?: `number[]`,
          specialityIds?: `number[]`,
          countryIds?: `number[]`,
          stateIds?: `number[]`,
          cityIds?: `number[]`,
          pagination?: `string`,
          pageNo?: `number`,
          noOfEntries?: `number`,
          sortBy?: `string`,
          searchField?: `string`,
          order?: `ASC` | `DESC`,
          offset?: `number`,
        }
      }
    }
  }

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

---

Healthcare statistics

POST

Get Healthcare statistics details.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
healthCareSystemIds array of integers	Healthcare system IDs.
accountNameIds array of integers	Account name IDs.
accountTypeIds array of integers	Healthcare account type IDs.
accountSubTypeIds array of integers	Account subtype IDs.
countryIds array of integers	Country IDs.
stateIds array of integers	State IDs.
cityIds array of integers	City IDs.
titleIds array of integers	Title IDs.
specialityIds array of integers	Healthcare specialty IDs.
ids array of integers	IDs.
audienceSubtypeIds array of integers	Audience subtype IDs to filter the records. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
includeGenericAudience boolean	When true, includes records with no audience subtype alongside any matched subtype IDs. Default: false.

Response properties

healthSystem integer	Healthcare system ID.
account integer	Healthcare account ID.
accountType integer	Healthcare account type ID.
npiReach integer	NPI reach.
speciality integer	Healthcare specialty ID.

JSON

Request sample

{
  "dataProviderIds": [
    1
  ],
  "healthCareSystemIds": [
    40100004,
    40100007
  ],
  "accountIds": [
    40208104,
    40628423
  ],
  "accountTypeIds": [
    40300003
  ],
  "accountSubTypeIds": [
    40400001,
    40400010
  ],
  "countryIds": [
    30100001
  ],
  "stateIds": [
    30200028,
    30200043
  ],
  "cityIds": [
    30430356,
    30447825,
    30447952,
    30448122
  ],
  "titleIds": [
    40500099
  ],
  "specialityIds": [
    40500014,
    40500086
  ],
  "ids": [
    1,
    2,
    3
  ],
  "pageNo": 1,
  "noOfEntries": 2,
  "audienceSubtypeIds": [3],
  "includeGenericAudience": false
}

Response 200

{
  "success": true,
  "data": {
    "healthSystem": 2,
    "account": 4,
    "accountType": 8,
    "npiReach": 25513,
    "speciality": 3
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          healthSystem: number;
          account: number;
          accountType: number;
          npiReach: number;
          speciality: number;
        }
      };
    };
  };
}

function getHealthCareDataStatistics(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/statistics',
    requestBody: {
      content: {
        "application/json": {
          searchBy?: `string[]`,
          ids?: `number[]`,
          dataProviderIds?: `number[]`,
          healthCareSystemIds?: `number[]`,
          accountIds?: `number[]`,
          accountTypeIds?: `number[]`,
          accountSubTypeIds?: `number[]`,
          titleIds?: `number[]`,
          specialityIds?: `number[]`,
          countryIds?: `number[]`,
          stateIds?: `number[]`,
          cityIds?: `number[]`,
          pagination?: `string`,
          pageNo?: `number`,
          noOfEntries?: `number`,
          sortBy?: `string`,
          searchField?: `string`,
          order?: `ASC` | `DESC`,
          offset?: `number`,
        }
      }
    }
  }

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

---

Healthcare account types

POST

Get a list of Healthcare account types.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
healthCareSystemIds array of integers	Healthcare system IDs.
accountNameIds array of integers	Account name IDs.
searchField string	Filter results by search field.
audienceSubtypeIds array of integers	Audience subtype IDs to filter the records. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
includeGenericAudience boolean	When true, includes records with no audience subtype alongside any matched subtype IDs. Default: false.

Response properties

id integer	Account ID.
audienceSubtypeId integer	Audience subtype ID associated with this record. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
displayName string	Account name.
displayOrder integer	Display order.

JSON

Request sample

{
  "pageNo": 1,
  "noOfEntries": 20,
  "searchField": "Sample Text",
  "dataProviderIds": [
    1
  ],
  "healthcareSystemIds": [
    1,
    2,
    3
  ],
  "accountNameIds": [
    4,
    5,
    6
  ],
  "audienceSubtypeIds": [3],
  "includeGenericAudience": false
}

Response 200

{
  "success": true,
  "data": {
    "accountTypeList": [
      {
        "id": 1,
        "displayName": "Account Type 1",
        "displayOrder": 1,
        "audienceSubtypeId": 3
      },
      {
        "id": 2,
        "displayName": "Account Type 2",
        "displayOrder": 2,
        "audienceSubtypeId": null
      }
    ],
    "filteredRecords": 5,
    "totalRecords": 3294
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

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

function getAccountTypeList(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/account-types',
    requestBody: {
      content: {
        "application/json": {
          searchBy?: `string[]`,
          ids?: `number[]`,
          dataProviderIds?: `number[]`,
          verticalId: `number`,
          healthCareSystemIds?: `number[]`,
          accountNameIds?: `number[]`,
          accountTypeIds?: `number[]`,
          pagination?: `string`,
          pageNo?: `number`,
          noOfEntries?: `number`,
          sortBy?: `string`,
          searchField?: `string`,
          order?: `ASC` | `DESC`,
          offset?: `number`,
        }
      }
    }
  }

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

---

Healthcare account subtypes

POST

Get a list of Healthcare account subtypes.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
healthCareSystemIds array of integers	Healthcare system IDs.
accountNameIds array of integers	Account name IDs.
searchField string	Filter results by search field.
accountTypeIds array of integers	Healthcare account type IDs.
audienceSubtypeIds array of integers	Audience subtype IDs to filter the records. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
includeGenericAudience boolean	When true, includes records with no audience subtype alongside any matched subtype IDs. Default: false.

Response properties

id integer	Account subtype ID.
audienceSubtypeId integer	Audience subtype ID associated with this record. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
displayName string	Account sub name.
displayOrder integer	Display order.

JSON

Request sample

{
  "pageNo": 1,
  "noOfEntries": 20,
  "searchField": "Sample Text",
  "dataProviderIds": [
    1
  ],
  "healthcareSystemIds": [
    1,
    2,
    3
  ],
  "accountNameIds": [
    4,
    5,
    6
  ],
  "accountTypeIds": [
    7,
    8,
    9
  ],
  "audienceSubtypeIds": [3],
  "includeGenericAudience": true
}

Response 200

{
  "success": true,
  "data": {
    "accountSubTypeList": [
      {
        "id": 1,
        "displayName": "Account Subtype 1",
        "displayOrder": 1,
        "audienceSubtypeId": 3
      },
      {
        "id": 2,
        "displayName": "Account Subtype 2",
        "displayOrder": 2,
        "audienceSubtypeId": null
      }
    ],
    "filteredRecords": 5,
    "totalRecords": 3294
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

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

function getAccountSubTypeList(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/account-subtypes',
    requestBody: {
      content: {
        "application/json": {
          searchBy?: `string[]`,
          ids?: `number[]`,
          dataProviderIds?: `number[]`,
          verticalId: `number`,
          healthCareSystemIds?: `number[]`,
          accountNameIds?: `number[]`,
          accountTypeIds?: `number[]`,
          pagination?: `string`,
          pageNo?: `number`,
          noOfEntries?: `number`,
          sortBy?: `string`,
          searchField?: `string`,
          order?: `ASC` | `DESC`,
          offset?: `number`,
        }
      }
    }
  }

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

---

Healthcare account names

POST

Get a list of Healthcare account names.

Query parameters
dataProviderIds array of integers	Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
pageNo integer	Page number of retrieved data, default: 0.
noOfEntries integer	Number of entries returned per page, default: 50.
healthCareSystemIds array of integers	Healthcare system IDs.
searchField string	Filter results by search field.

Response properties

id integer	Account name ID.
displayName string	Account name.
displayOrder integer	Display order.

JSON

Request sample

{
  "pageNo": 1,
  "noOfEntries": 20,
  "searchField": "Sample text",
  "dataProviderIds": [
    1
  ],
  "healthcareSystemIds": [
    1,
    2,
    3
  ]
}

Response 200

{
  "success": true,
  "data": {
    "accountNameList": [
      {
        "id": 1,
        "displayName": "Account Name 1",
        "displayOrder": 1
      },
      {
        "id": 2,
        "displayName": "Account Name 2",
        "displayOrder": 20
      }
    ],
    "filteredRecords": 5,
    "totalRecords": 3294
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

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

function getAccountNameList(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/account-names',
    requestBody: {
      content: {
        "application/json": {
          searchBy?: `string[]`,
          ids?: `number[]`,
          dataProviderIds?: `number[]`,
          verticalId: `number`,
          healthCareSystemIds?: `number[]`,
          accountNameIds?: `number[]`,
          accountTypeIds?: `number[]`,
          pagination?: `string`,
          pageNo?: `number`,
          noOfEntries?: `number`,
          sortBy?: `string`,
          searchField?: `string`,
          order?: `ASC` | `DESC`,
          offset?: `number`,
        }
      }
    }
  }

  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);
}

ABM audiences

ABM audience details

GET

Get Account Based Marketing (ABM) audience details by ID.

Path parameters
audienceId integer	ABM audience ID.

Response properties

id integer	Audience ID.
name string	Audience name.
status string	Audience status.
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
createdAt integer	Unix epoch timestamp of audience creation.
partnerName string	Partner name.
partnerLogoUrl string	Partner logo URL.
uniques integer	Count of unique audiences reached.
dataCost integer	Fees charged by the platform if the audience is used in any campaign.
filters object	Filter criteria used to define this audience.
filter object properties dataProviderIds array of integers Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID accountIds array of integers Account IDs. accountTypeIds array of integers Healthcare account type IDs. accountSubTypeIds array of integers Healthcare account subtype IDs. countryIds array of integers Country IDs. stateIds array of integers State IDs. cityIds array of integers City IDs. titleIds array of integers Title IDs. specialityIds array of integers Speciality IDs. ids array of integers IDs. pageNo array of integers Page number of retrieved data. noOfEntries array of integers Number of entries returned per page.

JSON

Response 200

{
  "success": true,
  "data": {
    "id": 1124243,
    "name": "Test ABM audience",
    "status": "Processing",
    "audienceTypeId": 9,
    "createdAt": 1739261114,
    "partnerName": "Healthlink",
    "partnerLogoUrl": "www.sample.com",
    "uniques": 1000,
    "dataCost": 10,
    "healthCareDataMappingIds": [
      13572,
      13575,
      32777
    ],
    "filters": {
      "ids": [
        13572,
        13575,
        32777
      ],
      "dataProviderIds": [
        1
      ],
      "healthCareSystemIds": [
        1,
        2,
        3
      ],
      "accountIds": [
        1,
        2,
        3
      ],
      "accountTypeIds": [
        1,
        2,
        3
      ],
      "accountSubTypeIds": [
        1,
        2,
        3
      ],
      "titleIds": [
        1,
        2,
        3
      ],
      "specialityIds": [
        1,
        2,
        3
      ],
      "countryIds": [
        30100001
      ],
      "stateIds": [
        1,
        2,
        3
      ],
      "cityIds": [
        1,
        2,
        3
      ],
      "pageNo": 1,
      "noOfEntries": 10000
    }
  }
}

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;
          audienceTypeId: number;
          createdAt: number;
          partnerName: string;
          partnerLogoUrl: string;
          uniques: number;
          dataCost: number;
          healthCareDataMappingIds: number[];
          filters: {
            ids: number[];
            dataProviderIds: number[];
            healthCareSystemIds: number[];
            accountIds: number[];
            accountTypeIds: number[];
            accountSubTypeIds: number[];
            titleIds: number[];
            specialityIds: number[];
            countryIds: number[];
            stateIds: number[];
            cityIds: number[];
            pageNo: number;
            noOfEntries: number;
          }
        }
      };
    };
  };
}

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

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

---

ABM audience statistics

GET

Get ABM audience statistics by ID.

Path parameters
audienceId integer	ABM audience ID.

Response properties

healthSystem integer	Healthcare system ID.
account integer	Healthcare account ID.
accountType integer	Healthcare account type ID.
npiReach integer	NPI reach.
speciality integer	Healthcare specialty ID.

JSON

Response 200

{
  "success": true,
  "data": {
    "healthSystem": 2,
    "account": 4,
    "accountType": 8,
    "npiReach": 25513,
    "speciality": 3
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          healthSystem: number;
          account: number;
          accountType: number;
          npiReach: number;
          speciality: number;
        }
      };
    };
  };
}

function getABMAudienceHealthCareStatisticsByAudienceId(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/audience/abm/{audienceId}/healthcare-data-statistics',
    params: {
      path: {
        audienceId: `number`
      }
    },
  }

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

---

Create ABM audience

POST

Create an ABM audience.

Request schema
audienceName string	Audience name.
healthCareDataMappingIds array of integers	Healthcare data mapping IDs to include from filters.
dataProviderId integer	Data provider ID.
audienceSubtypeId integer	Audience subtype ID used to refine audience columns (e.g., HCP under Healthcare vertical). +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
filters object	Filters.
filter object properties dataProviderIds array of integers Data provider IDs. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID accountIds array of integers Account IDs. accountTypeIds array of integers Healthcare account type IDs. accountSubTypeIds array of integers Healthcare account subtype IDs. countryIds array of integers Country IDs. stateIds array of integers State IDs. cityIds array of integers City IDs. titleIds array of integers Title IDs. specialityIds array of integers Specialty IDs. ids array of integers IDs. pageNo array of integers Page number of retrieved data. noOfEntries array of integers Number of entries returned per page. audienceSubtypeIds array of integers Audience subtype IDs to filter the records. +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient includeGenericAudience boolean When true, includes records with no audience subtype (subtype_id IS NULL) alongside any matched subtype IDs. Default: false.

Response properties

message string

Success message.

JSON

Request sample

{
  "audienceName": "HealthCare Innovators",
  "healthCareDataMappingIds": [
    1,
    2,
    3
  ],
  "dataProviderId": 1,
  "filters": {
    "dataProviderIds": [
      1
    ],
    "healthCareSystemIds": [
      40100004,
      40100007
    ],
    "accountIds": [
      40208104,
      40628423
    ],
    "accountTypeIds": [
      40300003
    ],
    "accountSubTypeIds": [
      40400001,
      40400010
    ],
    "countryIds": [
      30100001
    ],
    "stateIds": [
      30200028,
      30200043
    ],
    "cityIds": [
      30430356,
      30447825,
      30447952,
      30448122
    ],
    "titleIds": [
      40500099
    ],
    "specialityIds": [
      40500014,
      40500086
    ],
    "ids": [
      1,
      2,
      3
    ],
    "pageNo": 1,
    "noOfEntries": 2,
    "audienceSubtypeIds": [3],
    "includeGenericAudience": false
  },
  "audienceSubtypeId": 3
}

Response 200

{
  "success": true,
  "data": {
    "message": "HealthCare Innovators 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 saveAbmAudience(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/audience/abm',
    requestBody: {
      content: {
        "application/json": {
          audienceName?: `string`,
          healthCareDataMappingIds?: `number[]`,
          filters?: {
            searchBy?: `string[]`,
            ids?: `number[]`,
            dataProviderIds?: `number[]`,
            healthCareSystemIds?: `number[]`,
            accountIds?: `number[]`,
            accountTypeIds?: `number[]`,
            accountSubTypeIds?: `number[]`,
            titleIds?: `number[]`,
            specialityIds?: `number[]`,
            countryIds?: `number[]`,
            stateIds?: `number[]`,
            cityIds?: `number[]`,
            pagination?: `string`,
            pageNo?: `number`,
            noOfEntries?: `number`,
            sortBy?: `string`,
            searchField?: `string`,
            order?: `ASC` | `DESC`,
            offset?: `number`,
          },
          dataProviderId?: `number`,
        }
      }
    }
  },

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

---

Upload ABM filter file

POST

Extract ABM Healthcare data filters from an uploaded file. The file is uploaded as multipart/form-data in the abmFilterFile form data field, and filter column mappings and file type are sent as query parameters.

Request schema
fileType integer required	Type of the file being uploaded: CSV (1), Excel (2).
columns string required	Serialized JSON mapping of file column headers to filter field names.
abmFilterFile multipart/form-data required	File containing the ABM audience data to be filtered.
audienceSubtypeId integer	Optional audience subtype ID used to further refine audience columns (e.g., HCP under Healthcare vertical). +Supported values 1 Practitioner 2 D2C 3 HCP 4 NPI nurse 5 Non-NPI nurse 6 Patient
dataPartnerId integer	Optional data partner ID to further filter columns based on partner-specific configurations (e.g., Healthlink, RevOptimal). +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID

columns sample object

{
  "Title-name": "Title",
  "Account-type-name": "Account Type",
  "Account-Sub-Type-Name": "Account Sub-Type",
  "Health-System-Name": "Health System Name",
  "Account-Name": "Account Name",
  "Speciality-Name": "Speciality",
  "City-Name": "City",
  "State-Name": "State"
}

Response properties

healthCareFilterData object	Object containing matched filter IDs.
healthCareFilterData object properties healthcareSystemIds array of integers Set of healthcare system IDs. healthcareAccountIds array of integers Set of healthcare account IDs. accountTypeIds array of integers Set of account type IDs. accountSubTypeIds array of integers Set of account subtype IDs. titleIds array of integers Set of title IDs. specialityIds array of integers Set of specialty IDs. countryIds array of integers Set of country IDs. stateIds array of integers Set of state IDs. cityIds array of integers Set of city IDs.
matchingRate integer	Matching rate indicating the percentage of records that matched the filters.

Select exampleForm data samplecURL sample

POST /api/v3/audience/abm/healthcare-data/filter-file 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="fileType"

1
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="columns"

{"Title-name":"Title","Account-type-name":"Account Type","Account-Sub-Type-Name":"Account Sub-Type","Health-System-Name":"Health System Name","Account-Name":"Account Name","Speciality-Name":"Speciality","City-Name":"City","State-Name":"State"}
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="abmFilterFile"; filename="abm-data.csv"
Content-Type: text/csv

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

curl -X POST 'https://api.iqm.com/api/v3/audience/abm/healthcare-data/filter-file' \
  -H "Authorization: Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" \
  -H "X-IAA-OW-ID: 1" \
  -F 'abmFilterFile=@/path/to/abm-data.csv;type=text/csv' \
  -F 'fileType=1' \
  -F 'columns={"Title-name":"Title","Account-type-name":"Account Type","Account-Sub-Type-Name":"Account Sub-Type","Health-System-Name":"Health System Name","Account-Name":"Account Name","Speciality-Name":"Speciality","City-Name":"City","State-Name":"State"}'

Response 200

{
  "success": true,
  "data": {
    "healthCareFilterData": {
      "healthcareSystemIds": [
        1,
        2,
        3
      ],
      "healthcareAccountIds": [
        1,
        2,
        3
      ],
      "accountTypeIds": [
        1,
        2,
        3
      ],
      "accountSubTypeIds": [
        1,
        2,
        3
      ],
      "titleIds": [
        1,
        2,
        3
      ],
      "specialityIds": [
        1,
        2,
        3
      ],
      "stateIds": [
        1,
        2,
        3
      ],
      "cityIds": [
        1,
        2,
        3
      ]
    },
    "matchingRate": 95
  }
}

Error 422

{
  "success": false,
  "errorObjects": [
    {
      "error": "Invalid System column provided."
    }
  ]
}

ICT audiences

Get ICT audience details

GET

Get ICT audience details by ID.

Path parameter
audienceId integer	ICT audience ID.

Response properties

audienceId integer	Audience ID.
audienceName string	Audience name.
createdAt integer	Unix epoch timestamp of audience creation.
audienceSubtypeId integer	Audience subtype ID.
reach integer	Count of unique audiences reached.
dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
fileRowCount integer	Number of rows in uploaded file.
matchRate integer	Percentage of matched records.
cpm integer	Cost per thousand impressions.
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
s3FileName string	S3 file name.
s3Url string	S3 file URL.
extensionAudiences array of objects	List of extension audiences.
extensionAudiences object properties audienceId integer Extension audience ID. audienceName string Extension audience name. audienceStatusId integer Extension audience status ID. +Supported values 1 Processing 2 Pending 3 Ready 4 Rejected 5 Deleted 6 Failed 7 Fetching data 8 Data fetched
columnMappings array of objects	List of column mappings.
columnMappings object properties columnId integer Column ID. fileColumnName string Column name from uploaded file. dataFormatId integer Data format ID. +Supported values 1 Raw 2 Hashed (MD5) 3 Hashed (SHA1) 4 Hashed (SHA256) 5 Hashed (SHA512) 6 Hashed (other)
owId integer	Organization Workspace ID.
createdByUowId integer	User Organization Workspace ID of creator.

Response 200

{
  "success": true,
  "data": {
    "audienceId": 110110,
    "audienceName": "ictm-123",
    "createdAt": 1767803546490,
    "audienceSubtypeId": 3,
    "reach": 3,
    "dataPartnerId": 7,
    "fileRowCount": 5,
    "matchRate": 20,
    "cpm": 10,
    "audienceStatusId": 3,
    "s3FileName": "1767803546585_healthcare_ictm_audience_example.csv",
    "s3Url": "s3://ictm-aud-bucket/1767803546585_healthcare_ictm_audience_example.csv",
    "extensionAudiences": [
      {
        "audienceId": 110111,
        "audienceName": "ictm-123_Ext_Nurse",
        "audienceStatusId": 1
      },
      {
        "audienceId": 110112,
        "audienceName": "ictm-123_Ext_Non-NPI Nurse",
        "audienceStatusId": 3
      }
    ],
    "columnMappings": [
      {
        "columnId": 3,
        "fileColumnName": "phone",
        "dataFormatId": 1
      }
    ],
    "owId": 203615,
    "createdByUowId": 200180
  }
}

---

ICT audience subtypes and extensions

GET

Get list of ICT audience subtypes and their supported extension subtypes.

Query parameters
audienceTypeIds 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

Response properties

audienceSubTypes array of objects	List of audience subtypes.
audienceSubTypes object properties id integer Audience subtype ID. name string Audience subtype name. order integer Display order. displayName string Audience subtype display name. extensionAudiencesSubtypes array of objects List of supported extension audience subtypes. extensionAudiencesSubtypes object properties id integer Extension audience subtype ID. name string Extension audience subtype name. order integer Display order. displayName string Extension audience subtype display name.

Response 200

{
  "success": true,
  "data": {
    "audienceSubTypes": [
      {
        "id": 1,
        "name": "Healthcare",
        "order": 1,
        "displayName": "Healthcare",
        "extensionAudiencesSubtypes": [
          {
            "id": 10,
            "name": "Nurse Outreach",
            "order": 1,
            "displayName": "Nurse Outreach"
          }
        ]
      }
    ]
  }
}

---

Create ICT audience

POST

Create a new ICT audience.

Request schema
audienceRequest object	Audience request object.
audienceRequest object properties audienceName string Audience name. fileRowCount integer Number of rows in uploaded file. fileColumnCount integer Number of columns in uploaded file. columnMappings array of objects List of column mappings. columnMappings object properties columnId integer Column ID. fileColumnName string Column name from uploaded file. 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. audienceSubtypeId integer Audience subtype ID. extensionAudienceSubtypeIds array of integers Extension audience subtype ID.
file binary	Uploaded audience file.

Response properties

audienceId integer	Audience ID.
extensionAudienceIds array of integers	List of extension audience IDs.
message string	Status message.

Request body

{
  "audienceRequest": {
    "audienceName": "Sample xyz",
    "fileRowCount": 5,
    "fileColumnCount": 10,
    "columnMappings": [
      {
        "columnId": 18,
        "fileColumnName": "npi-id",
        "dataFormatId": null
      },
      {
        "columnId": 2,
        "fileColumnName": "email",
        "dataFormatId": 1
      },
      {
        "columnId": 3,
        "fileColumnName": "phone-sha256",
        "dataFormatId": 4
      }
    ],
    "dataPartnerId": 7,
    "columnCombinationId": 32,
    "audienceSubtypeId": 3,
    "extensionAudienceSubtypeIds": [
      4,
      5
    ]
  },
  "file": "BINARY FILE"
}

Response 200

{
  "success": true,
  "data": {
    "audienceId": 12345,
    "extensionAudienceIds": [
      12346,
      12347
    ],
    "message": "Sample xyz and 2 extended audiences created successfully"
  }
}

---

Get ICT audience count by data partner

POST

Get count of ICT audiences by data partner ID.

Request schema
audienceTypeIds 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
owIds array of integers	Organization Workspace IDs.
searchField string	Search filter string.

Response properties

dataPartnerId integer	Data partner ID. +Supported values 7 Healthlink ID 8 Data360 ID 10 IQVIA ID
audienceCount integer	Count of audiences for the data partner.

Request sample

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

Response 200

{
  "success": true,
  "data": [
    {
      "dataPartnerId": 1,
      "audienceCount": 111
    },
    {
      "dataPartnerId": 2,
      "audienceCount": 222
    }
  ]
}

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 audience

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);
}

---

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
      }
    ]
  }
}