v2

latestOpenAPI 3.1.02026-08-075421692.0 MB

Ad Insights

Historical keyword metrics (Google Keyword Planner)

Google Ads only. Runs Keyword Planner's generateKeywordHistoricalMetrics for up to 1,000 exact keywords: historical search volume, competition and top-of-page bid ranges, plus averageCpcMicros when includeAverageCpc is set. Rows come back verbatim; counters are int64s encoded as strings, bid/CPC values are micros of the account currency.

post/v1/ads/keywords/historical-metrics

Request body

accountIdstring required

Zernio googleads SocialAccount id.

customerIdstring

Numeric Google Ads customer id (no dashes); only needed when the connection has several accounts.

keywordsstring[] required

countriesstring[]

ISO 3166-1 alpha-2 country codes. Omitted = worldwide.

languageConstantIdstring

Google languageConstant id (1000 = English).

network'GOOGLE_SEARCH' | 'GOOGLE_SEARCH_AND_PARTNERS'

includeAdultKeywordsboolean

includeAverageCpcboolean

Adds averageCpcMicros to each row's keywordMetrics.

Response

Historical metric rows (raw Keyword Planner shape)

customerIdstring

The customer the request ran against.

dataobject[]

aggregateMetricResultsobject nullable