Tools index

This page provides an index of the tools available within the IQM Model Context Protocol (MCP) ecosystem. Each tool allows your AI assistant to interact with different aspects of the platform, enabling you to perform tasks efficiently and effectively.

Tools are grouped below by API. Each entry includes the tool name, a brief description, and a link to the corresponding API documentation for more details on its functionality and usage.

Asset API

The Asset API streamlines the management and storage of media files. See the Asset tutorial or the Asset API guidelines for more information.

Asset details

Tool name	Description	Documentation
getAllAssets	Get a list of all assets in the workspace	Get a list of all assets
getAssetDetails	Get the details of an asset by ID	Get asset details

Assets management

Tool name	Description	Documentation
addAssets	Upload one or more new assets	Add multiple assets
updateAssetDetails	Update the details of an existing asset	Update asset details
deleteAsset	Soft-delete an asset by ID	Delete asset

Audience API

The Audience API allows you to create, manage, and target the many types of audiences available on the IQM platform. See the Audience tutorial or the Audience API guidelines for more information.

Audience management

Tool name	Description	Documentation
updateAudienceName	Update an audience's name	Update audience name
regenerateAudience	Regenerate a failed audience	Regenerate audience
deleteAudiences	Delete one or more audiences by ID	Delete audience
attachDataPartnerToAudience	Attach a data partner to an audience	Attach data partner
getAudienceInsights	Get a demographic and geographic insights profile for an audience	Get audience Insights
generateInsightsForMatchedAudience	Generate an Audience Insights report for one or more audiences	Create Audience Insights report

Audience lists and counts

Tool name	Description	Documentation
getAudienceList	Get a detailed list of audiences with insights details	Audience details list
getAudienceBasicList	Get a basic list of audiences	Basic audience details
getAudienceCountByStatus	Get audience counts grouped by status	Audience count by status
getAudienceCountByType	Get audience counts grouped by type	Audience count by type

Matched audiences

Tool name	Description	Documentation
createMatchedAudience_1	Create a matched audience for any vertical or subtype	Create Matched audience
updateMatchedAudience	Update the details of a matched audience	Update Matched audience
rematchMatchedAudience	Rematch or refresh a matched audience	Refresh Matched audience
getMatchedAudienceById	Get matched audience details by ID	Matched audience details
getAudienceFileUrl	Get a presigned download URL for an audience file
getDataFormats	Get the list of supported data formats for matched audiences	Data formats list for Matched audience
getAudienceDataPartners	Get matched audience data partners by vertical and subtype	Data partners list for Matched audience
getAudienceColumnWithDataFormats	Get matched audience columns by type, vertical, and subtype	Matched column list
getAudienceColumnCombinations	Get valid matched audience column combinations	Matched column combinations

Segmented audiences

Tool name	Description	Documentation
createSegmentedAudience	Create a new segmented audience	Create Segmented audience
updateSegmentedAudience	Update an existing segmented audience	Update Segmented audience
getSegmentedAudience	Get segmented audience details by ID	Segmented audience details
getSegmentsSearchList	Search the segments list	Search Segmented audiences
downloadSegmentsSearchList	Download the segments search list
getSegmentPartnerProviderList	Get the list of segment partner providers	Segment partner provider list
getSegmentsListByParentOrProvider	Get segments by parent or provider ID	Segment list by provider/partner IDs
getSegmentReachRange	Get the reach range list for segments	Reach range list for Segmented audiences
getSegmentPriceRange	Get the price range list for segments	Price range list for Segmented audiences

Retargeted audiences

Tool name	Description	Documentation
createRetargetedAudience	Create a new retargeted audience	Create Retargeted audience
updateRetargetedAudience	Update an existing retargeted audience	Update Retargeted audience
sendRetargetedPixelCodeEmail	Email a retargeted audience's pixel code to recipients	Retargeted audience email notification

Geofarmed audiences

Tool name	Description	Documentation
createGeoFarmedAudience	Create a new geofarmed audience	Create Geofarmed audience
getGeofarmedAudience	Get geofarmed audience details by ID	Geofarmed audience details

Contextual audiences

Tool name	Description	Documentation
createContextualAudiences	Create a new contextual audience	Create Contextual audience
getContextualAudienceDetails	Get contextual audience details by ID	Contextual audience details
validateProgrammaticUrls	Validate URLs for contextual audience targeting	Validate URL for Contextual audience

Lookalike audiences

Tool name	Description	Documentation
createLookalikeAudience	Create a new lookalike audience	Create Lookalike audience
getLookalikeAudienceById	Get lookalike audience details by ID	Get Lookalike audience details

Campaign audiences

Tool name	Description	Documentation
createCampaignAudience	Create a new campaign audience	Create Campaign audience
getCampaignAudience	Get campaign audience details by ID	Campaign audience details
getAttachedAudienceHistory	Get attached audience history for campaigns	Get Campaign audience history

Pre-bid audiences

Tool name	Description	Documentation
createPrebidAudience	Create a new pre-bid audience	Create Pre-bid audience
updatePrebidAudience	Update an existing pre-bid audience	Update Pre-bid audience
getPrebidAudienceDetails	Get pre-bid audience details by ID	Pre-bid audience details
getPrebidSegmentDetailsBySearch	Search pre-bid segment details by text or segment IDs	Search Pre-bid audience details
getProviderDetailsWithChildSegments	Get pre-bid providers and their immediate child segments	Get pre-bid provider child segment details
getPrebidChildSegmentDetailsByParentId	Get pre-bid child segment details by parent ID	Get pre-bid child segment details
getDvIvtFreePrebidSegments	Get pre-bid segments that are free of DV-IVT charges	DoubleVerify Pre-bid audience segment details

ABM and Healthcare audiences

Tool name	Description	Documentation
createAbmAudience	Create a new ABM audience	Create ABM audience
getAccountBasedAudienceDetailsByAudienceId	Get ABM audience details by ID	ABM audience details
getHealthcareDataFiltersFromFile	Extract ABM filters from an uploaded file	Upload ABM filter file
getHealthcareTitleList	Get the list of healthcare titles	Healthcare titles list
getHealthcareSpecialityList	Get the list of healthcare specialties	Healthcare specialties list
getHealthcareSystemList	Get the list of healthcare systems	Healthcare systems list
getHealthcareData	Get a list of healthcare data by filters	Healthcare data
getHealthcareDataStatistics	Get healthcare data statistics by filters	Healthcare statistics
getAccountTypeList	Get the list of healthcare account types	Healthcare account types
getAccountSubTypeList	Get the list of healthcare account subtypes	Healthcare account subtypes
getAccountNameList	Get the list of healthcare account names	Healthcare account names

ICT audiences

