curl --request GET \
--url https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/keywords \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/keywords")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/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{
"items": [
{
"fields": {
"ad_rank": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"competing_products": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"estimated_search_volume": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"estimated_search_volume_broad": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"estimated_search_volume_exact": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"keyword_popularity_rank": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"organic_rank": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"relation": {
"listing_id": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"relation_type": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"supply_demand_ratio": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"title": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"traffic_share": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"key": "<string>",
"kind": "<string>",
"rank": 123
}
],
"meta": {
"notices": [
"<string>"
],
"period": {
"end": "<unknown>",
"kind": "<string>",
"start": "<unknown>"
},
"sources": {}
},
"missing": [
{
"reason": "<string>",
"source": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}Amazon: Get listing keywords
curl --request GET \
--url https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/keywords \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/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/commerce/amazon/listings/{country}/{listing_id}/keywords")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/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{
"items": [
{
"fields": {
"ad_rank": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"competing_products": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"estimated_search_volume": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"estimated_search_volume_broad": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"estimated_search_volume_exact": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"keyword_popularity_rank": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"organic_rank": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"relation": {
"listing_id": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"relation_type": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"supply_demand_ratio": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"title": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"traffic_share": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"key": "<string>",
"kind": "<string>",
"rank": 123
}
],
"meta": {
"notices": [
"<string>"
],
"period": {
"end": "<unknown>",
"kind": "<string>",
"start": "<unknown>"
},
"sources": {}
},
"missing": [
{
"reason": "<string>",
"source": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}Request contract
- Method and path: GET /apis/v1/commerce/amazon/listings/{country}/{listing_id}/keywords
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/keywords - country: path; required
- listing_id: path; required
- q: query; optional
- language: query; required
- cursor: query; optional
- page_size: query; optional
- period: query; optional
- date: query; optional
- keyword_flags: query; optional
- sort_by: query; optional
- sort_order: query; optional
- fields: query; optional
- provenance: query; optional
- Runtime facts: e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8
{
"operationId": "get_aisa_commerce_apis_v1_commerce_amazon_listing_1d6e15",
"method": "GET",
"path": "/apis/v1/commerce/amazon/listings/{country}/{listing_id}/keywords",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.",
"in": "path",
"name": "country",
"required": true,
"schema": {
"description": "Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.",
"enum": [
"AE",
"AU",
"BR",
"CA",
"DE",
"ES",
"FR",
"GB",
"IT",
"JP",
"MX",
"SA",
"US"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Native product ID on the platform.",
"in": "path",
"name": "listing_id",
"required": true,
"schema": {
"description": "Native product ID on the platform.",
"type": [
"string",
"null"
]
}
},
{
"description": "Search keywords.",
"in": "query",
"name": "q",
"required": false,
"schema": {
"description": "Search keywords.",
"type": [
"string",
"null"
]
}
},
{
"description": "Result language as a BCP 47 tag, such as en, en-US, or zh-Hans.",
"in": "query",
"name": "language",
"required": true,
"schema": {
"description": "Result language as a BCP 47 tag, such as en, en-US, or zh-Hans.",
"type": [
"string",
"null"
]
}
},
{
"description": "Pass the previous response's next_cursor unchanged. Omit for the first page. A null next_cursor indicates the end of pagination.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"description": "Pass the previous response's next_cursor unchanged. Omit for the first page. A null next_cursor indicates the end of pagination.",
"type": [
"string",
"null"
]
}
},
{
"description": "Number of items per page. Use an unpadded decimal integer from 10 to 100; omit for the default 20.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"default": "20",
"description": "Number of items per page. Use an unpadded decimal integer from 10 to 100; omit for the default 20.",
"pattern": "^(?:[1-9][0-9]|100)$",
"type": [
"string",
"null"
]
}
},
{
"description": "Reporting window. 1d, 7d, 30d, and 90d are rolling windows ending at the latest update; calendar_month and calendar_week select the calendar period identified by date. See the enum for supported values. Defaults to the last 7 days.",
"in": "query",
"name": "period",
"required": false,
"schema": {
"description": "Reporting window. 1d, 7d, 30d, and 90d are rolling windows ending at the latest update; calendar_month and calendar_week select the calendar period identified by date. See the enum for supported values. Defaults to the last 7 days.",
"enum": [
"30d",
"7d",
"calendar_month",
"calendar_week"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Date identifying a calendar period, in YYYY-MM-DD format. See operation-specific notes for the required day of the week or month. For calendar_month, use YYYY-MM or any date in the month; for calendar_week, use the start date of that week. Omit date for 7d and 30d.",
"in": "query",
"name": "date",
"required": false,
"schema": {
"description": "Date identifying a calendar period, in YYYY-MM-DD format. See operation-specific notes for the required day of the week or month. For calendar_month, use YYYY-MM or any date in the month; for calendar_week, use the start date of that week. Omit date for 7d and 30d.",
"format": "date",
"type": [
"string",
"null"
]
}
},
{
"description": "Comma-separated keyword flags; results must match all supplied flags. organic: organic ranking; sponsored_product_ad: sponsored product ad; sponsored_brand_ad: brand ad; sponsored_video_ad: video ad; amazons_choice: Amazon's Choice keyword; precise: precise keyword; precise_long_tail: precise long-tail keyword; purchase: purchase keyword; quality: quality keyword; stable: stable keyword; lost: lost keyword; invalid: invalid keyword; multi_variant: multiple variants; search_volume_up/search_volume_down: increasing/decreasing search volume. These labels reflect the source's classifications.",
"explode": false,
"in": "query",
"name": "keyword_flags",
"required": false,
"schema": {
"description": "Comma-separated keyword flags; results must match all supplied flags. organic: organic ranking; sponsored_product_ad: sponsored product ad; sponsored_brand_ad: brand ad; sponsored_video_ad: video ad; amazons_choice: Amazon's Choice keyword; precise: precise keyword; precise_long_tail: precise long-tail keyword; purchase: purchase keyword; quality: quality keyword; stable: stable keyword; lost: lost keyword; invalid: invalid keyword; multi_variant: multiple variants; search_volume_up/search_volume_down: increasing/decreasing search volume. These labels reflect the source's classifications.",
"items": {
"enum": [
"amazons_choice",
"invalid",
"lost",
"multi_variant",
"organic",
"precise",
"precise_long_tail",
"purchase",
"quality",
"search_volume_down",
"search_volume_up",
"sponsored_brand_ad",
"sponsored_product_ad",
"sponsored_video_ad",
"stable"
],
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"style": "form"
},
{
"description": "Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. organic_rank and ad_rank correspond to output fields. estimated_search_volume sorts by estimated volume within the window; search_rank by keyword popularity rank; updated_at by the source row update time. The latter three have no same-named output fields.",
"in": "query",
"name": "sort_by",
"required": false,
"schema": {
"description": "Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. organic_rank and ad_rank correspond to output fields. estimated_search_volume sorts by estimated volume within the window; search_rank by keyword popularity rank; updated_at by the source row update time. The latter three have no same-named output fields.",
"enum": [
"ad_rank",
"estimated_search_volume",
"organic_rank",
"search_rank",
"updated_at"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Sort direction: asc or desc. Requires sort_by.",
"in": "query",
"name": "sort_order",
"required": false,
"schema": {
"description": "Sort direction: asc or desc. Requires sort_by.",
"enum": [
"asc",
"desc"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.",
"explode": false,
"in": "query",
"name": "fields",
"required": false,
"schema": {
"description": "Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.",
"items": {
"enum": [
"ad_rank",
"competing_products",
"estimated_search_volume",
"estimated_search_volume_broad",
"estimated_search_volume_exact",
"keyword_popularity_rank",
"organic_rank",
"relation.listing_id",
"relation_type",
"supply_demand_ratio",
"title",
"traffic_share"
],
"type": "string"
},
"type": [
"array",
"null"
]
},
"style": "form"
},
{
"description": "compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.",
"in": "query",
"name": "provenance",
"required": false,
"schema": {
"default": "compact",
"description": "compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.",
"enum": [
"compact",
"full"
],
"type": [
"string",
"null"
]
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cache_hit_share_bps": 10000,
"customer_micros_usd": 50000,
"customer_pricing_ref": "commerce.amazon.listing_keywords.query.v1.pricing@1",
"description": "Charged once per delivered read: an entity with at least one requested field, or one page of a result set. A read that delivers nothing is not charged. A read answered from stored values is charged the cache-hit share of the price. Variants are priced by the route parameters they fix.",
"kind": "fixed_request"
},
"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.
Path Parameters
Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.
AE, AU, BR, CA, DE, ES, FR, GB, IT, JP, MX, SA, US Native product ID on the platform.
Query Parameters
Search keywords.
Result language as a BCP 47 tag, such as en, en-US, or zh-Hans.
Pass the previous response's next_cursor unchanged. Omit for the first page. A null next_cursor indicates the end of pagination.
Number of items per page. Use an unpadded decimal integer from 10 to 100; omit for the default 20.
^(?:[1-9][0-9]|100)$Reporting window. 1d, 7d, 30d, and 90d are rolling windows ending at the latest update; calendar_month and calendar_week select the calendar period identified by date. See the enum for supported values. Defaults to the last 7 days.
30d, 7d, calendar_month, calendar_week Date identifying a calendar period, in YYYY-MM-DD format. See operation-specific notes for the required day of the week or month. For calendar_month, use YYYY-MM or any date in the month; for calendar_week, use the start date of that week. Omit date for 7d and 30d.
Comma-separated keyword flags; results must match all supplied flags. organic: organic ranking; sponsored_product_ad: sponsored product ad; sponsored_brand_ad: brand ad; sponsored_video_ad: video ad; amazons_choice: Amazon's Choice keyword; precise: precise keyword; precise_long_tail: precise long-tail keyword; purchase: purchase keyword; quality: quality keyword; stable: stable keyword; lost: lost keyword; invalid: invalid keyword; multi_variant: multiple variants; search_volume_up/search_volume_down: increasing/decreasing search volume. These labels reflect the source's classifications.
amazons_choice, invalid, lost, multi_variant, organic, precise, precise_long_tail, purchase, quality, search_volume_down, search_volume_up, sponsored_brand_ad, sponsored_product_ad, sponsored_video_ad, stable Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. organic_rank and ad_rank correspond to output fields. estimated_search_volume sorts by estimated volume within the window; search_rank by keyword popularity rank; updated_at by the source row update time. The latter three have no same-named output fields.
ad_rank, estimated_search_volume, organic_rank, search_rank, updated_at Sort direction: asc or desc. Requires sort_by.
asc, desc Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.
ad_rank, competing_products, estimated_search_volume, estimated_search_volume_broad, estimated_search_volume_exact, keyword_popularity_rank, organic_rank, relation.listing_id, relation_type, supply_demand_ratio, title, traffic_share compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.
compact, full