# SERP 竞争对手

**API:** Data API

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

**Tags:** DataForSEO

与你在一组 `keywords` 上共同获得排名的域名，以及它们与你共享多少个关键词。返回 `se_type`、`seed_keywords`、`total_count`、`items_count` 和 `items`。采用 DataForSEO 的信封结构：数据位于 `tasks[0].result`，结果状态位于 `tasks[0].status_code`——被拒绝的请求仍会返回 HTTP 200。⚠️ 这些是**搜索**竞争对手，由共同的排名决定。链接图谱中的对应端点是 `post_dataforseo_backlinks_competitors_live`，两份列表常常不一致——这本身就很有参考价值。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：0.0192 美元。
- 参考客户倍率：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": {
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "<em>关键词数组</em><br><strong>必填字段</strong><br>结果将基于你在此数组中指定的关键词<br>UTF-8 编码；<br>关键词将转换为小写格式；<br><strong>最多可指定 200 个关键词</strong><p>有关 DataForSEO API 中 <code>keyword</code> 和 <code>keywords</code> 字段的规则与限制，请参阅这篇 <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">帮助中心文章</a>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>地点全名</em><br><strong>未指定 <code>location_code</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_name</code> 参数的列表<br>示例：<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>地点唯一标识符</em><br><strong>未指定 <code>location_name</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_code</code> 参数的列表<br>示例：<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>语言全名</em><br><strong>未指定 <code>language_code</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>language_name</code> 或 <code>language_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用语言及其 <code>language_name</code> 参数的列表<br>示例：<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>语言唯一标识符</em><br><strong>未指定 <code>language_name</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>language_name</code> 或 <code>language_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用语言及其 <code>language_code</code> 参数的列表<br>示例：<br><code class=\"long-string\">en</code>"
          },
          "include_subdomains": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>指示搜索中是否包含子域名</em><br>可选字段<br>如果设为 <code>false</code>，子域名将被忽略<br>默认值：<code>true</code>"
          },
          "item_types": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>搜索结果类型</em><br>指示响应中包含的搜索结果类型<br>可选字段<p>可能的值： <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>默认值： <br><code>[\"organic\", \"paid\"]</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>，结果数组中的前十个域名将被跳过，并返回后续域名的数据"
          },
          "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>not_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>match</code>、<code>not_match</code>、<code>ilike</code>、<code>not_ilike</code>、<code>like</code>、<code>not_like</code><br>可在 <code>like</code> 和 <code>not_like</code> 以及 <code>ilike</code> 和 <code>not_ilike</code> 中使用 <code>%</code> 运算符，匹配任意长度（零个或多个字符）的字符串<br>示例：<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\"&gt;\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>有关筛选条件的更多信息，请参阅 <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> 或这篇 <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">帮助中心指南</a>"
          },
          "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>[\"avg_position,asc\"]</code><br>默认规则：<br><code>[\"rating,desc\"]</code><br><strong>注意，单次请求中最多可设置三条排序规则</strong><br>应使用逗号分隔多条排序规则<br>示例：<br><code>[\"avg_position,asc\",\"etv,desc\"]</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "keywords": [
              "phone"
            ],
            "language_name": "English",
            "location_code": 2840,
            "item_types": [
              "organic"
            ],
            "limit": 5
          }
        ]
      }
    ]
  },
  "example": [
    {
      "keywords": [
        "phone"
      ],
      "language_name": "English",
      "location_code": 2840,
      "item_types": [
        "organic"
      ],
      "limit": 5
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

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

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

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜索引擎类型</em>"
    },
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>检测到的 SERP 竞品的域名</em>"
    },
    "avg_position": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>域名在指定关键词上的平均位置</em><br><code>keywords_positions</code> 数组中值的算术平均值",
      "format": "float"
    },
    "median_position": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>域名在指定关键词上的中位数位置</em><br><code>keywords_positions</code> 数组中值的中位数"
    },
    "rating": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>最大可能关键词位置与实际关键词位置之间的差距</em><br>表示域名在 SERP 中针对指定关键词的相对可见度<br>按 <em>sum(100-<code>keywords_positions</code>)</em> 计算"
    },
    "etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>估算流量</em><br>表示指定关键词为网站带来的估算每月流量<br>按指定关键词的搜索量值与其在 SERP 特定位次上的 CTR（点击率）的乘积之和计算<br>如需了解该指标的计算方式，请参阅<a href=\"https://dataforseo.com/help-center/how-is-etv-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">此帮助中心文章</a>"
    },
    "keywords_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名在 SERP 中拥有位置的指定关键词数量</em>",
      "format": "int64"
    },
    "visibility": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>SERP 可见度</em><br>表示基于指定关键词 SERP 位置的网站可见度<br>位置在 <strong>1 到 10</strong> 范围内的关键词，其可见度指数依次为 1 到 0.1<br>位置在 <strong>11 到 20</strong> 范围内的关键词，可见度指数固定为 0.05<br>位置在 <strong>20 到 100</strong> 的关键词，可见度指数为 0"
    },
    "relevant_serp_items": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>与域名相关的 SERP 元素数量</em><br>表示 SERP 中针对指定关键词与域名相关的搜索结果数量"
    },
    "keywords_positions": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "description": "<em>关键词位置</em><br>相关域名在 SERP 中针对指定关键词所占据的位置"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo`

```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_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜索引擎类型</em>"
    },
    "seed_keywords": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>请求中指定的关键词</em><br><strong>关键词会以解码后的 %## 返回（另外，字符 '+' 会被解码为空格）</strong>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 数组中的地点代码</em><br>若没有数据，则该值为 <code>null</code>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的语言代码</em><br>若没有数据，则该值为 <code>null</code>"
    },
    "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_DataforseoLabsGoogleSerpCompetitorsLiveItem"
          }
        ]
      },
      "description": "<em>包含检测到的 SERP 竞品及相关数据</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo`

```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_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```