PilotMCP
Platforms and tools

Pinterest Ads

The 91 tools Pilot MCP serves for Pinterest Ads: 60 read-only, and 31 that write with the €29 plan, taken from the server.

Pilot MCP serves 60 read-only tools for Pinterest Ads, on every plan. With the €29 plan, it also serves 24 that create or change and 7 that delete. Their names start with pinterest_.

What each entry shows

The name, description and parameters come from the list the server serves to your assistant (tools/list). Descriptions are in English: this is the text your assistant receives. Your assistant never fills in platform credentials: Pilot adds them on each call.

Writing and deleting

Write tools are only served with the €29 plan: your assistant creates, changes, pauses and deletes there, with no access level to pick when you connect. On the free plan, it does not see them. A change that sets an object to deleted or archived counts as a deletion, and a deletion targets one object at a time. Changes apply directly on the ad platform: Pilot reads the object from the platform before and after the write, and logs it in your workspace. See Read and write.

Tool families

Other tools

pinterest_ad_accounts_analytics

Pinterest Ads: Ad Accounts Analytics · read-only · idempotent

Get analytics metrics for an ad account over a date range. Returns spend, impressions, clicks, CTR, CPC, CPM, conversions and more. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.
start_datestringyesStart date in YYYY-MM-DD format.
end_datestringyesEnd date in YYYY-MM-DD format.
columnsstring[]yesMetrics to return. Example: ["SPEND_IN_DOLLAR","IMPRESSION_1","CLICK_1","CTR","CPC_IN_MICRO_DOLLAR"].
granularitystringnoAggregation granularity (default: TOTAL). Values: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".
click_window_daysintegernoAttribution click window (1,7,14,30,60).
engagement_window_daysintegernoAttribution engagement window.
view_window_daysintegernoAttribution view-through window.
conversion_report_timestringnoValues: "TIME_OF_AD_ACTION", "TIME_OF_CONVERSION".

pinterest_ad_accounts_get

Pinterest Ads: Ad Accounts Get · read-only · idempotent

Get details for a specific ad account by its ID. DEPENDENCY: access_token + ad_account_id (from ad_accounts_list).

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.

pinterest_ad_accounts_get_report

Pinterest Ads: Ad Accounts Get Report · read-only · idempotent

Poll an async report previously requested via ad_accounts_create_report. DEPENDENCY: access_token + ad_account_id + token from ad_accounts_create_report.

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.
tokenstringyesReport request token from ad_accounts_create_report.

pinterest_ad_accounts_get_templates

Pinterest Ads: Ad Accounts Get Templates · read-only · idempotent

List saved report templates for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.
page_sizeintegerno
orderstringnoValues: "ASCENDING", "DESCENDING".
bookmarkstringnoPagination cursor.

pinterest_ad_accounts_list

Pinterest Ads: Ad Accounts List · read-only · idempotent

List all ad accounts accessible by the authenticated user. Includes accounts they own and shared accounts. DEPENDENCY: access_token. Call this first to obtain ad_account_id values.

ParameterTypeRequiredDescription
include_shared_accountsbooleannoInclude ad accounts shared with the user (default: true).
bookmarkstringnoPagination cursor from previous response.
page_sizeintegernoNumber of results per page (max 250).
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

pinterest_ad_accounts_targeting_analytics

Pinterest Ads: Ad Accounts Targeting Analytics · read-only · idempotent

Get targeting analytics (by age, gender, interest, etc.) for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
targeting_typesstring[]yese.g. ["GENDER","AGE_BUCKET","GEO","INTEREST","KEYWORD","AUDIENCE"].
columnsstring[]yesMetrics to return.
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".

pinterest_ad_accounts_terms_of_service

Pinterest Ads: Ad Accounts Terms of Service · read-only · idempotent

Get terms of service for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.
include_htmlbooleannoInclude HTML content.
tos_typestringnoTerms type filter.

pinterest_ad_groups_analytics

Pinterest Ads: Ad Groups Analytics · read-only · idempotent

Get performance analytics for ad groups. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
ad_group_idsstring[]no
columnsstring[]yes
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".
click_window_daysintegerno
engagement_window_daysintegerno
view_window_daysintegerno
conversion_report_timestringnoValues: "TIME_OF_AD_ACTION", "TIME_OF_CONVERSION".

pinterest_ad_groups_audience_sizing

Pinterest Ads: Ad Groups Audience Sizing · read-only · idempotent

Estimate the audience size for a targeting spec before creating an ad group. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
targeting_specobjectnoTargeting options to estimate audience for.
placement_groupstringnoValues: "ALL", "SEARCH", "BROWSE", "OTHER".