Tool name	Description	Documentation
createICTAudience	Create an ICT audience with optional extension audiences	Create ICT audience
getIctAudienceDetailsByAudienceId	Get ICT audience details by ID	Get ICT audience details
getAudienceSubTypesWithExtensionSubTypes	Get ICT audience subtypes with extension subtypes	ICT audience subtypes and extensions
getAudienceCountByDataPartner	Get ICT audience counts grouped by data partner	Get ICT audience count by data partner

Custom Voter Audiences (CVA)

Tool name	Description	Documentation
createCustomVoterAudience	Create a new Custom Voter Audience	Create Custom Voter Audience
getCustomVoterAudienceDetailsByAudienceId	Get Custom Voter Audience details by ID	Get Custom Voter Audience details
getSegmentDetails	Get segment details from the Custom Voter Audience segment catalogue	Get Custom Voter Audience segment details
getStates	Get the list of states available for Custom Voter Audiences	Get available states for Custom Voter Audiences

Static / reference data

Tool name	Description	Documentation
getAudienceTypes	Get the list of audience types	Audience type list
getAudienceSubtypes	Get the list of audience subtypes	Audience subtype list
getAudienceStatuses	Get the list of audience statuses	Audience status list
getFrequencyTypes	Get the list of active frequency types	Frequency type list
getAudienceProperties	Get platform configuration properties for audiences

Bid Model API

The Bid Model API allows you to fine-tune campaign delivery by prioritizing and adjusting spend across dimensions like Creative, Location, and Inventory. See the Bid Model tutorial or the Bid Model API guidelines for more information.

Bid Model details

Tool name	Description	Documentation
getBundleDetailsList_1	Get a list of bundles for a campaign and dimension, with entity and modeling status details	Get list of Bid Model Bundles
getModelledEntityData	Get modeled entity data for a dimension	Get modeled entities
getDimensionStatistics	Get dimension-wise counts of modeled items for a campaign	Get campaign dimension statistics
getDimensionWiseEntitySpentForCampaign_1	Get dimension-wise spend for a campaign	Get dimension specific spending for a campaign
getModelledItemsForCampaignAndDimensionId	Get modeled entities and modeling data for a campaign and dimension	Get list of modeled entities for a campaign

Include/exclude management

Tool name	Description	Documentation
toggleCampaignDimensionStatus	Include or exclude entities from a campaign	Include/exclude entities from a campaign

Bid Model management

Tool name	Description	Documentation
manageBidModelling	Manage bid modeling attributes for a campaign and dimension	Manage Bid Model settings
createBundle_1	Create a bundle for a campaign and dimension	Create Bid Model Bundle
updateBundleDetails_1	Update a bundle for a campaign and dimension	Update Bid Model Bundle
deleteBundle_1	Delete a bundle for a campaign and dimension	Delete Bid Model Bundle

Bid Model metrics and dimensions

Tool name	Description	Documentation
fetchCampaignMetricsByDimension	Get a metrics report for a campaign by dimension	Get metrics report for a given campaign and dimension
getDimensions	Get the list of bid model dimensions	Get list of Bid Model dimensions

Campaign API

The Campaign API allows you to create and manage campaigns, insertion orders, and their targeting settings. See the Campaign tutorial or the Campaign API guidelines for more information.

Insertion orders

Tool name	Description	Documentation
createCampaignIO	Create a new insertion order	Create an insertion order
editIODetails	Update an existing insertion order	Update insertion order details
getIOBasicDetailsList	List IOs with filters (status, budget type, owner)	Get insertion order details
getBasicIODetailsById	Fetch one IO by ID	Get insertion order details by ID
getIoMappedWithCampaignsDetails	List IOs with their attached campaigns	Get list of campaign details grouped by insertion order ID
duplicateIO	Clone an existing IO	Duplicate an insertion order
updateIOStatusToDelete	Soft-delete an IO	Delete an insertion order

Advanced campaigns

Tool name	Description	Documentation
saveCampaign	Create an advanced campaign in pending status	Create new campaign
saveDraftCampaign	Create an advanced campaign in draft status
editCampaignPatch	Update a campaign (auto-promotes draft to pending)	Update campaign
editDraftCampaign	Update a draft campaign
duplicateCampaign	Clone an existing campaign	Duplicate campaigns
updateCampaignStatus	Update a campaign's status	Update campaign status
updateCampaignBudget	Update budgets without touching other fields	Change campaign budget

PG campaigns

Tool name	Description	Documentation
addPGCampaign	Create a PG campaign	Create new PG campaign
addDraftPGCampaign	Create a PG campaign in draft status
editPGCampaign	Update a PG campaign	Update PG campaign
editDraftPGCampaign	Update a draft PG campaign

Campaign details

Tool name	Description	Documentation
getCampaign	Fetch full details of one campaign	Get campaign details by ID
getCampaignBasicDetailList	Paginated list with rich filters (type, status, IO, creative type)	Get basic details of campaigns
getCampaignListData	Get a list of campaigns	Get list of campaigns
getCampaignBudgetInfo	Get budget info and graph details for a campaign	Get campaign budget details
getCostDetails	Get cost details for a campaign	Get campaign cost details

Campaign targeting

Tool name	Description	Documentation
CampaignAudienceTargetingList	Bulk include/exclude/remove audiences across many campaigns (map-keyed by campaign ID)	Update audience targeting in campaigns
createCampaignCreativeTargeting	Bulk assign/unassign creatives to campaigns	Update creative targeting in campaigns
managePMPDealCampaignMappings	Bulk assign/de-assign PMP deals to campaigns	Assign PMP deals
managePgDealCampaignMappings	Bulk assign/de-assign PG deals to campaigns	Assign PG deals
includeExcludeInventoryGroup	Include or exclude campaigns from one or more inventory groups	Include/exclude campaigns from inventory groups

Conversion API

The Conversion API allows you to create and manage conversions, and assign them to campaigns to track performance. See the Conversion tutorial or the Conversion API guidelines for more information.

Conversion details

Tool name	Description	Documentation
getConversionDetailsById	Get conversion details by ID	Get conversion details by ID
getConversionList	Get a list of conversions	Get list of conversions
getConversionCountTypeWise	Get conversion counts grouped by type	Get conversion count by type
getAttachedCampaignsListByConversionId	Get campaigns attached to a conversion	Get campaign details by conversion ID
getAttachableCampaignListByConversionIds	Get campaigns that can be attached to one or more conversions	Get campaign details by conversion ID in group or basic

Conversions management

