Google: Get keyword metrics

curl --request GET \
  --url https://api.aisa.one/apis/v1/commerce/google/keywords/metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/commerce/google/keywords/metrics"

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/google/keywords/metrics', 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/google/keywords/metrics",
  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/google/keywords/metrics"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/commerce/google/keywords/metrics")

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": {
        "metrics": {
          "search_interest_index": {
            "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
          }
        },
        "period_label": {
          "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
        }
      },
      "snapshot_date": "<string>",
      "snapshot_time": "<string>"
    }
  ],
  "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>"
      }
    ]
  }
}

AIsa commerce

Google: Get keyword metrics

Retrieve Google keyword trend metrics for the requested country and language. Interpret values using the source reporting window and metric definitions; missing observations are not replaced with zero. ### Data and provenance By default, each value includes value and source. Shared collection time, license, origin, and value_type are grouped in meta.sources. Use provenance=full for complete per-value provenance. Requested fields not delivered by a source are listed in missing with a reason.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

GET

https://api.aisa.one

apis

commerce

google

keywords

metrics

Google: Get keyword metrics

curl --request GET \
  --url https://api.aisa.one/apis/v1/commerce/google/keywords/metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/commerce/google/keywords/metrics"

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/google/keywords/metrics', 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/google/keywords/metrics",
  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/google/keywords/metrics"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/commerce/google/keywords/metrics")

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": {
        "metrics": {
          "search_interest_index": {
            "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
          }
        },
        "period_label": {
          "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
        }
      },
      "snapshot_date": "<string>",
      "snapshot_time": "<string>"
    }
  ],
  "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/google/keywords/metrics
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/commerce/google/keywords/metrics
country: query; required
q: query; required
language: query; required
fields: query; optional
provenance: query; optional
Runtime facts: e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "get_aisa_commerce_apis_v1_commerce_google_keyword_35eb17",
  "method": "GET",
  "path": "/apis/v1/commerce/google/keywords/metrics",
  "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": "query",
      "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",
          "IN",
          "IT",
          "JP",
          "MX",
          "NL",
          "PL",
          "SE",
          "SG",
          "TR",
          "US"
        ],
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Search keywords.",
      "in": "query",
      "name": "q",
      "required": true,
      "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": "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": [
            "metrics.search_interest_index",
            "period_label"
          ],
          "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.google.keyword_metrics.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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

country

enum<string> | null

required

Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.

Available options:

AE,

AU,

BR,

CA,

DE,

ES,

FR,

GB,

IN,

IT,

JP,

MX,

NL,

PL,

SE,

SG,

TR,

US

string | null

required

Search keywords.

language

string | null

required

Result language as a BCP 47 tag, such as en, en-US, or zh-Hans.

fields

enum<string>[] | null

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.

Available options:

metrics.search_interest_index,

period_label

provenance

enum<string> | null

default:compact

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.

Available options:

compact,

full

Response

Success

items

(object | null)[] | null

Show child attributes

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Response

Request contract

Cost and request rules