pinterest_ad_groups_bid_floor

Pinterest Ads: Ad Groups Bid Floor · read-only · idempotent

Get the minimum bid floor for an ad group configuration. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
bid_floor_specsobject[]noArray of bid floor spec objects.

pinterest_ad_groups_get

Pinterest Ads: Ad Groups Get · read-only · idempotent

Get a single ad group by ID. DEPENDENCY: access_token + ad_account_id + ad_group_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
ad_group_idstringyesAd group unique identifier.
translate_interests_to_namesbooleanno

pinterest_ad_groups_list

Pinterest Ads: Ad Groups List · read-only · idempotent

List ad groups for an ad account. Optionally filter by campaign or status. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaign_idsstring[]noFilter by campaign IDs.
ad_group_idsstring[]noFilter by specific ad group IDs.
entity_statusesstring[]noValues: "ACTIVE", "PAUSED", "ARCHIVED".
page_sizeintegerno
orderstringnoValues: "ASCENDING", "DESCENDING".
bookmarkstringno
translate_interests_to_namesbooleannoReturn human-readable interest names.

pinterest_ad_groups_targeting_analytics

Pinterest Ads: Ad Groups Targeting Analytics · read-only · idempotent

Get targeting breakdown analytics for ad groups. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
ad_group_idsstring[]no
targeting_typesstring[]yes
columnsstring[]yes
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".

pinterest_ads_analytics

Pinterest Ads: Ads Analytics · read-only · idempotent

Get performance analytics for individual ads. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
ad_idsstring[]no
columnsstring[]yes
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".
click_window_daysintegerno
engagement_window_daysintegerno
view_window_daysintegerno
conversion_report_timestringnoValues: "TIME_OF_AD_ACTION", "TIME_OF_CONVERSION".

pinterest_ads_get

Pinterest Ads: Ads Get · read-only · idempotent

Get a single ad by ID. DEPENDENCY: access_token + ad_account_id + ad_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
ad_idstringyesAd unique identifier.

pinterest_ads_list

Pinterest Ads: Ads List · read-only · idempotent

List ads for an ad account. Optionally filter by campaign, ad group, or status. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaign_idsstring[]no
ad_group_idsstring[]no
ad_idsstring[]no
entity_statusesstring[]noValues: "ACTIVE", "PAUSED", "ARCHIVED".
page_sizeintegerno
orderstringnoValues: "ASCENDING", "DESCENDING".
bookmarkstringno

pinterest_ads_preview

Pinterest Ads: Ads Preview · read-only · idempotent

Generate a preview URL for an ad creative before publishing. Returns a URL to view the ad in Pinterest preview mode. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
creative_typestringyesValues: "REGULAR", "VIDEO", "SHOPPING", "CAROUSEL", "MAX_VIDEO", "SHOP_THE_PIN", "COLLECTION", "IDEA".
pin_idstringnoExisting pin to use as creative.
image_urlstringnoImage URL for the creative.
titlestringno
descriptionstringno

pinterest_ads_targeting_analytics

Pinterest Ads: Ads Targeting Analytics · read-only · idempotent

Get targeting breakdown analytics for individual ads. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
ad_idsstring[]no
targeting_typesstring[]yes
columnsstring[]yes
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".

pinterest_audience_insights_audiences

Pinterest Ads: Audience Insights Audiences · read-only · idempotent

List audiences eligible for insights in an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
page_sizeintegerno
bookmarkstringno
orderstringnoValues: "ASCENDING", "DESCENDING".
entitiesstringnoValues: "AUDIENCE", "AUDIENCE_LIST".

pinterest_audience_insights_get

Pinterest Ads: Audience Insights Get · read-only · idempotent

Get audience insights for an ad account (reach, demographics, interests breakdown). DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
audience_insight_typestringyesValues: "YOUR_TOTAL_AUDIENCE", "YOUR_ENGAGED_AUDIENCE", "PINTEREST_TOTAL_AUDIENCE".

pinterest_audiences_get

Pinterest Ads: Audiences Get · read-only · idempotent

Get a single audience by ID. DEPENDENCY: access_token + ad_account_id + audience_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
audience_idstringyesAudience unique identifier.

pinterest_audiences_list

Pinterest Ads: Audiences List · read-only · idempotent

List audiences for an ad account (custom audiences, actalike, etc.). DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
bookmarkstringno
orderstringnoValues: "ASCENDING", "DESCENDING".
page_sizeintegerno
ownership_typestringnoFilter by ownership. Values: "OWNED", "SHARED".

pinterest_bulk_download

Pinterest Ads: Bulk Download · read-only · creates an object on each call