Tool name	Description	Documentation
addPostbackConversion	Create a postback conversion	Create Postback conversion
addPixelConversion	Create a pixel conversion	Create Pixel conversion
universal-pixel-conversion-add	Create a universal pixel conversion	Create a Universal Pixel conversion
deleteConversions	Delete one or more conversions	Delete conversion
updateConversion	Update a postback conversion	Update Postback conversion
updateConversion_1	Update a pixel conversion	Update Pixel conversion
universal-pixel-conversion-update	Update the name of a universal pixel conversion	Update a Universal Pixel conversion
assignConversionToCampaign	Assign a conversion to a campaign	Assign conversion to a campaign
sendEmailForPixelConversion	Email pixel integration instructions	Send email for Pixel integration
universal-pixel-send-email	Email universal pixel integration instructions	Send email for Universal Pixel integration

More conversion details

Tool name	Description	Documentation
getListOfConversionPartnerType	Get the list of postback partner types	Get list of partner types for Postback conversions
getConversionDefaultAdvancedSettingData	Get default advanced setting values for pixel conversions	Get list of Pixel conversion advanced setting default values
getListOfConversionTypes	Get the list of conversion types	Get list of conversion types
getListOfConversionStatus	Get the list of conversion statuses	Get list of conversion status
getListOfConversionPiggybackTypes	Get the list of conversion piggyback types	Get list of conversion piggyback types
getListOfConversionAttributionTypes	Get the list of conversion attribution types	Get list of conversion property types

Creative API

The Creative API allows you to upload and manage creatives and assign them to campaigns. See the Creative tutorial or the Creative API guidelines for more information.

Creative details

Tool name	Description	Documentation
getCreative	Get creative details by ID	Creative details by ID
getCreatives_1	Get a list of creatives and their details	Get list of creatives and details
getCreativeAndCampaignDetails	Get a creative and its associated campaigns	Get associated campaigns

Creative management

Tool name	Description	Documentation
createCreatives	Add a new creative	Add new creative
updateCreative	Update the details of an existing creative	Update creative details
updateCreativeStatus	Update a creative's status	Update creative status
createCampaignCreativeTargeting	Bulk assign or unassign creatives to campaigns	Update creative targeting in campaigns

Creative groups

Tool name	Description	Documentation
getCreativeGroupList	Get a list of creative groups	Get list of creative groups
createCreativeGroup	Create a new creative group	Create new creative group
modifyCreativesInGroups	Add or remove creatives from creative groups	Update creative groups
duplicateCreativeGroup	Duplicate a creative group by ID	Duplicate creative group
deleteCreativeGroups	Delete creative group(s) by ID	Delete creative group

Finance API

The Finance API allows you to manage Customer and Organization finances, including margins, invoices, payments, and credits. See the Finance API guidelines for more information.

Finance details

Tool name	Description	Documentation
getCustomerOverview	Get customer overview	Get Customer finance details
getBasicDetails	Get basic finance details	Get basic financial details
getAvailableBalance_1	Get available balance	Available balance
getCustomerMargin	Get customer margin details	Get Customer margin details
editCustomerMargin	Edit customer margin details	Update Customer margin details
getMarginSettings	Get margin settings for the workspace	Get Organization margin settings
updateMarginSettings	Update margin settings for the workspace	Update Organization margin settings
getCampaignMarginList	Get campaign-wise margin list	Campaign margin details
getPgFeesDetails	Get customer PG fees details	Get Customer PG fees details
editPgFeesDetails	Edit customer PG fees details	Edit Customer PG fees
getDvIvtFlag	Fetch DV-IVT free segments flag	Get Customer DoubleVerify details
updateDvIvtFlag	Update DV-IVT free segments flag	Update Customer DoubleVerify
addAdServingCost	Add ad serving cost	Add ad serving cost
getAdServingCost	Get ad serving cost	Get ad serving cost
addThirdPartyCost	Add or update third party cost	Add or update third party cost
getThirdPartyCost_1	Get third party cost	Get third party cost
disableThirdPartyCost	Disable third party cost	Disable third party cost
getInsightFees	Get insight fees details	Get Customer Insights fees details
updateInsightFees	Update insight fees details	Update Customer Insights fees details

Invoice management

Tool name	Description	Documentation
getInvoiceDetails_1	Get invoice for organization	Get invoice for Organization
getInvoicePaymentDetails	Get invoice payment details	Get invoice payment details
getInvoiceDetails	List invoices for customer or organization	Get list of invoices for Customer or Organization
updateInvoiceSettingsDetailsForOrganization	Save or update invoice settings	Update invoice settings
deleteTaxData	Delete invoice tax data	Delete invoice tax data
approveInvoice	Approve invoice	Approve invoice
cancelInvoice	Cancel invoice	Cancel invoice
payInvoice	Mark invoice as paid	Mark invoice as paid
emailInvoice_1	Email invoice	Email invoice
getInvoiceTemplateMarginDetails	Get invoice template margin details	Get invoice template margin details
getInvoiceTemplateMarginDetails_1	Get invoice template margin pre-requisite	Get invoice template margin pre-requisite

Static details

Tool name	Description	Documentation
getPaymentTypes	Payment types	Payment types
getPaymentStatuses	Payment status	Payment status
getPaymentModes	Invoice payment mode types	Invoice payment mode types
getInvoiceStatuses	Invoice status	Invoice status
getPaymentTerms	Invoice payment term	Invoice payment term
getPgPaymentTypes	PG payment types	PG payment type

Inventory API

The Inventory API allows you to browse Open Exchange, Contextual, Private Marketplace (PMP), and Programmatic Guaranteed (PG) inventory, and manage inventory groups and deals. See the Inventory tutorial or the Inventory API guidelines for more information.

PMP deals

Tool name	Description	Documentation
addPMPDeal	Create a new PMP deal	Create PMP deal
editPMPDeal	Edit an existing PMP deal	Update PMP deal
deletePMPDeal	Delete one or more PMP deals	Delete PMP deal
getPMPDealDetails	Get PMP deal details including assigned campaign IDs	Get PMP deal details by IDs
getPMPDealList	Get a paginated list of PMP deals	Get PMP deals list
getPMPDealsCountByStatus	Get count of PMP deals by status	Get count of PMP deals for all statuses
getPMPAndPGDeals	Get a list of PMP and PG deals for report filtering	List of deals
getGroupPMPDeals	Get PMP deals in an inventory group	Get list of PMP deals in an inventory group
generateGroupPMPDealsFile	Download a CSV of PMP deal details for a group	Get CSV list of PMP deals in an inventory group
fetchAssociatedCustomersForPMPDeal	Get customers associated with a PMP deal's campaigns	Get list of Customers associated with campaigns for a PMP deal
getDealStatuses	Get a list of deal statuses	Get list of deal statuses
getDealTypes	Get a list of deal types	Get list of deal types

PG deals

Tool name	Description	Documentation
addPGDeal	Create a new PG deal	Create PG deal
updatePGDeal	Update an existing PG deal	Update PG deal details
deletePGDeals	Delete multiple PG deals by their IDs	Delete PG deal
fetchPGDealList	Get a paginated list of PG deals	Get PG deals list
getPGDealById	Get PG deal details with associated campaign IDs	Get PG deals details by ID

