# 網域排名概覽

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/google/domain_rank_overview/live`

**Tags:** DataForSEO

某個網域依 `location_code` 的搜尋覆蓋：自然與付費關鍵字數、估算流量與流量價值。傳回 `se_type`、`target`、`total_count`、`items_count` 與 `items`。採用 DataForSEO 的信封結構：資料位於 `tasks[0].result`，結果狀態位於 `tasks[0].status_code`——被拒絕的請求仍會傳回 HTTP 200。若要看同樣的數字隨時間的變化，請使用 `post_dataforseo_labs_google_historical_rank_live`；若要一次查看多個網域，請使用 `post_dataforseo_labs_google_bulk_traffic_estimation_live`。

### 計費參考

- 計量方式：依回報的回應成本計量。
- 參考請求估算：0.0121 美元。
- 參考客戶倍率：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": {
          "target": {
            "type": "string",
            "description": "<em>網域</em><br><strong>必填欄位</strong><br>目標網站的網域名稱<br>網域不需包含 <code>https://</code> 與 <code>www.</code>"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>地點全名</em><br>選填欄位<br>如果使用此欄位，則無需指定 <code>location_code</code><br>可個別向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 發出請求，取得可用地點及其 <code>location_name</code> 的清單<br>忽略此欄位可取得所有可用地點的結果<br>範例：<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>地點代碼</em><br>選填欄位<br>如果使用此欄位，則無需指定 <code>location_name</code><br>可個別向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 發出請求，取得可用地點及其 <code>location_code</code> 的清單<br>忽略此欄位可取得所有可用地點的結果<br>範例：<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>語言全名</em><br>選填欄位<br>如果使用此欄位，則無需指定 <code>language_code</code><br>可個別向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 發出請求，取得可用語言及其 <code>language_name</code> 的清單<br>忽略此欄位可取得所有可用語言的結果<br>範例：<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>語言代碼</em><br>選填欄位<br>如果使用此欄位，則無需指定 <code>language_name</code><br>可個別向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 發出請求，取得可用語言及其 <code>language_code</code> 的清單<br>忽略此欄位可取得所有可用語言的結果<br>範例：<br><code class=\"long-string\">en</code>"
          },
          "ignore_synonyms": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>忽略高度相似的關鍵字</em><br>選填欄位<br>如果設為 <code class=\"prettyprint\">true</code>，所有高度相似的關鍵字都將從排名與流量計算中排除，結果將以同義詞群組中的主關鍵字資料為基礎<br>預設值：<code>false</code>"
          },
          "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> 將被省略，資料會從後續項目開始提供"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>使用者自訂任務識別碼</em><br>選填欄位<br><em>字元數上限為 255</em><br>可使用此參數識別任務，並將其與結果對應<br>可在回應的 <code>data</code> 物件中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "target": "dataforseo.com",
            "language_name": "English",
            "location_code": 2840
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "language_name": "English",
      "location_code": 2840
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### 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_DataforseoLabsGoogleDomainRankOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜尋引擎類型</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 陣列中的位置代碼</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 陣列中的語言代碼</em>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo"
      },
      "description": "<em>與指定網域相關的排名資料</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo`

```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_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo"
              }
            ]
          },
          "description": "<em>任務陣列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜尋引擎類型</em>"
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 陣列中的目標網域</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 陣列中的位置代碼</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 陣列中的語言代碼</em>"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>我們資料庫中與你的請求相關的結果總數</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><code>items</code> 陣列中傳回的結果數</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveItem"
          }
        ]
      },
      "description": "<em>包含排名與流量資料</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo`

```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_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo"
              }
            ]
          },
          "description": "<em>結果陣列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsMetricsInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo`

```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": "<em>新增排名元素數量</em><br>表示指定目標找到多少個新的排名元素"
    },
    "is_up": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>排名上升</em><br>表示指定目標有多少排名元素上升"
    },
    "is_down": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>排名下降</em><br>表示指定目標有多少排名元素下降"
    },
    "is_lost": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>遺失的排名元素</em><br>表示指定目標有多少排名元素先前出現於 SERP 中，但於上次檢查時未找到"
    },
    "clickstream_etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>以點擊流資料為基礎的預估流量</em><br>由網域所排名之所有關鍵字的點擊率（CTR）與點擊流搜尋量值的乘積計算<br>若要取得此欄位的結果，參數 <code>include_clickstream_data</code> 必須設為 <code>true</code><br>如需瞭解該指標的計算方式，請參閱<a href=\"https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">這篇說明中心文章</a>",
      "format": "double"
    },
    "clickstream_gender_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>依性別劃分的預估點擊流指標分佈</em><br>若要取得此欄位的結果，參數 <code>include_clickstream_data</code> 必須設為 <code>true</code><br>如需瞭解該指標的計算方式，請參閱<a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">這篇說明中心文章</a>"
    },
    "clickstream_age_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>依年齡劃分、以點擊流為基礎的指標分佈</em><br>若要取得此欄位的結果，參數 <code>include_clickstream_data</code> 必須設為 <code>true</code><br>如需瞭解該指標的計算方式，請參閱<a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">這篇說明中心文章</a>"
    }
  }
}
```