Request a bulk download of campaigns, ad groups, ads, keywords, etc. Returns a bulk_request_id for polling. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
entity_typesstring[]yesEntity types to download. Values: "CAMPAIGN", "AD_GROUP", "PRODUCT_GROUP", "AD", "KEYWORD", "TARGETING_TEMPLATE", "PRODUCT_GROUP_PROMOTION".
entity_idsstring[]no
updated_sincestringnoUnix timestamp - only return items updated after this time.
start_timestringnoUnix timestamp for date range start.
end_timestringnoUnix timestamp for date range end.
status_filterstringnoValues: "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "DELETED_DRAFT".
output_formatstringnoValues: "JSON", "CSV".

pinterest_bulk_get_request

Pinterest Ads: Bulk Get Request · read-only · idempotent

Poll the status and download URL of a bulk request. DEPENDENCY: access_token + ad_account_id + bulk_request_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
bulk_request_idstringyesBulk request ID from bulk_download.
include_detailsbooleanno

pinterest_campaigns_analytics

Pinterest Ads: Campaigns Analytics · read-only · idempotent

Get analytics metrics for campaigns (spend, impressions, clicks, etc.). DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
campaign_idsstring[]noFilter by specific campaign IDs.
columnsstring[]yesMetrics columns e.g. ["SPEND_IN_DOLLAR","IMPRESSION_1","CLICK_1","CTR","CPC_IN_MICRO_DOLLAR"].
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".
click_window_daysintegerno
engagement_window_daysintegerno
view_window_daysintegerno
conversion_report_timestringnoValues: "TIME_OF_AD_ACTION", "TIME_OF_CONVERSION".

pinterest_campaigns_get

Pinterest Ads: Campaigns Get · read-only · idempotent

Get a single campaign by ID. DEPENDENCY: access_token + ad_account_id + campaign_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaign_idstringyesCampaign unique identifier.

pinterest_campaigns_list

Pinterest Ads: Campaigns List · read-only · idempotent

List campaigns for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaign_idsstring[]noFilter by specific campaign IDs (max 100).
entity_statusesstring[]noFilter by status. Values: "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "DELETED_DRAFT".
page_sizeintegerno
orderstringnoValues: "ASCENDING", "DESCENDING".
bookmarkstringnoPagination cursor.

pinterest_campaigns_pin_analytics

Pinterest Ads: Campaigns Pin Analytics · read-only · idempotent

Get pin-level analytics across campaigns for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
columnsstring[]yes
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".

pinterest_campaigns_targeting_analytics

Pinterest Ads: Campaigns Targeting Analytics · read-only · idempotent

Get targeting breakdown analytics for campaigns. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
campaign_idsstring[]no
targeting_typesstring[]yese.g. ["GENDER","AGE_BUCKET","GEO","INTEREST","KEYWORD","AUDIENCE"].
columnsstring[]yes
granularitystringnoValues: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".

pinterest_catalog_feeds_get

Pinterest Ads: Catalog Feeds Get · read-only · idempotent

Get details of a specific catalog feed. DEPENDENCY: access_token + feed_id (from catalog_feeds_list).

ParameterTypeRequiredDescription
feed_idstringyesFeed unique identifier.
ad_account_idstringno

pinterest_catalog_feeds_list

Pinterest Ads: Catalog Feeds List · read-only · idempotent

List all feeds for a catalog. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
catalog_idstringnoFilter by catalog ID.
ad_account_idstringno
bookmarkstringno
page_sizeintegerno

pinterest_catalog_feeds_processing_results

Pinterest Ads: Catalog Feeds Processing Results · read-only · idempotent

Get the processing results for a catalog feed (status, item counts, errors). DEPENDENCY: access_token + feed_id.

ParameterTypeRequiredDescription
feed_idstringyesFeed unique identifier.
ad_account_idstringno
bookmarkstringno
page_sizeintegerno

pinterest_catalog_items_batch_get

Pinterest Ads: Catalog Items Batch Get · read-only · idempotent

Poll the status of a catalog items batch operation. DEPENDENCY: access_token + batch_id (from catalog_items_batch_upsert).

ParameterTypeRequiredDescription
batch_idstringyesBatch operation ID.
ad_account_idstringno

pinterest_catalog_items_get

Pinterest Ads: Catalog Items Get · read-only · idempotent

Get catalog items by item IDs. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
countrystringyesISO 3166-1 alpha-2 country code.
languagestringyesISO 639-1 language code.
item_idsstring[]yesProduct item IDs.
ad_account_idstringno
catalog_idstringno

pinterest_catalog_product_groups_get

Pinterest Ads: Catalog Product Groups Get · read-only · idempotent