Inventory groups

Tool name	Description	Documentation
addInventoryGroup	Create a new inventory group	Create a new inventory group
editInventoryGroup	Edit an existing inventory group	Edit inventory group
deleteInventoryGroup	Delete an inventory group	Delete inventory group
validateInventoryGroup	Validate an inventory group name	Validate inventory group
getInventoryGroups	Get a paginated list of inventory groups	Get list of inventory groups
getInventoryGroupsCount	Get the count of inventory groups	Get inventory groups count
getInventoryGroupsStatistics	Get aggregate statistics for inventory groups	Get list of inventory groups statistics
getInventoryGroupTypes	Get a list of inventory group types	Get inventory group types
addMappingsToInventoryGroups	Add inventories to one or more inventory groups	Add or remove mappings to an inventory group
removeMappingsOfInventoryGroup	Remove inventories from an inventory group
includeExcludeInventory	Include or exclude inventory for a campaign	Campaign inventory targeting

Open Exchange inventories

Tool name	Description	Documentation
getInventoriesDetails	Get open exchange inventory details with filtering	Get list of inventories
getInventoriesCountDetails	Get count of open exchange inventories	Get inventories count
getInventoriesDistributionDetails	Get distribution of inventories across dimensions	Get inventory distribution
getInventoriesByCSV	Get inventories based on an uploaded CSV file	Get inventory based on CSV file
getInventoriesCountByCSV	Get inventory counts based on an uploaded CSV file	Get inventory count based on CSV file
getInventoriesDistributionsByCSV	Get inventory distributions based on an uploaded CSV file	Get distribution of inventory based on CSV file
getGroupInventories	Get open exchange inventories in a group	Get list of Open Exchange inventories in an inventory group
getGroupInventoriesStatistics	Get statistics for inventories in a group	Get count of Open Exchange inventories in an inventory group
getGroupInventoriesDistributions	Get distribution breakdown of inventories in a group	Get distributions of Open Exchange inventories in an inventory group
downloadOpenExchangeInventoryDetails	Download open exchange inventory details	Download CSV inventory list
downloadOpenExchangeInventoryDetailsByGroupId	Download open exchange inventory details for a group	Download Open Exchange inventories for group

Contextual inventories

Tool name	Description	Documentation
addContextualInventories	Add contextual inventories with keywords and URLs	Add Contextual inventories
removeContextualInventories	Remove contextual inventories	Remove Contextual inventories
getContextualInventories	Get a paginated list of contextual inventories	Fetch Contextual inventories
addMappingsToInventoryGroups_1	Add contextual inventory mappings to one or more inventory groups	Add Contextual inventories to inventory groups
removeMappingsFromInventoryGroup	Remove contextual inventory mappings from an inventory group	Remove Contextual inventories from group
getContextualInventoriesForGroup	Get contextual inventories for a group	Get list of Contextual inventories for an inventory group
getContextualInventoriesForGroupCount	Get count of contextual inventories for a group	Get count of Contextual inventories for an inventory group
generateGroupContextualInventoriesFile	Download contextual inventories CSV for a group	Get CSV file of Contextual inventories for an inventory group
getRecommendedKeywords	Get recommended keywords for contextual targeting	Contextual inventory
getAutoSuggestKeywords	Get autosuggested keywords for contextual targeting

Blocked inventories

Tool name	Description	Documentation
addInventoriesToBlockedList	Add inventories to the blocked list	Block inventories
blockInventoriesToBlockedListViaFile	Block inventories via an uploaded file	Block inventory file
unblockInventoriesFromBlockedList	Remove inventories from the blocked list	Unblock inventories
getBlockedInventories	Get list of blocked open exchange inventories	Get list of blocked inventories
addCommentForInventoryBlocking	Add a comment for a blocked inventory	Add comment for blocked inventory

Reports API

The Reports API allows you to create, execute, and schedule reports on campaign performance data. See the Reports tutorial or the Reports API guidelines for more information.

Report details

Tool name	Description	Documentation
getReportList	Get a list of reports	Get a list of reports
fetchReportList	Get a list of reports with filters
getReport	Get report details by ID	Get report by ID

Reports management

Tool name	Description	Documentation
saveReport	Create a new report	Create report
executeReportData	Execute a report and fetch serving data	Execute a report
updateReport	Edit an existing report	Edit a report
deleteReport	Delete a report and its scheduling data	Delete a report

Scheduling management

Tool name	Description	Documentation
saveReportScheduleEvent	Schedule email delivery for a report	Schedule a report
updateReportScheduleEvent	Update a report's email schedule	Update a report schedule
deleteReportScheduleEvent	Remove a report's email schedule	Delete report schedule

More report details

Tool name	Description	Documentation
getDimensionAndMetricDetails	Get available dimensions and metrics for reports	Get dimensions and metrics details

User Management API

The User Management API allows you to log in and out, manage user profiles and application access, and validate user credentials. See the User management tutorial or the User Management API guidelines for more information.

Users

Tool name	Description	Documentation
getUserOWId	Get the logged in user's owId
getAccessibleOrganizations	Get organizations accessible to the current user
getUsersList	Get a paginated list of users	Get list of users
getUsersBasicList	Get a basic paginated list of users	Basic user list
sendUserInvitations	Send an invitation to a new user	Send user invitation
resendUserInvitations	Resend an invitation to a user	Resend user invitation
updateUserStatus	Update a user's active or inactive status	Update user status

Profile

Tool name	Description	Documentation
getProfile	Get the current user's profile details	Get user profile details
updateProfileDetails	Update the current user's profile information	Update user profile

App access

Tool name	Description	Documentation
getAllowedApplications	Get a list of applications the user is permitted to access	Allowed applications list
getUserApplicationsAccess	Get the user's application access list	User app access list
addApplicationAccessToUser	Add application access for a user	Add app access for user
revokeApplicationAccessToUser	Revoke application access for a user	Revoke app access for user
getRemainingApplications	Get the remaining applications available to assign to a user	Remaining applications

Password and MFA

Tool name	Description	Documentation
sendResetPasswordEmail	Send a password reset email	Reset password email
resetPassword	Reset a user's password	Reset user password
updateMfaFlag	Enable MFA for one or more users	Enable MFA
disableMfaForUsers	Disable MFA for one or more users	Disable MFA

Validation

Tool name	Description	Documentation
validateInvitation	Validate a user invitation link	Validate user invite
validateResetPasswordInvitation	Validate a password reset link	Validate password reset hash
validateUserEmail	Validate a user's email address	Validate user email
validateWorkspaceForUser	Validate a workspace domain for a user	Validate Workspace domain
validateCurrentPassword	Validate the current user's password	Validate user password

