List Google Ads search terms

curl --request GET \
  --url https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms \
  --header 'api_key: <api-key>'

import requests

url = "https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms', 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://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "search_term": "oak dining table",
    "campaign": "Spring sale - Search",
    "impressions": 980,
    "clicks": 17,
    "cost_micros": 24500000,
    "conversions": 2
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Reporting

List Google Ads search terms

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Returns the search terms that triggered the account’s ads, ordered by impressions.

Pass either date_range or both start_date and end_date. Sending only one of the two dates is rejected with a 400, as is a start_date after end_date. Explicit dates win over date_range.

date_range accepts TODAY, YESTERDAY, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS, LAST_90_DAYS, THIS_WEEK_MON_TODAY, THIS_WEEK_SUN_TODAY, LAST_WEEK_MON_SUN, LAST_WEEK_SUN_SAT, LAST_BUSINESS_WEEK, THIS_MONTH, and LAST_MONTH, and defaults to LAST_30_DAYS. LAST_7_DAYS, LAST_30_DAYS and LAST_90_DAYS count back from today in the account’s own time zone and include today; the other values are Google Ads’ windows, which end yesterday.

At most 100 terms come back and there is no paging, so a busy account returns only its top 100. Terms are gathered from every campaign type on the account and merged into one list. When one of those reads fails the rest are still returned, under a 200 and with nothing in the response to say some terms are missing.

This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.

GET

api

apps

{app_id}

google-ads

analytics

search-terms

List Google Ads search terms

curl --request GET \
  --url https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms \
  --header 'api_key: <api-key>'

import requests

url = "https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms', 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://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/google-ads/analytics/search-terms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "search_term": "oak dining table",
    "campaign": "Spring sale - Search",
    "impressions": 980,
    "clicks": 17,
    "cost_micros": 24500000,
    "conversions": 2
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

header

required

Personal API key.

Path Parameters

app_id

string

required

ID of the app whose Google Ads reporting you want to read.

Query Parameters

date_range

string

default:LAST_30_DAYS

A preset window, for example LAST_7_DAYS or LAST_MONTH. Ignored when start_date and end_date are both set.

start_date

string | null

First day of an explicit window, as YYYY-MM-DD. Requires end_date.

end_date

string | null

Last day of an explicit window, as YYYY-MM-DD. Requires start_date.

Response

Up to 100 search terms, highest impressions first.

search_term

string

required

The term the user searched for.

Example:

"oak dining table"

campaign

string

required

Name of the campaign whose ad the term matched.

Example:

"Spring sale - Search"

impressions

integer

required

Impressions the term drove in the window.

Example:

980

clicks

integer

required

Clicks the term drove in the window.

Example:

17

cost_micros

integer

required

Amount spent on the term in the window, in micros of the account's currency.

Example:

24500000

conversions

number

required

Conversions attributed to the term in the window.

Example:

2

⌘I

App Management API (Beta)

Entities API (Beta)

Virality API (Beta)

Workflows API (Beta)

Analytics API (Beta)

Google Ads API (Beta)

Monitoring API

Audit Logs API

List Google Ads search terms

Authorizations

Path Parameters

Query Parameters

Response