Get a specific product group by ID. DEPENDENCY: access_token + product_group_id.

ParameterTypeRequiredDescription
product_group_idstringyesProduct group unique identifier.
ad_account_idstringno

pinterest_catalog_product_groups_list

Pinterest Ads: Catalog Product Groups List · read-only · idempotent

List product groups for a catalog or feed. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
feed_idstringnoFilter by feed ID.
catalog_idstringnoFilter by catalog ID.
bookmarkstringno
page_sizeintegerno
ad_account_idstringno

pinterest_catalog_product_groups_product_counts

Pinterest Ads: Catalog Product Groups Product Counts · read-only · idempotent

Get the product count for a product group. DEPENDENCY: access_token + product_group_id.

ParameterTypeRequiredDescription
product_group_idstringyesProduct group unique identifier.
ad_account_idstringno

pinterest_catalogs_available_filter_values

Pinterest Ads: Catalogs Available Filter Values · read-only · idempotent

Get available values for catalog feed filter attributes. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
filter_typestringyesFilter attribute type (e.g. "gender").
ad_account_idstringno

pinterest_catalogs_list

Pinterest Ads: Catalogs List · read-only · idempotent

List all catalogs accessible by the authenticated user. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
bookmarkstringno
page_sizeintegerno
ad_account_idstringnoFilter by ad account.

pinterest_conversion_tags_get

Pinterest Ads: Conversion Tags Get · read-only · idempotent

Get a specific conversion tag by ID. DEPENDENCY: access_token + ad_account_id + conversion_tag_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
conversion_tag_idstringyesConversion tag unique identifier.

pinterest_conversion_tags_list

Pinterest Ads: Conversion Tags List · read-only · idempotent

List all conversion tags for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
filter_deletedbooleannoExclude deleted tags.

pinterest_customer_lists_get

Pinterest Ads: Customer Lists Get · read-only · idempotent

Get a specific customer list by ID. DEPENDENCY: access_token + ad_account_id + customer_list_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
customer_list_idstringyesCustomer list unique identifier.

pinterest_customer_lists_list

Pinterest Ads: Customer Lists List · read-only · idempotent

List customer lists for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
page_sizeintegerno
orderstringnoValues: "ASCENDING", "DESCENDING".
bookmarkstringno

pinterest_keywords_list

Pinterest Ads: Keywords List · read-only · idempotent

List keywords for an ad account. Can filter by campaign or ad group. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaign_idstringnoFilter by campaign.
ad_group_idstringnoFilter by ad group.
match_typesstring[]noFilter by match type. Values: "BROAD", "PHRASE", "EXACT", "COMPOUND".
page_sizeintegerno
bookmarkstringno

pinterest_keywords_metrics

Pinterest Ads: Keywords Metrics · read-only · idempotent

Get search volume metrics for keywords. Helps with keyword research. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
keywordsstring[]yesKeyword strings to get metrics for (max 2000).

Pinterest Ads: Keywords Trending · read-only · idempotent

Get trending keywords for a region and trend type. Requires an OAuth2 access_token with the user_accounts:read scope. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
regionstringyesRegion code e.g. "US", "CA", "GB", "AU", "IE", "IN", "NZ".
trend_typestringyesTrend type. Values: "growing", "monthly", "yearly", "seasonal".
interestsstring[]noFilter by interest categories.
gendersstring[]noValues: "FEMALE", "MALE", "UNKNOWN".
agesstring[]no
normalize_against_groupbooleannoNormalize data within the group.
limitintegernoNumber of results (max 50).
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

pinterest_lead_ads_subscriptions_get

Pinterest Ads: Lead Ads Subscriptions Get · read-only · idempotent

Get ONE lead ad subscription by subscription_id. DEPENDENCY: access_token + ad_account_id + subscription_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
subscription_idstringyesLead ads subscription unique identifier.

pinterest_lead_ads_subscriptions_list

Pinterest Ads: Lead Ads Subscriptions List · read-only · idempotent

List lead ad subscriptions for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
page_sizeintegerno
bookmarkstringno

pinterest_lead_forms_get

Pinterest Ads: Lead Forms Get · read-only · idempotent

Get a specific lead form by ID. DEPENDENCY: access_token + ad_account_id + lead_form_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
lead_form_idstringyesLead form unique identifier.

pinterest_lead_forms_list

Pinterest Ads: Lead Forms List · read-only · idempotent

List lead forms for an ad account. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
page_sizeintegerno
orderstringnoValues: "ASCENDING", "DESCENDING".
bookmarkstringno

pinterest_resources_ad_account_countries

Pinterest Ads: Resources Ad Account Countries · read-only · idempotent