Workspace API

The Workspace API (backed by the same underlying User Management API service) allows you to manage Organizations, Customers, and Advertisers. See the Workspace tutorial or the Workspace API guidelines for more information.

Organization details

Tool name	Description	Documentation
getAllowedOrganizations	Get a list of allowed organizations	Get list of allowed Organizations
getOrganizationProfile	Get the organization's profile details	Get Organization details
getUserInteractionEvents	Get a list of user interaction events	Get list of user interaction events
upsertInteractionEvent	Update or insert a user interaction event	Upsert interaction event
isDomainAvailable	Check if a workspace domain is available	Check for available domain
getOrganizationsApplications_1	Get the list of applications available for organizations	Organization applications list

Organization management

Tool name	Description	Documentation
updateOrganizationProfile	Update the organization's profile	Update Organization profile
updateOrganizationEmail	Update the organization's email address	Update Organization email

Whitelabel settings

Tool name	Description	Documentation
getWhiteLabelSettings	Get the organization's whitelabel settings	Get whitelabel settings
updateWhiteLabelSettings	Update whitelabel settings for the organization	Update whitelabel settings
addWhiteLabelDomain	Add a whitelabel domain to the organization	Add whitelabel domain
verifyWhiteLabelDomain	Verify the organization's whitelabel domain	Verify whitelabel domain
addWhiteLabelPixelUrl	Add a whitelabel pixel URL for the organization	Add whitelabel pixel URL

Workspace management

Tool name	Description	Documentation
createWorkspace	Create a new workspace	Create a Workspace
getAdminUserList	Get a list of admin users	Get list of admin users
updateWorkspaceDomain	Update a workspace domain	Update Workspace domain
getWorkspaces	Get a list of workspaces	Get list of Workspaces
getWorkspaceInitDetails	Get workspace initialization details	Get Workspace initialization details
getWorkspaceOrganizationLogo	Get the organization logo for a workspace	Get Workspace Organization logo
getWorkspaceChatBotAppIdByOwId	Get the chatbot app ID for a workspace by organization workspace ID	Get Workspace chatbot app ID
getWorkspaceChatBotAppIdByWorkspaceDomain	Get the chatbot app ID for a workspace by domain	Get Workspace chatbot app ID by domain
sendFindMyWorkspaceEmail	Send a "Find My Workspace" email to a user	Send find my Workspace email

Customer details

Tool name	Description	Documentation
getCustomersList	Get a detailed list of customers	Get Customer details
getCustomerBasicDetails	Get a basic details list for customers	Get basic Customer details
getMultiLevelOrganizations	Get a multi-level list of customers	Get multi-level Customers list
getImmediateCustomers	Get a list of immediate customers	Get immediate Customers list
getCustomerOperationDetailsById	Get customer operations details by customer ID	Get Customer operations details
getCustomerOperationLabels	Get the list of labels for customer operations	Get Customer operations label list
getCustomerCount	Get the count of customers grouped by status	Get count of Customers by status
getCustomersUsers	Get the users assigned to a specific customer	Get list of users for selected Customer
getUserAssignedCustomers	Get the customers assigned to a user	Get list of user assigned Customers
getRemainingCustomersForUser	Get the remaining customers available for assignment to a user	Get user's remaining Customers
getAllowedCustomersOWIds	Get the list of allowed customer organization workspace IDs	Get allowed Customer OW IDs
getRemainingApplication	Get the remaining applications available to assign to a customer	Get list of remaining apps for Customer
getMetabaseExternalServiceClientCredentials	Get Metabase external service client credentials	Get Metabase client credentials
getAdvertisers	Get advertisers associated with a customer	Get list of Advertisers for Customer

Customer management

Tool name	Description	Documentation
getInvitePreRequisite	Get pre-requisite details required before sending a customer invitation	Invitation pre-requisite details
sendInvitations	Invite a customer to the platform	Invite Customer to platform
resendCustomerInvitation	Resend a customer invitation	Resend Customer invite
cancelCustomerInvitation	Cancel a pending customer invitation	Cancel Customer invite
assignCustomersToUser	Assign customers to a user	Assign Customer to user
removeCustomersAssociationFromUser	Remove a customer association from a user	Unassign Customer from user
approveCustomer	Approve a customer sign-up request	Approve Customer
rejectCustomer	Reject a customer sign-up request	Reject Customer
addApplicationAccessToCustomer	Add application access for a customer	Add Customer app access
revokeApplicationAccessToCustomer	Revoke application access for a customer	Revoke Customer app access
putCustomerOnHold	Suspend a customer account	Put Customer on-hold
reactivateCustomer	Reactivate a suspended customer account	Re-activate Customer
addLabelForCustomerOperation	Add a label to a customer operation	Add label for Customer operation
updateIsBidShadingEnabledFlag	Enable or disable bid shading for a customer	Enable bid shading for Customer
updateCustomerOperationDetailsByOwId	Update customer operations details	Update Customer operations details

Advertiser management

Tool name	Description	Documentation
getAdvertiserProfiles	Get a list of advertiser profiles and details	Get list of Advertiser profile and details
addAdvertiserProfile	Add a new advertiser profile	Add Advertiser profile
updateAdvertiserProfile	Edit an existing advertiser profile	Edit Advertiser profile
deleteAdvertiserProfile	Delete an advertiser profile	Delete Advertiser profile

Static details lists

Tool name	Description	Documentation
getOrganizationWorkspaceStatus	Get the list of organization-workspace status options	Organization Workspace status
getUserOrganizationWorkspaceStatus	Get the list of user status options	User status
getCustomerType	Get the list of customer type options	Customer type
getCustomerPaymentType	Get the list of customer payment type options	Customer payment type
getCustomerAccountType	Get the list of customer account type options	Customer account type
getCustomerListSortableFields	Get the list of sortable fields for customer lists	Customer list sortable fields
getUserSortBy	Get the list of sort-by options for users	User sort by options
getOrganizationExpertize	Get the list of organization expertise options	Organization expertise
getCompanySize	Get the list of company size options	Company size
getIndustries	Get the list of industry options	Industries
getMediaBudget	Get the list of media budget options	Media budget
getVerticals	Get the list of available verticals	Verticals

Insights API

The Insights API allows you to generate Audience and Campaign Bidding Insights, and manage Voter Level Data (VLD), Script Lift Study (SLS), Audience Quality (AQ), and Provider Level Data (PLD) Insights report templates and schedules. See the Insights tutorial or the Insights API guidelines for more information.

Insights report details

