# 網域 Whois 概覽

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/domain_analytics/whois/overview/live`

**Tags:** DataForSEO

附有 SEO 指標的 Whois 記錄。每項包含 `domain`、`created_datetime`、`changed_datetime`、`expiration_datetime`、`updated_datetime`、`first_seen`、`epp_status_codes`、`tld`、`registered`、`registrar`，以及 `metrics` 與 `backlinks_info`。使用 `limit`、`offset` 與 `offset_token` 分頁，並依 `get_dataforseo_domains_whois_available_filters` 中的欄位篩選。

### 計費參考

- 計量方式：依回報的回應成本計量。
- 參考請求估算：0.012 美元。
- 參考客戶倍率：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`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>傳回的網域數量上限</em><br>選填欄位<br>預設值：<code>100</code><br>最大值：<code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>傳回的項目在結果陣列中的位移量</em><br>選填欄位<br>預設值：<code>0</code><br>若指定值 <code>10</code>，結果陣列中的前 10 個 <code>items</code> 將被省略，資料會從後續項目開始提供；<br><strong>注意：</strong>建議僅在擷取最多 10,000 筆結果時使用此參數；如需擷取超過 10,000 筆結果，請改用 <code>offset_token</code>"
          },
          "offset_token": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用於後續請求的權杖</em><br>選填欄位<br>在每次請求回應的同名欄位中提供；<br>使用此參數可在單次請求嘗試取得超過 100,000 筆結果時避免逾時；<br>透過指定回應陣列中的唯一 <code>offset_token</code> 值，你將取得初始任務的後續結果；<br><code>offset_token</code> 值對每個後續任務都是唯一的<br><strong>注意：</strong>如果請求中指定了 <code>offset_token</code>，所有其他參數都應與先前的請求保持一致<br>如需進一步瞭解此參數，請參閱我們的 <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">說明中心</a>"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>結果篩選參數陣列</em><br>選填欄位<br><strong>可同時新增多個篩選條件（最多 8 個）</strong><br>應在條件之間設定邏輯運算子 <code>and</code>、<code>or</code><br>支援以下運算子：<br><code>regex</code>、<code>&lt;</code>、<code>&lt;=</code>、<code>&gt;</code>、<code>&gt;=</code>、<code>=</code>、<code>&lt;&gt;</code>、<code>in</code>、<code>not_in</code>、<code>like</code>、<code>not_like</code><br>可在 <code>like</code> 與 <code>not_like</code> 中使用 <code>%</code> 運算子，比對任意長度（零個或多個字元）的字串"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>結果排序規則</em><br>選填欄位<br>可使用與 <code>filters</code> 陣列相同的值對結果排序<br>可能的排序類型：<br><code>asc</code> - 結果將依遞增順序排列<br><code>desc</code> - 結果將依遞減順序排列<br>使用逗號作為分隔符號<br>範例：<br><code>[\"metrics.organic.pos_1,desc\"]</code><br>預設規則：<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>請注意，單次請求中最多可設定三條排序規則</strong><br>應使用逗號分隔多條排序規則<br>範例：<br><code>[\"expiration_datetime,asc\",\"metrics.organic.etv,desc\",\"metrics.organic.pos_1,desc\"]</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>使用者自訂任務識別碼</em><br>選填欄位<br><em>字元數上限為 255</em><br>可使用此參數識別任務，並將其與結果對應<br>可在回應的 <code>data</code> 物件中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "limit": 2,
            "filters": [
              [
                "epp_status_codes",
                "in",
                [
                  "client_transfer_prohibited",
                  "client_update_prohibited"
                ]
              ]
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "limit": 2,
      "filters": [
        [
          "epp_status_codes",
          "in",
          [
            "client_transfer_prohibited",
            "client_update_prohibited"
          ]
        ]
      ]
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo"
    }
  ]
}
```

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BacklinksInfo

`#/components/schemas/Response36Afe1097B20_BacklinksInfo`

