curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
"<string>"
],
"customer_id": "<string>",
"geo_target_ids": [
"<string>"
],
"language_id": "<string>",
"network": "GOOGLE_SEARCH",
"include_average_cpc": true,
"include_monthly_volumes": false
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get"
payload = {
"keywords": ["<string>"],
"customer_id": "<string>",
"geo_target_ids": ["<string>"],
"language_id": "<string>",
"network": "GOOGLE_SEARCH",
"include_average_cpc": True,
"include_monthly_volumes": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
keywords: ['<string>'],
customer_id: '<string>',
geo_target_ids: ['<string>'],
language_id: '<string>',
network: 'GOOGLE_SEARCH',
include_average_cpc: true,
include_monthly_volumes: false
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'keywords' => [
'<string>'
],
'customer_id' => '<string>',
'geo_target_ids' => [
'<string>'
],
'language_id' => '<string>',
'network' => 'GOOGLE_SEARCH',
'include_average_cpc' => true,
'include_monthly_volumes' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get"
payload := strings.NewReader("{\n \"keywords\": [\n \"<string>\"\n ],\n \"customer_id\": \"<string>\",\n \"geo_target_ids\": [\n \"<string>\"\n ],\n \"language_id\": \"<string>\",\n \"network\": \"GOOGLE_SEARCH\",\n \"include_average_cpc\": true,\n \"include_monthly_volumes\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"keywords\": [\n \"<string>\"\n ],\n \"customer_id\": \"<string>\",\n \"geo_target_ids\": [\n \"<string>\"\n ],\n \"language_id\": \"<string>\",\n \"network\": \"GOOGLE_SEARCH\",\n \"include_average_cpc\": true,\n \"include_monthly_volumes\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keywords\": [\n \"<string>\"\n ],\n \"customer_id\": \"<string>\",\n \"geo_target_ids\": [\n \"<string>\"\n ],\n \"language_id\": \"<string>\",\n \"network\": \"GOOGLE_SEARCH\",\n \"include_average_cpc\": true,\n \"include_monthly_volumes\": false\n}"
response = http.request(request)
puts response.read_bodyKeyword-plan-metrics get
Google Keyword Planner data for keywords that are NOT yet in the account: average monthly searches, top-of-page bid range, competition and average CPC, for pre-launch keyword research. Use this to size conquesting or non-brand terms before committing budget. For keywords already running in the account, use adside google-ads keyword-performance get instead.
CLI: adside google-ads keyword-plan-metrics get
curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
"<string>"
],
"customer_id": "<string>",
"geo_target_ids": [
"<string>"
],
"language_id": "<string>",
"network": "GOOGLE_SEARCH",
"include_average_cpc": true,
"include_monthly_volumes": false
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get"
payload = {
"keywords": ["<string>"],
"customer_id": "<string>",
"geo_target_ids": ["<string>"],
"language_id": "<string>",
"network": "GOOGLE_SEARCH",
"include_average_cpc": True,
"include_monthly_volumes": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
keywords: ['<string>'],
customer_id: '<string>',
geo_target_ids: ['<string>'],
language_id: '<string>',
network: 'GOOGLE_SEARCH',
include_average_cpc: true,
include_monthly_volumes: false
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'keywords' => [
'<string>'
],
'customer_id' => '<string>',
'geo_target_ids' => [
'<string>'
],
'language_id' => '<string>',
'network' => 'GOOGLE_SEARCH',
'include_average_cpc' => true,
'include_monthly_volumes' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get"
payload := strings.NewReader("{\n \"keywords\": [\n \"<string>\"\n ],\n \"customer_id\": \"<string>\",\n \"geo_target_ids\": [\n \"<string>\"\n ],\n \"language_id\": \"<string>\",\n \"network\": \"GOOGLE_SEARCH\",\n \"include_average_cpc\": true,\n \"include_monthly_volumes\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"keywords\": [\n \"<string>\"\n ],\n \"customer_id\": \"<string>\",\n \"geo_target_ids\": [\n \"<string>\"\n ],\n \"language_id\": \"<string>\",\n \"network\": \"GOOGLE_SEARCH\",\n \"include_average_cpc\": true,\n \"include_monthly_volumes\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/google-ads/keyword-plan-metrics/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keywords\": [\n \"<string>\"\n ],\n \"customer_id\": \"<string>\",\n \"geo_target_ids\": [\n \"<string>\"\n ],\n \"language_id\": \"<string>\",\n \"network\": \"GOOGLE_SEARCH\",\n \"include_average_cpc\": true,\n \"include_monthly_volumes\": false\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.
Path Parameters
1Body
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.
1 - 1000 elements1Omit it: it defaults to the account this workspace is connected to, and any other account is refused.
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 constant ID (from adside google-ads languages get). Defaults to '1000' (English).
GOOGLE_SEARCH matches what Keyword Planner shows by default.
GOOGLE_SEARCH, GOOGLE_SEARCH_AND_PARTNERS Include the historical average CPC alongside the bid range.
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
Success