Tool name	Description	Documentation
getInsightsDetailList	Get a list of Insights reports	Get a list of Insights reports
getCampaignBiddingInsight	Get Campaign Bidding Insights data for a campaign	Get Campaign Bidding Insights
getInsightsTypeWiseCount	Get Insights report counts grouped by type	Get Insights reports count by type
getStatusWiseCampaignsForInsightsReports	Get a status-wise list of campaigns eligible for Insights reports	Get eligible campaigns
computeInsightsReports	Compute Insights reports for the given campaigns	Calculate Insights computation

Insights report management

Tool name	Description	Documentation
deleteInsights	Delete Insights report records by ID	Delete Insights report record
regenerateInsights	Regenerate a failed Insights report	Regenerate Insights report
sendInsightsEmail	Email an Insights report to recipients	Send Insights report email

Audience Insights report

Tool name	Description	Documentation
getInsightsCreateEligibleAudienceList	Get a list of audiences eligible for Audience Insights report generation	Get a list of eligible audiences
createInsightsDetails	Create an Audience Insights report for one or more audiences	Create Audience Insights report
downloadInsights	Download an Audience Insights report (PDF or XLSX)	Download Insights report

Power Segment Insights (PSI)

Tool name	Description	Documentation
generateReport	Generate a Power Segment Insights report	Generate PSI report
getPowerSegmentsDetailList	Get a list of Power Segment Insights reports	Get Power Segment Insights list
downloadReport	Download a Power Segment Insights report	Download PSI report
sendReportEmail	Email a Power Segment Insights report to recipients	Email PSI report
getPsiCategoryTypes	Get the list of Power Segment Insights category types	Get Power Segment Insights category types

Audience Quality (AQ) Insights reports

Tool name	Description	Documentation
getReportDetailList	Get a paginated list of AQ Insights reports	Get list of AQ Insights reports
getStatusWiseCampaignsForReports	Get a status-wise list of campaigns eligible for AQ Insights reports	Get list of campaigns eligible for AQ Insights reports
validateAQSReportName	Validate an AQ Insights report name	Validate AQ Insights report name
computeReports	Get cost and impression estimates for an AQ Insights report	Compute AQ Insights report cost
generateAQReports	Generate an AQ Insights report	Generate AQ Insights report
getAQSReportTypes	Get the list of available AQ Insights report types	Get AQ Insights report types
getAQSReportDownloadUrl	Download an AQ Insights report	Download AQ Insights report
deleteFailedReports	Delete a failed AQ Insights report	Delete AQ Insights report
email	Email an AQ Insights report to recipients

Voter Level Data (VLD) Insights reports

Tool name	Description	Documentation
getVLDReportList	Get a list of VLD Insights reports	Get list of VLD Insights reports
getStatusWiseCampaignsForVLDReports	Get a list of campaigns eligible for VLD Insights reports	Get list of campaigns eligible for VLD Insights reports
generateVLDReports	Generate a VLD Insights report	Generate VLD Insights report
getChargeableImpressionsDataForVLDReports	Get cost and impression estimates for a VLD Insights report	Get cost assessment for VLD Insights report
getVLDReportDownloadUrl	Download a VLD Insights report	Download VLD Insights report
deleteFailedVLDReport	Delete a failed VLD Insights report	Delete VLD Insights report
sendMailForVlDReport	Email a VLD Insights report to recipients

Script Lift Study (SLS) Insights reports

Tool name	Description	Documentation
getSLSReportList	Get a list of SLS Insights reports	Get list of SLS Insights reports
getStatusWiseCampaignsForSLSReports	Get a status-wise list of campaigns eligible for SLS Insights reports	Get list of campaigns eligible for SLS Insights reports
generateSLSReports	Generate an SLS Insights report	Generate SLS Insights report
getChargeableImpressionsDataForSLSReports	Get cost and impression estimates for an SLS Insights report	SLS Insights reports computation
validateSlsReportName	Validate an SLS Insights report name	Validate SLS Insights report name
getSLSReportDownloadUrl	Download an SLS Insights report	Download SLS Insights report
deleteFailedSLSReport	Delete a failed SLS Insights report	Delete SLS Insights report
sendMailForSlsReport	Email an SLS Insights report to recipients

Provider Level Data (PLD) Insights reports

Tool name	Description	Documentation
getPLDReportList	Get a list of PLD Insights reports
generatePLDReports	Generate a PLD Insights report
getChargeableImpressionsDataForPLDReports	Get cost and impression estimates for a PLD Insights report
fetchPLDReportSelectedColumns	Get the user-selected columns for PLD Insights reports
saveOrUpdatePLDReportSelectedColumns	Save or update the user-selected columns for PLD Insights reports
getReportInterval	Get the reporting interval for a PLD Insights report template

Report templates

Tool name	Description	Documentation
getTemplates	Get a list of report templates	Get list of templates
createTemplate	Create a report template	Create report template
updateTemplate	Update a report template	Update report template
validateTemplateName	Validate a report template name	Validate template name
getTemplateById	Get report template details by ID	Get template details
getReportsForTemplate	Get the reports generated for a template	Get template reports

Report management

Tool name	Description	Documentation
getReportDownloadUrl	Download an Insights report	Download report
deleteFailedReport	Delete a failed report	Delete report
sendMailForReport	Email an Insights report to recipients	Email report
regenerateReports	Regenerate a failed schedulable report	Regenerate report

Static / reference data

Tool name	Description	Documentation
getInsightsType	Get the list of Insights types	Get list of Insights types
getInsightsStatus	Get the list of Insights status types	Get list of Insights status types
getTemplateStatuses	Get the list of template status types	Get list of template status types
getFrequencyMetadata	Get delivery frequency metadata for scheduling templates	Get scheduling frequencies
getReportStatuses	Get the list of report statuses
getPropertiesOfReports	Get environment-wide default report properties

Dashboard API

The Dashboard API allows you to manage dashboards, generate campaign performance reports, and review Goal-AI optimization and CampaignPulse data. See the Dashboard API guidelines for more information.

Dashboard details

Tool name	Description	Documentation
getDashBoardList	Get a list of dashboards	Dashboard list
getGoalAIOptimizationReport	Get Goal-AI optimization graph data for a campaign	Get campaign AI-Based Optimization graph data
getGoalAIOptimizationActivities	Get Goal-AI optimization activities for a campaign	Get campaign AI-Based Optimization activity
getGoalAIOptimizationActivitiesDownload	Download Goal-AI optimization activities for a campaign

Dashboard management

Tool name	Description	Documentation
createDashboardAPI	Create a new dashboard	Create dashboard
updateDashboardAPI	Update an existing dashboard	Update dashboard
deleteDashboardAPI	Delete a dashboard	Delete dashboard

Dashboard reports

