Skip to main content

MCP audience tutorial

Use IQM Model Context Protocol (MCP) to interact with the Audience API.

Overview​

This tutorial guides you through using IQM MCP to access and manage audiences with the Audience API. You'll learn how to upload a Matched audience and create a Segmented audience using the MCP interface.

The Audience MCP supports all audience operations as documented in the Audience API guidelines, so you can manage all types of audiences using the MCP.

Before you begin​

To create an audience using IQM MCP, the following are required:

  1. An account on the IQM platform
    • See Before you begin to create an account and request a Client ID and Client Secret
  2. A CSV or XLSX file for matching
info

File requirements for audience matching:

  • CSV or XLSX file for audience matching with maximum 1GB or 5M records
  • Without Voter ID / Email / Phone / Address in the file
    • One of the following system field combinations is required for matching
      • First Name, Last Name, ZIP, State
      • Last Name, Street Address, ZIP, State
      • Street Address, ZIP, state
    • Other fields are optional and can be added along with the above fields
  • With Voter ID / Email / Phone / Address in the file
    • Only one of these fields is required - Voter ID or Email or Phone, or Address. The preferred format for full address is Street, City, ZIP, and State
    • Other fields are optional and can be added along with one of the above fields

About IQM audiences​

The Audience API allows you to create different types of audiences for campaign targeting based on desired specifications. You can create new audiences, retrieve details about existing audiences, and update or delete audiences as needed.

The following table describes each type of audience:

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

More resources​

Upload a Matched audience​

You can use the MCP to upload a Matched audience by performing the following actions:

PromptResponse exampleNotes
Let's upload a Matched audienceMCP prompts the user to choose the type of audience and to upload the audience file.
Use this file and call it Matched1MCP confirms the file upload and assigns the specified name to the Matched audience. It also reads the file to extract the audience columns and creates the relevant column combinations.

Create a Segmented audience​

You can also use the MCP to create a Segmented audience by providing the segment details and the desired AND/OR relationship.

PromptResponse exampleNotes
Now let's create a Segmented audience. Use segment IDs 1045525 and 1045523 in an OR relationship
tip

Ask the MCP to explain the AND/OR relationship or check out our Help Center article for more information.

Update that Segmented audience with the name Segmented1

Get audience details​

You can ask the MCP to show you the details of any of your audiences by providing the audience name, ID, or by asking for a list of audiences.

PromptResponse exampleNotes
show me the details of audience Segmented1
Show me a list of all audiencesMCP shows a list of all audiences associated with the active Workspace, including their names and IDs.
Show me the audience count by type
What are the audience types? Please provide a brief explanation of what they areMCP shows the different types of audiences associated with the active Workspace, along with a brief explanation of each type.

Tools index​

In the tables below you can find the complete set of audience tools available in the MCP, categorized by audience type.

Each tool includes a brief description and a link to the corresponding API documentation for more details on its functionality and usage.

Use this index as a reference to explore the various audience management capabilities of the MCP and how they relate to the Audience API endpoints.

Audience management​

Tool nameDescriptionDocumentation
updateAudienceNameUpdate an audience's nameUpdate audience name
regenerateAudienceRegenerate a failed audienceRegenerate audience
deleteAudiencesDelete one or more audiences by IDDelete audience
attachDataPartnerToAudienceAttach a data partner to an audienceAttach data partner
getAudienceInsightsGet a demographic and geographic insights profile for an audienceGet audience Insights
generateInsightsForMatchedAudienceGenerate an Audience Insights report for one or more audiencesCreate Audience Insights report

Audience lists and counts​

Tool nameDescriptionDocumentation
getAudienceListGet a detailed list of audiences with insights detailsAudience details list
getAudienceBasicListGet a basic list of audiencesBasic audience details
getAudienceCountByStatusGet audience counts grouped by statusAudience count by status
getAudienceCountByTypeGet audience counts grouped by typeAudience count by type

Matched audiences​

Tool nameDescriptionDocumentation
createMatchedAudience_1Create a matched audience for any vertical or subtypeCreate Matched audience
updateMatchedAudienceUpdate the details of a matched audienceUpdate Matched audience
rematchMatchedAudienceRematch or refresh a matched audienceRefresh Matched audience
getMatchedAudienceByIdGet matched audience details by IDMatched audience details
getAudienceFileUrlGet a presigned download URL for an audience file
getDataFormatsGet the list of supported data formats for matched audiencesData formats list for Matched audience
getAudienceDataPartnersGet matched audience data partners by vertical and subtypeData partners list for Matched audience
getAudienceColumnWithDataFormatsGet matched audience columns by type, vertical, and subtypeMatched column list
getAudienceColumnCombinationsGet valid matched audience column combinationsMatched column combinations

Segmented audiences​

