# 设置实时“批量点击流搜索量”任务

**API:** Data API

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

**Tags:** DataForSEO

一次调用即可获取多个 `keywords` 的点击流搜索量，不含语言维度。采用 DataForSEO 的信封结构：数据位于 `tasks[0].result`，结果状态位于 `tasks[0].status_code`——被拒绝的请求仍会返回 HTTP 200。按关键词并带语言的版本是 `post_dataforseo_keywords_clickstream_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>每个关键词至少为 3 个字符；<br>关键词将转换为小写格式；<br><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><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <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><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <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\">2840</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,
            "tag": "test-tag",
            "keywords": [
              "you tube",
              "youtube",
              "youtub"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_code": 2840,
      "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_KeywordsDataClickstreamDataBulkSearchVolumeLiveResponseInfo"
    }
  ]
}
```

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

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveResponseInfo`

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

### Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 数组中的位置代码</em>"
    },
    "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_KeywordsDataClickstreamDataSearchVolumeLiveItem"
          }
        ]
      },
      "description": "<em>包含关键词及相关数据</em>"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo`

```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_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo"
              }
            ]
          },
          "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": "每月平均搜索量"
    }
  }
}
```