# 網站關鍵字

**API:** Data API

**Endpoint:** `GET /v1/beta/similarweb/search/website-keywords`

**Tags:** Website Analytics

網站關鍵字。回應遵循 SimilarWeb v5 信封結構（meta + data）。日期限制：start_date 至 end_date 的範圍必須涵蓋 1 到 3 個月度分桶。

### 定價參考

- 計量方式：依結果筆數計量。
- 參考請求預估：USD 0.075。
- 單位成本基礎：USD 0.075。
- 資源單位：`similarweb_credit`。
- 參考客戶乘數：1.0。不得再次套用於已結算的客戶金額。
- 成本基礎不構成最終客戶價格，即使為零亦同。

僅供參考的中繼資料，並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `country` | query | no | string, enum: "ww", default: "ww" |  |
| `domain` | query | yes | string |  |
| `end_date` | query | yes | string |  |
| `format` | query | no | string, enum: "json" |  |
| `granularity` | query | yes | string, enum: "monthly" |  |
| `limit` | query | yes | integer |  |
| `main_domain_only` | query | no | boolean |  |
| `start_date` | query | yes | string |  |
| `web_source` | query | no | string, enum: "total" |  |

## Responses

### 200 — SimilarWeb v5 信封結構（meta + data）。

Headers:
- `X-Request-Id` (string) — 聯絡 Felo 支援時需提供的請求識別碼。

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "meta": {
      "$ref": "#/components/schemas/ResponseF53Baa954733_SimilarWebMeta"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "type": [
              "string",
              "null"
            ],
            "description": "要分析的單一關鍵字或關鍵字組名稱"
          },
          "clicks": {
            "type": [
              "number",
              "null"
            ],
            "format": "double",
            "description": "網站獲得的搜尋關鍵字點擊次數"
          },
          "traffic_share": {
            "type": [
              "number",
              "null"
            ],
            "format": "double",
            "description": "流向該網站的流量佔比"
          },
          "competition": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int32",
            "description": "該關鍵字的廣告投放競爭程度。"
          },
          "primary_intent": {
            "type": [
              "string",
              "null"
            ],
            "description": "搜尋該關鍵字的使用者希望達成什麼目標的估計。"
          },
          "secondary_intent": {
            "type": [
              "string",
              "null"
            ]
          },
          "position": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int32",
            "description": "該關鍵字在所選時間範圍內的最新通用排名。'world' 國家／地區無法使用。"
          },
          "serp_features": {
            "type": [
              "string",
              "array"
            ],
            "items": {
              "type": "string"
            }
          },
          "top_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "針對所分析關鍵字排名最高的自然結果網站 URL"
          },
          "url_count": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int32",
            "description": "該關鍵字對應的 URL 數量"
          }
        }
      }
    }
  }
}
```

### 400 — 無法處理該要求。請檢查請求參數。

### 401 — 需要有效的 Felo API 金鑰。

### 402 — 由於未符合計費要求，要求無法繼續。

### 403 — 該帳戶無權執行此操作。

### 429 — 已達到要求或支出上限。

### 502 — 服務無法完成該要求。

### 503 — API 或計費服務暫時無法使用。

### 504 — 服務在處理要求時逾時。

### default — 錯誤回應；上游透傳回應可能採用供應商格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### ResponseF53Baa954733_SimilarWebMeta

`#/components/schemas/ResponseF53Baa954733_SimilarWebMeta`

```json
{
  "type": "object",
  "description": "SimilarWeb v5 回應信封中繼資料。",
  "properties": {
    "status": {
      "type": "string",
      "description": "上游狀態；呼叫成功時為 'success'。",
      "example": "success"
    },
    "last_updated": {
      "type": "string",
      "description": "上游可用的最新資料點日期（YYYY-MM-DD）。",
      "example": "2026-06-30"
    },
    "request": {
      "type": "object",
      "description": "正規化上游請求的完整回顯（依接收到的參數）。"
    },
    "query": {
      "type": "object",
      "description": "適用時回顯分頁/排序參數（limit、offset、asc、sort）。"
    }
  },
  "required": [
    "status"
  ]
}
```