Skip to main content
POST
Keyword-plan-metrics get

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
keywords
string[]
required

The exact terms to measure. Send them all in one call — Google allows only 1 request/second per account, so splitting is slower, not safer.

Required array length: 1 - 1000 elements
Minimum string length: 1
customer_id
string

Omit it: it defaults to the account this workspace is connected to, and any other account is refused.

geo_target_ids
string[]

Geo target constant IDs (from adside google-ads geo-targets get), e.g. '21137' for California. STRONGLY recommended: omitting this returns worldwide volumes, which can be an order of magnitude higher and is almost never what was asked.

language_id
string

Language constant ID (from adside google-ads languages get). Defaults to '1000' (English).

network
enum<string>
default:GOOGLE_SEARCH

GOOGLE_SEARCH matches what Keyword Planner shows by default.

Available options:
GOOGLE_SEARCH,
GOOGLE_SEARCH_AND_PARTNERS
include_average_cpc
boolean
default:true

Include the historical average CPC alongside the bid range.

include_monthly_volumes
boolean
default:false

Include the 12-month volume series per keyword. Off by default: it multiplies the response size by ~12 and is only useful for seasonality.

Response

200 - application/json

Success