List Search keywords
curl --request GET \
--url https://api.aisa.one/apis/v1/ads/keywords \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/ads/keywords"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/ads/keywords', 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.aisa.one/apis/v1/ads/keywords",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.aisa.one/apis/v1/ads/keywords"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/ads/keywords")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/keywords")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"keywords": [
{
"adAccountId": "<string>",
"adSetId": "<string>",
"adSetName": "<string>",
"adSetStatus": "<string>",
"campaignId": "<string>",
"campaignName": "<string>",
"campaignStatus": "<string>",
"connectionId": "<string>",
"id": "<string>",
"keyword": "<string>",
"matchType": "exact",
"metrics": {
"clicks": 123,
"conversions": 123,
"cost": 123,
"firstPageCpc": 123,
"firstPositionCpc": 123,
"impressions": 123,
"windowDays": 123
},
"negative": true,
"platform": "google",
"platformCriterionId": "<string>",
"quality": {
"adRelevance": "BELOW_AVERAGE",
"expectedCtr": "BELOW_AVERAGE",
"landingPageExperience": "BELOW_AVERAGE",
"score": 123
},
"qualityScore": 123,
"resourceName": "<string>",
"status": "active",
"syncedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"page": 123,
"pages": 123,
"total": 123
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Ads
List Search keywords
Ad Campaigns. Read only. Lists the keywords and negative keywords in your Google Search ad groups. Returns the Google Search keyword criteria (positive and negative) synced from connected Google Ads accounts, one row per ad-group keyword. Campaign-level negative keywords are not included; only ad-group-level criteria are. ### Freshness
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
GET
https://api.aisa.one
/
apis
/
v1
/
ads
/
keywords
List Search keywords
curl --request GET \
--url https://api.aisa.one/apis/v1/ads/keywords \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/ads/keywords"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/ads/keywords', 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.aisa.one/apis/v1/ads/keywords",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.aisa.one/apis/v1/ads/keywords"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/ads/keywords")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/keywords")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"keywords": [
{
"adAccountId": "<string>",
"adSetId": "<string>",
"adSetName": "<string>",
"adSetStatus": "<string>",
"campaignId": "<string>",
"campaignName": "<string>",
"campaignStatus": "<string>",
"connectionId": "<string>",
"id": "<string>",
"keyword": "<string>",
"matchType": "exact",
"metrics": {
"clicks": 123,
"conversions": 123,
"cost": 123,
"firstPageCpc": 123,
"firstPositionCpc": 123,
"impressions": 123,
"windowDays": 123
},
"negative": true,
"platform": "google",
"platformCriterionId": "<string>",
"quality": {
"adRelevance": "BELOW_AVERAGE",
"expectedCtr": "BELOW_AVERAGE",
"landingPageExperience": "BELOW_AVERAGE",
"score": 123
},
"qualityScore": 123,
"resourceName": "<string>",
"status": "active",
"syncedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"page": 123,
"pages": 123,
"total": 123
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: GET /apis/v1/ads/keywords
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/ads/keywords - connectionId: query; required
- page: query; optional
- limit: query; optional
- adAccountId: query; optional
- campaignId: query; optional
- adSetId: query; optional
- status: query; optional
- matchType: query; optional
- negative: query; optional
- search: query; optional
- Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
{
"operationId": "get_aisa_ads_apis_v1_ads_keywords",
"method": "GET",
"path": "/apis/v1/ads/keywords",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.",
"in": "query",
"name": "connectionId",
"required": true,
"schema": {
"pattern": "^adc_[0-9A-Za-z]+$",
"type": "string"
}
},
{
"description": "Page number (1-based)",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"minimum": 1,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 500,
"minimum": 1,
"type": "integer"
}
},
{
"description": "Platform ad account ID (Google customer ID). Mirrors the same filter on /apis/v1/ads.",
"in": "query",
"name": "adAccountId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Platform campaign ID Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
"in": "query",
"name": "campaignId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Platform ad group ID (Google ad group) Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
"in": "query",
"name": "adSetId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Keyword criterion status",
"in": "query",
"name": "status",
"required": false,
"schema": {
"enum": [
"active",
"paused"
],
"type": "string"
}
},
{
"description": "Accepted in any case.",
"in": "query",
"name": "matchType",
"required": false,
"schema": {
"enum": [
"exact",
"phrase",
"broad",
"unknown"
],
"type": "string"
}
},
{
"description": "true = negative keywords only, false = positive only. Omit for both.",
"in": "query",
"name": "negative",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Case-insensitive substring match on the keyword text",
"in": "query",
"name": "search",
"required": false,
"schema": {
"maxLength": 200,
"type": "string"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
"kind": "no_customer_charge"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.
Pattern:
^adc_[0-9A-Za-z]+$Page number (1-based)
Required range:
x >= 1Required range:
1 <= x <= 500Platform ad account ID (Google customer ID). Mirrors the same filter on /apis/v1/ads.
Platform campaign ID Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.
Platform ad group ID (Google ad group) Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.
Keyword criterion status
Available options:
active, paused Accepted in any case.
Available options:
exact, phrase, broad, unknown true = negative keywords only, false = positive only. Omit for both.
Case-insensitive substring match on the keyword text
Maximum string length:
200