# 设置实时“DataForSEO 搜索量”任务

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live`

**Tags:** DataForSEO

针对一组 `keywords`，从点击流面板而非广告平台推导的搜索量。`use_clickstream` 用于切换混合比例。返回 `location_code`、`language_code`、`use_clickstream`、`items_count` 和 `items`。采用 DataForSEO 的信封结构：数据位于 `tasks[0].result`，结果状态位于 `tasks[0].status_code`——被拒绝的请求仍会返回 HTTP 200。点击流搜索量常与 `post_dataforseo_keywords_gads_search_volume_live` 不一致，而这正是重点：一个衡量广告主看到的结果，另一个衡量人们实际做了什么。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：0.09 美元。
- 参考客户倍率：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>UTF-8 编码<br>此数组中可指定的关键词数量上限：1000<br>关键词将转换为小写格式<p><strong>注意：</strong>不允许使用某些符号和字符（例如 UTF 符号、表情符号）<br>如需了解可以使用哪些符号和字符，请参阅<a href=\"https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task\" target=\"_blank\" rel=\"noopener noreferrer\">这篇文章</a><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>可单独向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/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>如果使用此字段，可单独向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> 发起请求，获取带 <code>location_code</code> 的可用地点列表<br>示例：<br><code class=\"long-string\">2826</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>搜索引擎语言全名</em><br><strong>未指定 <code>language_code</code> 时为必填字段</strong><br>可单独向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> 发起请求，获取可用语言及其 <code>language_name</code> 列表<br>示例：<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>搜索引擎语言代码</em><br><strong>未指定 <code>language_name</code> 时为必填字段</strong><br>可单独向 <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code> 发起请求，获取可用语言及其 <code>language_code</code> 列表<br>示例：<br><code class=\"long-string\">en</code>"
          },
          "use_clickstream": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>使用点击流数据提供结果</em><br>可选字段<br>如果设置为 <code>true</code>，你将获得基于点击流数据的 DataForSEO 搜索量值；<br>如果设置为 <code>false</code>，将使用 Bing 搜索量数据计算 DataForSEO 搜索量；<br>默认值：<code>true</code>；<br><strong>注意：</strong>Bing 搜索量仅适用于 <a href=\"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">Bing Search Volume History Locations</a> 和 <a href=\"https://docs.dataforseo.com/v3/keywords_data/bing/locations/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">Bing Ads Locations</a> 端点中提供的地点；即使将此参数设置为 <code>false</code>，其他任何地点的搜索量值仍将基于点击流数据计算"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "location_code": 2840,
            "language_code": "en",
            "tag": "test-tag",
            "keywords": [
              "you tube",
              "youtube",
              "youtub"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_code": 2840,
      "language_code": "en",
      "tag": "test-tag",
      "keywords": [
        "you tube",
        "youtube",
        "youtub"
      ]
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

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

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

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo`

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

### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 数组中的地点代码</em><br>若没有数据，则该值为 <code>null</code>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的语言代码<br></em><br><strong>注意：</strong>如果 POST 数组中的关键词拼写有误，将返回拼写正确的关键词的数据；<br>我们使用 Google Ads API 的功能来检查和验证关键词拼写，<a href=\"https://support.google.com/google-ads/answer/7476658\" target=\"_blank\" rel=\"noopener noreferrer\">通过此链接了解更多</a>"
    },
    "use_clickstream": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>表示 <code>use_clickstream</code> 参数是否启用</em><br>可能的值：<code>true</code>、<code>false</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>返回在 <code>items</code> 数组中的结果数</em>"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem"
          }
        ]
      },
      "description": "<em>关键词数组</em><br>包含关键词及其搜索量"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo`

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

### Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中提供的关键词</em>"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>关键词的当前搜索量</em>",
      "format": "int64"
    },
    "monthly_searches": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
          }
        ]
      },
      "description": "<em>每月搜索量</em><br>对象数组，包含一年中某个月的搜索量"
    }
  }
}
```

### Response36Afe1097B20_MonthlySearchesInfo

`#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo`

```json
{
  "type": "object",
  "properties": {
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "年"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "月"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "每月平均搜索量"
    }
  }
}
```