```json
{
  "type": "object",
  "properties": {
    "referring_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均引薦網域數量</em>",
      "format": "int64"
    },
    "referring_main_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均引薦主網域數量</em>",
      "format": "int64"
    },
    "referring_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均引薦頁面數量</em>",
      "format": "int64"
    },
    "dofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均 dofollow 連結數</em>",
      "format": "int64"
    },
    "backlinks": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均反向連結數</em>",
      "format": "int64"
    },
    "time_update": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>反向連結資料的更新日期與時間</em><br>            採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”；<br>            範例：<br>            <code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API 的目前版本"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "一般狀態碼\n完整回應碼清單請見此處"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "一般資訊訊息\n完整的一般資訊訊息清單請見此處"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "總執行時間，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任務總費用，美元",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 陣列中的任務數",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 陣列中傳回錯誤的任務數",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "任務識別碼\n我們系統中 UUID 格式的唯一任務識別碼"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "任務的狀態碼\n由 DataForSEO 產生，範圍如下：10000-60000\n完整回應碼清單請見此處"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任務的資訊訊息\n完整的一般資訊訊息清單請見此處"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "執行時間，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任務總費用，美元",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 陣列中的元素數",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 路徑"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "包含你在 POST 請求中指定的相同參數"
    }
  }
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>網域名稱</em>"
    },
    "created_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>註冊日期與時間</em><br>網域首次註冊的日期與時間（採用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>） <br>範例： <br><code>\"1997-03-29 03:00:00 +00:00\"</code>"
    },
    "changed_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>網域項目變更的日期與時間</em><br>網域項目上次修改的日期與時間（採用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>）<br>範例： <br><code>\"2021-01-14 08:36:28 +00:00\"</code>"
    },
    "expiration_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>網域到期的日期與時間</em><br>網域到期時間的日期與時間（採用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>） <br>範例： <br><code>\"2022-11-26 17:21:23 +00:00\"</code>"
    },
    "updated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>網域更新的日期與時間</em><br>網域上次更新的日期與時間（採用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>） <br>範例： <br><code>\"2021-01-29 13:59:38 +00:00\"</code>"
    },
    "first_seen": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>我們的檢索器首次發現該網域的日期與時間</em><br>採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>範例： <br><code>\"2019-11-15 12:57:46 +00:00\"</code>"
    },
    "epp_status_codes": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>可擴充佈建協定狀態代碼</em><br>網域名稱註冊狀態，<a href=\"https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en\" rel=\"noopener noreferrer\" target=\"_blank\">如 ICANN 所定義</a>"
    },
    "tld": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>頂層網域</em><br><a href=\"https://www.iana.org/domains/root/db\" rel=\"noopener noreferrer\" target=\"_blank\">DNS 根區</a>中的頂層網域"
    },
    "registered": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>網域註冊狀態</em><br>若為 <code>false</code>，網域名稱註冊已過期<br><strong>注意：過期網域只會在資料庫中保留很短的時間</strong>"
    },
    "registrar": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>網域註冊商</em><br>若為 <code>null</code>，則網域註冊商未知<br>範例：<br><code>NameCheap, Inc.</code>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MetricsBundleInfo"
        }
      ],
      "description": "<em>與指定網域相關的排名資料</em>"
    },
    "backlinks_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksInfo"
        }
      ],
      "description": "<em>傳回網域的反向連結資料</em>"
    }
  },
  "description": "項目陣列"
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo"
              }
            ]
          },
          "description": "<em>任務陣列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>我們資料庫中與你的請求相關的結果總數</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><code>items</code> 陣列中傳回的結果數</em>",
      "format": "int64"
    },
    "offset": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em> POST 請求中指定的結果位移值</em>"
    },
    "offset_token": {
      "type": [
        "string",
        "null"
      ]
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem"
          }
        ]
      },
      "description": "<em>包含排名與流量資料</em>"
    }
  }
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo"
              }
            ]
          },
          "description": "<em>結果陣列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_MetricsBundleInfo

`#/components/schemas/Response36Afe1097B20_MetricsBundleInfo`