Tool name	Description	Documentation
v4-dashboard-get-report-by-workspace	Get a campaign performance report grouped by workspace	Workspace report
dashboard-report-by-workspace-download	Download a campaign performance report grouped by workspace
v4-dashboard-report-by-io	Get a campaign performance report grouped by insertion order	IO report
v4-dashboard-report-by-io-download	Download a campaign performance report grouped by insertion order
v4-dashboard-get-report-by-exchange	Get a campaign performance report grouped by exchange	Exchange report
v4-dashboard-download-report-by-exchange	Download a campaign performance report grouped by exchange
v4-dashboard-get-report-by-customer	Get a campaign performance report grouped by customer/advertiser	Customer report
dashboard-report-by-customer-download	Download a campaign performance report grouped by customer/advertiser
dashboard-report-by-campaign-v2	Get a campaign performance report grouped by campaign	Campaign report
dashboard-report-by-campaign-download	Download a campaign performance report grouped by campaign
dashboard-report-metrics-timeline	Get campaign performance metrics over time	Metrics timeline
dashboard-report-metrics-comparison	Compare aggregated campaign metrics between two periods	Metrics comparison

CampaignPulse

Tool name	Description	Documentation
campaignPulseDetails	Get CampaignPulse diagnosis results	Get CampaignPulse diagnosis results
campaignPulseSeverityDetails	Get CampaignPulse severity check counts	Get CampaignPulse severity counts
dashboard-campaign-pulse-categories	Get the list of CampaignPulse categories	Get CampaignPulse categories
dashboard-campaign-pulse-run-single	Run CampaignPulse now for a single campaign	Run CampaignPulse now
run-campaign-pulse-severity-check	Run a CampaignPulse severity check now	Run CampaignPulse severity check now

Master API

The Master API provides static and segment lookup data -- geographic, demographic, device, creative, and inventory reference lists -- used to populate targeting options across the platform. See the Master API guidelines for more information.

Geographic segments

Tool name	Description	Documentation
getMasterSegmentZipCode	Get ZIP codes with associated state IDs	Get ZIP codes and state IDs
getStatesSegmentDetails	Get the state segment list	Get state segment
getMasterSegmentState	Get the state segment list (legacy endpoint)
getCountySegmentDetails	Get the county segment list	Get county segment
getMasterSegmentCounty	Get the county segment list (legacy endpoint)
getCountrySegmentDetails	Get the country segment list	Get country segment
getMasterSegmentCountry	Get the country segment list (legacy endpoint)
getCitySegmentDetails	Get the city segment list	Get city segment
getMasterSegmentCity	Get the city segment list (legacy endpoint)
getMasterSegmentLocationTypes	Get available location type filters	Get location types
getMasterSegmentLocationTypeDetails	Get location details filtered by location type	Get location details by location type

Political and regional segments

Tool name	Description	Documentation
getSenateDistrictSegmentDetails	Get the senate district segment list	Get senate district segment
getMasterSegmentSenateDistrict	Get the senate district segment list (legacy endpoint)
getHouseDistrictSegmentDetails	Get the house district segment list	Get house district segment
getMasterSegmentHouseDistrict	Get the house district segment list (legacy endpoint)
getCongressionalDistrictSegmentDetails	Get the congressional district segment list	Get congressional district segment
getMasterSegmentCongressionalDistrict	Get the congressional district segment list (legacy endpoint)
getDistrictsByStates	Get districts filtered by state (legacy endpoint)
getDMACodeDetails	Get the DMA code segment list	Get DMA code segment
DMA-Codes	Get the DMA code list (legacy endpoint)
CarriersByCountry	Get carriers by country ID	Get carriers and states by country ID
StatesByCountry	Get states by country ID

Demographic segments

Tool name	Description	Documentation
getGenderSegmentDetails	Get the gender segment list	Get gender segment
getMasterSegmentGender	Get the gender segment list (legacy endpoint)
getMasterSegmentAge	Get the age segment list	Get age segment
getMasterSegmentLanguage	Get the language segment list	Get language segment
getMasterSegmentInterest	Get the interest segment list	Get interest segment
getMasterSegmentIncome	Get the income range segment list	Get income range segment
getMasterSegmentEthnicity	Get the ethnicity segment list	Get ethnicity segment
getMasterSegmentEthnicityGroup	Get the ethnicity group segment list	Get ethnicity group segment

Device and technology segments

Tool name	Description	Documentation
DeviceTypes	Get device types for targeting (legacy endpoint)
getMasterSegmentDeviceType	Get the device type segment list (legacy endpoint)
getDeviceSegmentType	Get the device type segment list	Get device type
NetworkTypes	Get network types for targeting	Get network types for targeting
Device-OS	Get device OS options for targeting	Get device OS for targeting
getMasterSegmentOS	Get the device OS segment list
Manufacturers	Get device manufacturers for targeting (legacy endpoint)
getMasterSegmentDeviceManufacture	Get the device manufacturer segment list	Get manufacturers for targeting
getMasterSegmentDeviceCarrier	Get the device carrier segment list
getMasterSegmentConnectionType	Get the connection type segment list

Creative and video targeting

Tool name	Description	Documentation
GetSegmentCreativeSizes	Get creative dimensions, player sizes, and durations (legacy endpoint)
getCreativeSizes	Get creative dimensions, player sizes, and durations	Get creative sizes
getCreativeRTBTypes	Get RTB creative types	Get RTB creative types
getVideoTargetingSkippability	Get video skippability parameter segments	Get video skip parameters
getVideoTargetingRollPosition	Get video roll-position parameter segments	Get video roll position parameters
getVideoTargetingPlayerSize	Get video player-size parameter segments	Get video player size parameters
getVideoTargetingPlaybackMethod	Get video playback-method parameter segments	Get video playback method parameters
getVideoTargetingPlacementTypes	Get video placement-type parameter segments	Get video placement type parameters

Inventory and campaign statics

Tool name	Description	Documentation
AdCategories	Get publisher ad categories (legacy endpoint)
getPublisherAdCategoriesDetails	Get the publisher ad category list	Get publisher ad categories
Timezones	Get timezones for targeting (legacy endpoint)
getTimezones	Get the timezone list	Get timezones
Traffic-Types-Source	Get source traffic types for targeting (legacy endpoint)
getTrafficTypes	Get traffic (channel) types for the inventory app	Get traffic types
GetInventoryTypes	Get inventory types (legacy endpoint)
getInventoryTypes	Get the inventory type list	Get inventory types
getInventoryDetails	Get the inventory list	Get inventory
getMasterSegmentChannel	Get the channel list for inventory	Get channels for inventory
getExchanges	Get the exchange list	Get exchanges
getDealCurationTypes	Get the deal curation type list	Get deal curation types

Planner API

The Planner API allows you to draft ad strategy proposals and plans, including Political and Healthcare Professional (HCP) Planner workflows, and generate insertion orders and campaigns from them. See the Planner API guidelines for more information.