Tool nameDescriptionDocumentation
createSegmentedAudienceCreate a new segmented audienceCreate Segmented audience
updateSegmentedAudienceUpdate an existing segmented audienceUpdate Segmented audience
getSegmentedAudienceGet segmented audience details by IDSegmented audience details
getSegmentsSearchListSearch the segments listSearch Segmented audiences
downloadSegmentsSearchListDownload the segments search list
getSegmentPartnerProviderListGet the list of segment partner providersSegment partner provider list
getSegmentsListByParentOrProviderGet segments by parent or provider IDSegment list by provider/partner IDs
getSegmentReachRangeGet the reach range list for segmentsReach range list for Segmented audiences
getSegmentPriceRangeGet the price range list for segmentsPrice range list for Segmented audiences

Retargeted audiences​

Tool nameDescriptionDocumentation
createRetargetedAudienceCreate a new retargeted audienceCreate Retargeted audience
updateRetargetedAudienceUpdate an existing retargeted audienceUpdate Retargeted audience
sendRetargetedPixelCodeEmailEmail a retargeted audience's pixel code to recipientsRetargeted audience email notification

Geofarmed audiences​

Tool nameDescriptionDocumentation
createGeoFarmedAudienceCreate a new geofarmed audienceCreate Geofarmed audience
getGeofarmedAudienceGet geofarmed audience details by IDGeofarmed audience details

Contextual audiences​

Tool nameDescriptionDocumentation
createContextualAudiencesCreate a new contextual audienceCreate Contextual audience
getContextualAudienceDetailsGet contextual audience details by IDContextual audience details
validateProgrammaticUrlsValidate URLs for contextual audience targetingValidate URL for Contextual audience

Lookalike audiences​

Tool nameDescriptionDocumentation
createLookalikeAudienceCreate a new lookalike audienceCreate Lookalike audience
getLookalikeAudienceByIdGet lookalike audience details by IDGet Lookalike audience details

Campaign audiences​

Tool nameDescriptionDocumentation
createCampaignAudienceCreate a new campaign audienceCreate Campaign audience
getCampaignAudienceGet campaign audience details by IDCampaign audience details
getAttachedAudienceHistoryGet attached audience history for campaignsGet Campaign audience history

Pre-bid audiences​

Tool nameDescriptionDocumentation
createPrebidAudienceCreate a new pre-bid audienceCreate Pre-bid audience
updatePrebidAudienceUpdate an existing pre-bid audienceUpdate Pre-bid audience
getPrebidAudienceDetailsGet pre-bid audience details by IDPre-bid audience details
getPrebidSegmentDetailsBySearchSearch pre-bid segment details by text or segment IDsSearch Pre-bid audience details
getProviderDetailsWithChildSegmentsGet pre-bid providers and their immediate child segmentsGet pre-bid provider child segment details
getPrebidChildSegmentDetailsByParentIdGet pre-bid child segment details by parent IDGet pre-bid child segment details
getDvIvtFreePrebidSegmentsGet pre-bid segments that are free of DV-IVT chargesDoubleVerify Pre-bid audience segment details

ABM and Healthcare audiences​

Tool nameDescriptionDocumentation
createAbmAudienceCreate a new ABM audienceCreate ABM audience
getAccountBasedAudienceDetailsByAudienceIdGet ABM audience details by IDABM audience details
getHealthcareDataFiltersFromFileExtract ABM filters from an uploaded fileUpload ABM filter file
getHealthcareTitleListGet the list of healthcare titlesHealthcare titles list
getHealthcareSpecialityListGet the list of healthcare specialtiesHealthcare specialties list
getHealthcareSystemListGet the list of healthcare systemsHealthcare systems list
getHealthcareDataGet a list of healthcare data by filtersHealthcare data
getHealthcareDataStatisticsGet healthcare data statistics by filtersHealthcare statistics
getAccountTypeListGet the list of healthcare account typesHealthcare account types
getAccountSubTypeListGet the list of healthcare account subtypesHealthcare account subtypes
getAccountNameListGet the list of healthcare account namesHealthcare account names

ICT audiences​

Tool nameDescriptionDocumentation
createICTAudienceCreate an ICT audience with optional extension audiencesCreate ICT audience
getIctAudienceDetailsByAudienceIdGet ICT audience details by IDGet ICT audience details
getAudienceSubTypesWithExtensionSubTypesGet ICT audience subtypes with extension subtypesICT audience subtypes and extensions
getAudienceCountByDataPartnerGet ICT audience counts grouped by data partnerGet ICT audience count by data partner

Custom Voter Audiences (CVA)​

Tool nameDescriptionDocumentation
createCustomVoterAudienceCreate a new Custom Voter AudienceCreate Custom Voter Audience
getCustomVoterAudienceDetailsByAudienceIdGet Custom Voter Audience details by IDGet Custom Voter Audience details
getSegmentDetailsGet segment details from the Custom Voter Audience segment catalogueGet Custom Voter Audience segment details
getStatesGet the list of states available for Custom Voter AudiencesGet available states for Custom Voter Audiences

Static / reference data​

Tool nameDescriptionDocumentation
getAudienceTypesGet the list of audience typesAudience type list
getAudienceSubtypesGet the list of audience subtypesAudience subtype list
getAudienceStatusesGet the list of audience statusesAudience status list
getFrequencyTypesGet the list of active frequency typesFrequency type list
getAudiencePropertiesGet platform configuration properties for audiences
Have a question?
Was this page helpful?