```json
{
  "type": "object",
  "properties": {
    "organic": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MetricsInfo"
        }
      ],
      "properties": {
        "is_new": {
          "type": [
            "integer",
            "null"
          ],
          "description": "新增排名元素數量\n表示該網域新增的排名元素數量",
          "format": "int64"
        },
        "is_up": {
          "type": [
            "integer",
            "null"
          ],
          "description": "排名上升\n表示該網域在 Google 搜尋中排名上升的元素數量",
          "format": "int64"
        },
        "is_down": {
          "type": [
            "integer",
            "null"
          ],
          "description": "排名下降\n表示該網域在 Google 搜尋中排名下降的元素數量",
          "format": "int64"
        },
        "is_lost": {
          "type": [
            "integer",
            "null"
          ],
          "description": "遺失的排名元素\n表示該網域先前出現於 SERP 中，但最近一次檢查時未找到的排名元素數量",
          "format": "int64"
        }
      },
      "description": "<em>自然搜尋的排名與流量資料</em>"
    },
    "paid": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MetricsInfo"
        }
      ],
      "description": "<em>付費搜尋的排名與流量資料</em>"
    }
  }
}
```

### Response36Afe1097B20_MetricsInfo

`#/components/schemas/Response36Afe1097B20_MetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 1 的自然 SERP 數量</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 2-3 的自然 SERP 數量</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 4-10 的自然 SERP 數量</em>"
    },
    "pos_11_20": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 11-20 的自然 SERP 數量</em>"
    },
    "pos_21_30": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 21-30 的自然 SERP 數量</em>"
    },
    "pos_31_40": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 31-40 的自然 SERP 數量</em>"
    },
    "pos_41_50": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 41-50 的自然 SERP 數量</em>"
    },
    "pos_51_60": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 51-60 的自然 SERP 數量</em>"
    },
    "pos_61_70": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 61-70 的自然 SERP 數量</em>"
    },
    "pos_71_80": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 71-80 的自然 SERP 數量</em>"
    },
    "pos_81_90": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 81-90 的自然 SERP 數量</em>"
    },
    "pos_91_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>該網域排名第 91-100 的自然 SERP 數量</em>"
    },
    "etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>預估流量</em><br>該網域的預估自然搜尋月流量<br>由該網域排名的所有關鍵字的 CTR（點擊率）與搜尋量乘積計算得出<br>如需瞭解該指標的計算方式，請參閱<a href=\"https://dataforseo.com/help-center/how-is-etv-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">這篇說明中心文章</a>"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>包含該網域的自然 SERP 總數</em>",
      "format": "int64"
    },
    "estimated_paid_traffic_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>將自然搜尋流量轉換為付費流量的預估成本</em><br>表示該網域排名所有關鍵字的廣告投放預估每月成本（美元）<br>此指標依自然搜尋 <code>etv</code> 與付費 <code>cpc</code> 值的乘積計算，表示透過 Google 搜尋中的 PPC 廣告取得預估每月自然流量的成本<br>在<a href=\"https://dataforseo.com/help-center/how-is-traffic-cost-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">這篇說明中心文章</a>中進一步瞭解此指標的計算方式"
    },
    "is_new": {
      "type": [
        "integer",
        "null"
      ],
      "description": "新增排名元素數量\n表示該網域新增的排名元素數量",
      "format": "int64"
    },
    "is_up": {
      "type": [
        "integer",
        "null"
      ],
      "description": "排名上升\n表示該網域在 Google 搜尋中排名上升的元素數量",
      "format": "int64"
    },
    "is_down": {
      "type": [
        "integer",
        "null"
      ],
      "description": "排名下降\n表示該網域在 Google 搜尋中排名下降的元素數量",
      "format": "int64"
    },
    "is_lost": {
      "type": [
        "integer",
        "null"
      ],
      "description": "遺失的排名元素\n表示該網域先前出現於 SERP 中，但最近一次檢查時未找到的排名元素數量",
      "format": "int64"
    }
  }
}
```