Proposal details and summaries

Tool name	Description	Documentation
getProposalDetailsById	Get full details of a proposal by ID	Get proposal details by ID
proposalDetailList	Get a searchable, sortable list of proposals	Get list of proposals
getReachAndImpressions	Get maximum reach and impressions for a proposal's targeting	Proposal reach and impressions summary
getDeviceTypeData	Get impression distribution by device type for a proposal	Proposal device type summary
getChannelTypeData	Get impression distribution by channel type for a proposal	Proposal channel type summary
getBidLandscapeData	Get bid landscape data (CPM and impressions by percentile) for a proposal	Proposal bid landscape summary
generateS3LinkForDownloadProposal	Get a signed download link for a proposal report	Download proposal

Proposal management

Tool name	Description	Documentation
createProposal	Create a proposal in ready state	Create proposal
addDraftProposal	Create a proposal in draft state	Create draft proposal
editReadyProposal	Update a ready (or failed) proposal	Update proposal
updateDraftProposal	Update a draft proposal	Update draft proposal
generateIOCampaigns	Generate the insertion order and campaigns for a ready proposal	Generate campaigns for ready proposal
restoreReadyProposal	Restore an expired proposal with new flight dates	Restore proposal
createDuplicateProposal	Duplicate an existing proposal	Duplicate proposal
softDeleteProposal	Delete a proposal	Delete proposal

Proposal static lookups

Tool name	Description	Documentation
ProposalStatusList	Get the list of proposal statuses	Proposal status list
getSupportedParameters	Get supported parameters for the proposal summary	Proposal summary parameters list
getDefaultCustomerMargin	Get the logged-in user's access to parent organizations	Get user access details
getPlanCountByType	Get the count of plans grouped by plan type

Cross-screen Planner

Tool name	Description	Documentation
getCrossScreenGraph	Get the cross-screen reach saturation graph (venn and line, linear + CTV)	Get reach saturation graph
splitProposal	Split a cross-screen proposal's CTV campaigns by device or creative	Split proposal
getDemographicsKeyData	Get active demographics segment definitions for audience mapping	Get demographics keys

Political Planner details

Tool name	Description	Documentation
getPlanDetailsById	Get full details of a political plan by ID	Get plan details by ID
generateS3LinkForDownloadPoliticalPlan	Get a signed download link for a political plan report	Download plan
getPoliticalPlannerListing	Get a searchable, sortable list of political plans	Get list of Political plans
getPoliticalProposalListing	Get a searchable, sortable list of political proposals	Get list of proposals
getProposalDetailsById_1	Get full details of a political proposal by ID	Get proposal details
generateS3LinkForDownloadPoliticalProposal	Get a signed download link for a political proposal report	Download proposal
getProposalSummary	Get reach, bid landscape, device, and channel data for a proposal	Get proposal summary
getPoliticalStrategyListing	Get the list of strategies for a plan	Get list of strategies
getStrategyById	Get details of a single strategy by ID	Get strategy details

Political plan management

Tool name	Description	Documentation
createReadyPlan	Create a political plan in ready state	Create plan
createDraftPlan	Create a political plan in draft state
editPlan	Update an existing political plan	Edit plan
editDraftPlan	Update an existing political draft plan
editPlan_1	Rename an existing political plan	Edit plan name
deletePlansByIds	Delete political plans by ID (bulk)	Delete plans
estimatePlanReach	Estimate reach for a political plan	Estimate plan reach
generateCustomStrategies	Generate custom strategies for an existing plan	Generate custom strategies
deleteStrategyById	Delete a strategy by ID	Delete strategy

Political proposal management

Tool name	Description	Documentation
activateProposal	Activate a proposal and its proposed campaigns	Activate proposal
editProposal	Update a political proposal's details and campaigns	Edit proposal
editProposal_2	Rename an existing political proposal	Edit proposal name
generateIOCampaigns_1	Generate the insertion order and campaigns from a political proposal	Generate IO and campaigns
deleteProposalsByIds	Delete political proposals by ID (bulk)	Delete proposals
restoreProposals	Restore expired political proposals back to ready status	Restore proposals
createCvaDetails	Create Custom Voter Audience (CVA) details	Create CVA details
updateCvaDetails	Update Custom Voter Audience (CVA) details	Update CVA details

Political Planner static lookups

Tool name	Description	Documentation
getSupportedParams	Get supported parameters for political plan configuration	Get supported parameters
getTargetingTypes	Get available targeting types	Get targeting types
getStrategyTypes	Get available strategy types	Get strategy types
getSplitTypes	Get available split types	Get split types
getPlanStatuses	Get available plan status types	Get plan statuses
getPlanObjectiveTypes	Get available plan objective types	Get plan objectives

HCP Planner details

Tool name	Description	Documentation
getHcpPlanById	Get full details of an HCP plan by ID	HCP Planner details by ID
hcpPlannerListing	Get a searchable, sortable list of HCP planners	Get list of HCP Planners
accountsList	Get a searchable list of accounts	Get list of accounts
downloadPlan	Get a signed download link for an HCP plan	Download HCP Planner

HCP Planner management

Tool name	Description	Documentation
addDraftProposal_1	Create an HCP planner proposal in draft state	Create HCP Planner
createProposal_1	Create an HCP planner proposal in ready state
editProposal_1	Update an existing HCP planner proposal	Update HCP Planner
deleteProposals	Delete HCP planner proposals	Delete HCP Planner
validatePlannerName	Check whether an HCP planner name is available	Validate Planner name
getTargetingGraphs	Get targeting graphs for an HCP planner	Get targeting graphs
getAudienceGraph	Get the audience graph for an HCP planner	Get audience graph
getAudienceSummary	Get aggregated audience reach summary for an HCP planner	Get audience summary
generateHCPProposedCampaigns	Generate proposed campaigns split by strategy for an HCP plan	Generate campaigns plan
generateIOCampaigns_2	Publish draft campaigns for an HCP plan	Publish campaigns plan

NPI file and audience generation

Tool name	Description	Documentation
uploadNpiList	Upload an NPI list (CSV/XLSX) for HCP targeting
getGeneratedAudiences	Generate candidate audiences for an HCP planner
softDeleteNpiFile	Delete an uploaded NPI file

HCP Planner static lookups

Tool name	Description	Documentation
getSplitStrategiesForHcpPlanner	Get available split strategies	Get split strategy list
getNpiTypesList	Get available NPI types	NPI type list
getGeographySegments	Get available geography segments	Get geography segments
getDataPartnersForHcpPlanner	Get available data partners	Get data partners list
getAudienceSelectionMethods	Get available audience selection methods	Get audience selection methods list
specialitiesList	Get a searchable list of specialties	Get specialties list
accountTypesList	Get a searchable list of account types	Get account types