Get the list of countries supported for ad accounts. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

pinterest_resources_delivery_metrics

Pinterest Ads: Resources Delivery Metrics · read-only · idempotent

Get available delivery metrics and their definitions. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
report_typestringnoFilter by report type. Values: "SYNC", "ASYNC".
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

pinterest_resources_interest_details

Pinterest Ads: Resources Interest Details · read-only · idempotent

Get details about a specific interest category by ID. DEPENDENCY: access_token + interest_id.

ParameterTypeRequiredDescription
interest_idstringyesInterest category unique identifier.
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

pinterest_resources_targeting_options

Pinterest Ads: Resources Targeting Options · read-only · idempotent

Get available targeting options by type (e.g. AGE_BUCKET, GENDER, GEO, INTEREST, KEYWORD, LOCALE, etc.). DEPENDENCY: access_token.

ParameterTypeRequiredDescription
targeting_typestringyesValues: "AGE_BUCKET", "APPTYPE", "AUDIENCE_CATEGORY", "AUDIENCE_LIST", "GENDER", "GEO", "INTEREST", "KEYWORD", "LANGUAGE", "LOCALE", "LOCATION", "SHOPPING_RETARGETING", "TARGETING_STRATEGY".
client_idstringno
oauth_signaturestringno
timestampstringno
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

Pinterest Ads: Terms Related · read-only · idempotent

Get terms related to a query (useful for keyword research). DEPENDENCY: access_token.

ParameterTypeRequiredDescription
termsstring[]yesSeed terms (max 4).
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

pinterest_terms_suggested

Pinterest Ads: Terms Suggested · read-only · idempotent

Get suggested terms based on a query. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
termstringyesSeed term.
limitintegernoNumber of suggestions (max 10).
account_idstringnoPinterest Ads account to use when the workspace has several, as returned by the account listing tool. Default: the first account linked to the workspace.

pinterest_user_account_analytics

Pinterest Ads: User Account Analytics · read-only · idempotent

Get analytics for the authenticated user's organic pins (impressions, saves, clicks). DEPENDENCY: access_token.

ParameterTypeRequiredDescription
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
from_claimed_contentstringnoValues: "OTHER", "CLAIMED", "BOTH".
pin_formatstringnoValues: "ALL", "PRODUCT", "REGULAR", "VIDEO".
app_typesstringnoValues: "ALL", "MOBILE", "TABLET", "WEB".
content_typestringnoValues: "ALL", "BOUGHT", "CREATED", "SAVED".
sourcestringnoValues: "ALL", "YOUR_PINS", "OTHER_PINS".
metric_typesstring[]noValues: "ENGAGEMENT", "ENGAGEMENT_RATE", "IMPRESSION", "OUTBOUND_CLICK", "OUTBOUND_CLICK_RATE", "PIN_CLICK", "PIN_CLICK_RATE", "SAVE", "SAVE_RATE".
split_fieldstringnoValues: "NO_SPLIT", "APP_TYPE", "OWNED_CONTENT", "SOURCE", "PIN_FORMAT".
ad_account_idstringno

pinterest_user_account_get

Pinterest Ads: User Account Get · read-only · idempotent

Get the authenticated user's Pinterest profile (name, bio, follower count, etc.). DEPENDENCY: access_token.

ParameterTypeRequiredDescription
ad_account_idstringnoOptional: view as this ad account.

pinterest_user_account_top_pins

Pinterest Ads: User Account Top Pins · read-only · idempotent

Get the user's top performing pins over the last 90 days. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
sort_bystringyesValues: "ENGAGEMENT", "IMPRESSION", "OUTBOUND_CLICK", "PIN_CLICK", "SAVE".
from_claimed_contentstringnoValues: "OTHER", "CLAIMED", "BOTH".
pin_formatstringnoValues: "ALL", "PRODUCT", "REGULAR", "VIDEO".
app_typesstringnoValues: "ALL", "MOBILE", "TABLET", "WEB".
content_typestringnoValues: "ALL", "BOUGHT", "CREATED", "SAVED".
sourcestringnoValues: "ALL", "YOUR_PINS", "OTHER_PINS".
num_of_pinsintegernoNumber of top pins (default 10, max 25).
created_in_last_n_daysintegernoDays back to look (max 90).
ad_account_idstringno

pinterest_user_account_top_video_pins

Pinterest Ads: User Account Top Video Pins · read-only · idempotent

