Keywords Overview

<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $1.275 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->

GET https://api.aisa.one/apis/v1/similarweb/keyword-analysis/keywords/overview

Reference example

text

# Fixed reference example. Playground inputs do not update this sample.
curl --request GET \
  --url 'https://api.aisa.one/apis/v1/similarweb/keyword-analysis/keywords/overview?country=ww&end_date=2026-09&granularity=monthly&keywords=example&limit=1&start_date=2026-09' \
  --header 'Authorization: Bearer <token>'

Request contract

• Method and path: GET /apis/v1/similarweb/keyword-analysis/keywords/overview
• Request URL template: https://api.aisa.one/apis/v1/similarweb/keyword-analysis/keywords/overview
• country: query; optional
• end_date: query; required
• format: query; optional
• granularity: query; required
• keywords: query; required
• limit: query; required
• main_domain_only: query; optional
• start_date: query; required
• web_source: query; optional
• Runtime facts: 472d1bfda50ffcb36fea4b8745e9822da1d9f0225a1e0e220b661005b2d4b7b2

Complete OpenAPI definition

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

{
  "operationId": "get_similarweb_apis_v1_similarweb_keyword_analysi_490801",
  "method": "GET",
  "path": "/apis/v1/similarweb/keyword-analysis/keywords/overview",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "examples": {
        "default": {
          "value": "ww"
        }
      },
      "in": "query",
      "name": "country",
      "required": false,
      "schema": {
        "default": "ww",
        "description": "Worldwide data only; values are case-insensitive.",
        "enum": [
          "ww"
        ],
        "type": "string"
      }
    },
    {
      "examples": {
        "default": {
          "value": "2026-09"
        },
        "minimal": {
          "value": "2026-09"
        }
      },
      "in": "query",
      "name": "end_date",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "format",
      "required": false,
      "schema": {
        "enum": [
          "json"
        ],
        "type": "string"
      }
    },
    {
      "examples": {
        "default": {
          "value": "monthly"
        },
        "minimal": {
          "value": "monthly"
        }
      },
      "in": "query",
      "name": "granularity",
      "required": true,
      "schema": {
        "enum": [
          "monthly"
        ],
        "type": "string"
      }
    },
    {
      "examples": {
        "default": {
          "value": "example"
        },
        "minimal": {
          "value": "example"
        }
      },
      "in": "query",
      "name": "keywords",
      "required": true,
      "schema": {
        "type": "string",
        "x-aisa-delimiter": ",",
        "x-aisa-maxItems": 20,
        "x-aisa-minItems": 1
      }
    },
    {
      "examples": {
        "default": {
          "value": 1
        },
        "minimal": {
          "value": 1
        }
      },
      "in": "query",
      "name": "limit",
      "required": true,
      "schema": {
        "maximum": 20,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "in": "query",
      "name": "main_domain_only",
      "required": false,
      "schema": {
        "type": "boolean"
      }
    },
    {
      "examples": {
        "default": {
          "value": "2026-09"
        },
        "minimal": {
          "value": "2026-09"
        }
      },
      "in": "query",
      "name": "start_date",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "web_source",
      "required": false,
      "schema": {
        "enum": [
          "total"
        ],
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-pricing": {
    "cost_contract": "response_count",
    "customer_multiplier": 1.0,
    "customer_pricing": "provider_cost_multiplier",
    "default_request_estimate_usd": 1.275,
    "estimate_source": "profile_seed",
    "evidence_source": "response_body",
    "maximum_units": 20,
    "reserve_plan_units": {
      "input": "limit",
      "input_multiplier": 17
    },
    "unit": "similarweb_credit",
    "unit_rate_usd": 0.075,
    "units_per_count": 17
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Usage-based billing; Default request estimate: $1.275 USD (not a fixed price). Declared unit rate:$0.075 USD per similarweb_credit. 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.

• Default request reference estimate (USD): 1.275
• Declared unit rate (USD): 0.075
• Billing unit: similarweb_credit
• Cost contract: response_count
• Published reference multiplier: 1.0
• Count multiplier before declared scaling: 17
• Declared maximum count/units: 20
• Settlement evidence source: response_body The count multiplier is not a standalone credit or USD price. Apply only the scaling and rounding explicitly declared by this contract; use a supported quote for the complete request.

Reservation units (not settled usage)

• Units: (limit) × 17
• Public request parameter: limit

Request constraints and usage notes

• country supports ww only; default ww. State-level filtering is not supported.

Authorizations

Authorization · string · header · required

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

Query Parameters

country · enum<string> · default: ww

Worldwide data only; values are case-insensitive.

Available options: ww

end_date · string · required

format · enum<string>

Available options: json

granularity · enum<string> · required

Available options: monthly

keywords · string · required

limit · integer · required

Required range: 1 <= x <= 20

main_domain_only · boolean

start_date · string · required

web_source · enum<string>

Available options: total

Response

200

Successful response