Get the user's top performing video pins over the last 90 days. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
sort_bystringyesValues: "IMPRESSION", "SAVE", "OUTBOUND_CLICK", "VIDEO_MRC_VIEW", "VIDEO_AVG_WATCH_TIME".
from_claimed_contentstringnoValues: "OTHER", "CLAIMED", "BOTH".
pin_formatstringnoValues: "ALL", "PRODUCT", "REGULAR", "VIDEO".
app_typesstringnoValues: "ALL", "MOBILE", "TABLET", "WEB".
content_typestringnoValues: "ALL", "BOUGHT", "CREATED", "SAVED".
sourcestringnoValues: "ALL", "YOUR_PINS", "OTHER_PINS".
num_of_pinsintegerno
created_in_last_n_daysintegerno
ad_account_idstringno

Create and change (€29)

Served with the €29 plan.

pinterest_ad_accounts_create_report

Pinterest Ads: Ad Accounts Create Report · create or change, €29 plan · creates an object on each call

Request an asynchronous report for an ad account (returns a token for polling). DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.
start_datestringyesStart date YYYY-MM-DD.
end_datestringyesEnd date YYYY-MM-DD.
granularitystringnoAggregation granularity (default: TOTAL). Values: "TOTAL", "DAY", "HOUR", "WEEK", "MONTH".
columnsstring[]yesMetrics to include.
levelstringyesReport entity level. Values: "CAMPAIGN", "AD_GROUP", "AD", "KEYWORD", "PRODUCT_GROUP", "PRODUCT_GROUP_AND_KEYWORD".
report_formatstringnoOutput format. Values: "JSON", "CSV".
filtersany[]noOptional filter objects.

pinterest_ad_groups_create

Pinterest Ads: Ad Groups Create · create or change, €29 plan · creates an object on each call

Create one or more ad groups within a campaign. Pinterest has no DELETE for ad groups: to delete one, archive it with ad_groups_update (status ARCHIVED, one at a time, admin only); to stop it, use status PAUSED. DEPENDENCY: access_token + ad_account_id + campaign_id (from campaigns_list).

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
ad_groupsobject[]yesArray of ad group objects to create.

pinterest_ad_groups_update

Pinterest Ads: Ad Groups Update · create or change, €29 plan · creates an object on each call

Update one or more existing ad groups. DEPENDENCY: access_token + ad_account_id + ad_group_id(s).

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
ad_groupsobject[]yesArray of ad group update objects (must include id).

pinterest_ads_create

Pinterest Ads: Ads Create · create or change, €29 plan · creates an object on each call

Create one or more ads within ad groups. Pinterest has no DELETE for ads: to delete one, archive it with ads_update (status ARCHIVED, one at a time, admin only); to stop it, use status PAUSED. DEPENDENCY: access_token + ad_account_id + ad_group_id (from ad_groups_list).

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
adsobject[]yesArray of ad creation objects.

pinterest_ads_update

Pinterest Ads: Ads Update · create or change, €29 plan · creates an object on each call

Update one or more existing ads. DEPENDENCY: access_token + ad_account_id + ad_id(s).

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
adsobject[]yesArray of ad update objects (must include id).

pinterest_audiences_create

Pinterest Ads: Audiences Create · create or change, €29 plan · creates an object on each call

Create a new audience for targeting. Supports CUSTOMER_LIST, VISITOR, ENGAGEMENT, ACTALIKE, and PERSONA audience types. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
namestringyesAudience name.
typestringyesValues: "CUSTOMER_LIST", "VISITOR", "ENGAGEMENT", "ACTALIKE", "PERSONA".
ruleobjectyesAudience rule definition (depends on audience type).
descriptionstringno

pinterest_audiences_update

Pinterest Ads: Audiences Update · create or change, €29 plan · creates an object on each call

Update an existing audience name, description, or rule. To delete an audience, use audiences_delete. DEPENDENCY: access_token + ad_account_id + audience_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
audience_idstringyesAudience unique identifier.
namestringno
descriptionstringno
ruleobjectno
operation_typestringnoOperation to perform: UPDATE only (to delete, use audiences_delete). Values: "UPDATE".

pinterest_campaigns_create

Pinterest Ads: Campaigns Create · create or change, €29 plan · creates an object on each call

Create one or more campaigns for an ad account. Returns the created campaign objects. Pinterest has no DELETE for campaigns: to delete one, archive it with campaigns_update (status ARCHIVED, one at a time, admin only); to stop it, use status PAUSED. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaignsobject[]yesArray of campaign objects to create.

pinterest_campaigns_update

Pinterest Ads: Campaigns Update · create or change, €29 plan · creates an object on each call

Update one or more existing campaigns. DEPENDENCY: access_token + ad_account_id + campaign_id(s).

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaignsobject[]yesArray of campaign objects to update (must include id).

pinterest_catalog_feeds_create

Pinterest Ads: Catalog Feeds Create · create or change, €29 plan · creates an object on each call

Create a new catalog feed with a URL to your product data. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
namestringyesFeed name.
formatstringyesFeed file format. Values: "TSV", "CSV", "XML".
locationstringyesURL of the feed file (e.g. https://example.com/feed.csv).
default_currencystringyesISO 4217 currency code (e.g. USD).
catalog_idstringno
ad_account_idstringno
default_localestringnoBCP-47 locale (e.g. en-US).
default_countrystringnoISO 3166-1 alpha-2 country code.
preferred_processing_scheduleobjectno

pinterest_catalog_feeds_ingest

Pinterest Ads: Catalog Feeds Ingest · create or change, €29 plan · creates an object on each call

Manually trigger an ingestion (re-processing) of a catalog feed. DEPENDENCY: access_token + feed_id.

ParameterTypeRequiredDescription
feed_idstringyesFeed unique identifier.
ad_account_idstringno

pinterest_catalog_feeds_update

Pinterest Ads: Catalog Feeds Update · create or change, €29 plan · creates an object on each call

Update a catalog feed URL, name, format, or schedule. DEPENDENCY: access_token + feed_id.

ParameterTypeRequiredDescription
feed_idstringyesFeed unique identifier.
ad_account_idstringno
namestringno
locationstringno
formatstringnoValues: "TSV", "CSV", "XML".
default_currencystringno
statusstringnoValues: "ACTIVE", "INACTIVE", "DELETED".
preferred_processing_scheduleobjectno

pinterest_catalog_items_batch_upsert

Pinterest Ads: Catalog Items Batch Upsert · create or change, €29 plan · creates an object on each call

Batch upsert (create or update) catalog items. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
countrystringyes
languagestringyes
operationstringyesValues: "UPSERT", "DELETE", "UPDATE", "CREATE".
itemsobject[]yesArray of catalog item objects.
catalog_idstringno
ad_account_idstringno

pinterest_catalog_product_groups_create

Pinterest Ads: Catalog Product Groups Create · create or change, €29 plan · creates an object on each call

Create a product group for catalog ads targeting. DEPENDENCY: access_token + feed_id or catalog_id.

ParameterTypeRequiredDescription
namestringyesProduct group name.
descriptionstringno
filtersobjectnoFilter criteria for products.
feed_idstringno
catalog_idstringno
catalog_typestringnoValues: "RETAIL", "HOTEL", "TRAVEL", "LOCAL".
ad_account_idstringno

pinterest_catalog_product_groups_update

Pinterest Ads: Catalog Product Groups Update · create or change, €29 plan · creates an object on each call

Update a product group name, description, or filters. DEPENDENCY: access_token + product_group_id.

ParameterTypeRequiredDescription
product_group_idstringyesProduct group unique identifier.
namestringno
descriptionstringno
filtersobjectno
ad_account_idstringno

pinterest_catalogs_create

Pinterest Ads: Catalogs Create · create or change, €29 plan · creates an object on each call

Create a new catalog. The Pinterest API v5 can neither update nor delete a catalog (/catalogs has GET and POST only): create one only if it must stay. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
namestringyesCatalog name.
catalog_typestringyesValues: "RETAIL", "HOTEL", "TRAVEL", "LOCAL".
ad_account_idstringno

pinterest_conversion_events_send

Pinterest Ads: Conversion Events Send · create or change, €29 plan · creates an object on each call

Send conversion events to Pinterest (server-side conversion API). DEPENDENCY: access_token (conversion token) + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
testbooleannoSend as test events (not counted in reports).
dataobject[]yesArray of conversion event objects.

pinterest_conversion_tags_create

Pinterest Ads: Conversion Tags Create · create or change, €29 plan · creates an object on each call

Create a Pinterest conversion tag for website tracking. The Pinterest API v5 can neither update nor delete a conversion tag (/conversion_tags has GET and POST only): create one only if it must stay. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
namestringyesTag name.
aem_enabledbooleannoEnable Advanced Match (AEM).
md_frequencynumbernoFrequency for match data uploads.
aem_fnln_enabledbooleannoEnable first/last name matching.
aem_ph_enabledbooleannoEnable phone number matching.
aem_ge_enabledbooleannoEnable gender matching.
aem_db_enabledbooleannoEnable date of birth matching.
aem_loc_enabledbooleannoEnable location matching.

pinterest_keywords_create

Pinterest Ads: Keywords Create · create or change, €29 plan · creates an object on each call

Create keywords for targeting in an ad group. DEPENDENCY: access_token + ad_account_id + ad_group_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
keywordsobject[]yesArray of keyword objects to create.

pinterest_keywords_update

Pinterest Ads: Keywords Update · create or change, €29 plan · creates an object on each call

Update bid or status for existing keywords. DEPENDENCY: access_token + ad_account_id + keyword_id(s).

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
keywordsobject[]yes

pinterest_lead_ads_subscriptions_create

Pinterest Ads: Lead Ads Subscriptions Create · create or change, €29 plan · creates an object on each call

Subscribe to lead ad data for an ad account (webhook delivery). Returns the subscription id; read it with lead_ads_subscriptions_get, delete it with lead_ads_subscriptions_delete. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
webhook_urlstringnoHTTPS URL for webhook delivery.
lead_form_idstringnoFilter to a specific lead form.
partner_access_tokenstringno
partner_refresh_tokenstringno

pinterest_user_account_follow_user

Pinterest Ads: User Account Follow User · create or change, €29 plan · creates an object on each call

Follow a Pinterest user. DEPENDENCY: access_token + username.

ParameterTypeRequiredDescription
usernamestringyesUsername to follow.
ad_account_idstringno

pinterest_user_account_following

Pinterest Ads: User Account Following · create or change, €29 plan · creates an object on each call

Get the list of users the authenticated user is following. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
bookmarkstringno
page_sizeintegerno
feed_typestringnoValues: "CREATOR", "PINNER".
explicit_followingbooleanno
ad_account_idstringno

pinterest_user_account_following_boards

Pinterest Ads: User Account Following Boards · create or change, €29 plan · creates an object on each call

Get the list of boards the authenticated user is following. DEPENDENCY: access_token.

ParameterTypeRequiredDescription
bookmarkstringno
page_sizeintegerno
explicit_followingbooleanno
ad_account_idstringno

Delete (€29)

Served with the €29 plan. A deletion targets one object at a time.

pinterest_ad_accounts_delete_sandbox

Pinterest Ads: Ad Accounts Delete Sandbox · delete, €29 plan, one object at a time · creates an object on each call

Delete all campaigns/ads/etc. in a sandbox ad account. Only works for sandbox accounts. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesUnique identifier of the ad account.

pinterest_audiences_delete

Pinterest Ads: Audiences Delete · delete, €29 plan, one object at a time · creates an object on each call

Delete ONE audience by audience_id (irreversible), by the REMOVE operation of Pinterest. DEPENDENCY: access_token + ad_account_id + audience_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
audience_idstringyesAudience to delete (one only).

pinterest_bulk_upsert

Pinterest Ads: Bulk Upsert · delete, €29 plan, one object at a time · creates an object on each call

Bulk create or update campaigns, ad groups, ads, or keywords in one request. Returns a bulk_request_id for polling. DEPENDENCY: access_token + ad_account_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
campaignsobject[]no
ad_groupsobject[]no
adsobject[]no
keywordsobject[]no
product_groupsobject[]no

pinterest_catalog_feeds_delete

Pinterest Ads: Catalog Feeds Delete · delete, €29 plan, one object at a time · creates an object on each call

Delete a catalog feed. DEPENDENCY: access_token + feed_id.

ParameterTypeRequiredDescription
feed_idstringyesFeed unique identifier.
ad_account_idstringno

pinterest_catalog_product_groups_delete

Pinterest Ads: Catalog Product Groups Delete · delete, €29 plan, one object at a time · creates an object on each call

Delete a product group. DEPENDENCY: access_token + product_group_id.

ParameterTypeRequiredDescription
product_group_idstringyesProduct group unique identifier.
ad_account_idstringno

pinterest_keywords_delete

Pinterest Ads: Keywords Delete · delete, €29 plan, one object at a time · creates an object on each call

Delete ONE keyword (Pinterest archives it, which is irreversible: it disappears from its parent list and stops receiving metrics). Pass the ad group (or campaign) that holds it. DEPENDENCY: access_token + ad_account_id + keyword_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
keyword_idstringyesID of the keyword to delete (one only).
ad_group_idstringnoAd group that holds the keyword (read before and after; not sent).
campaign_idstringnoCampaign that holds the keyword, when it is not in an ad group (read before and after; not sent).

pinterest_lead_ads_subscriptions_delete

Pinterest Ads: Lead Ads Subscriptions Delete · delete, €29 plan, one object at a time · creates an object on each call

Delete ONE lead ad subscription by subscription_id (irreversible: the webhook stops receiving leads). DEPENDENCY: access_token + ad_account_id + subscription_id.

ParameterTypeRequiredDescription
ad_account_idstringyesAd account unique identifier.
subscription_idstringyesLead ads subscription to delete (one only).

On this page