跳转到主要内容
将您的 API Key 粘贴到授权字段。要获取 API Key，请创建账户并了解如何生成 API Key。

​
一般描述

  • 此端点用于获取特定数据集的详细元数据。
  • 元数据包括可用字段、数据类型以及字段说明。
  • 使用此端点可在查询或下载数据集之前了解其结构。

​
请求

​
端点


GET [http://api.brightdata.com/datasets/{dataset_id}/metadata](http://api.brightdata.com/datasets/{dataset_id}/metadata)

​
路径参数

参数类型描述
dataset_idstring数据集的唯一标识符

​
请求头

Header类型描述
Authorizationstring用于认证的 API Key

​
响应

​
响应示例

{
    "id": "gd_l1vijqt9jfj7olije",
    "fields": {
        "name": {
            "type": "text",
            "active": true,
            "description": "公司名称"
        },
        "url": {
            "type": "url",
            "required": true,
            "description": "与公司关联的 URL 或网页地址"
        },
        "cb_rank": {
            "type": "number",
            "description": "公司在 Crunchbase 的排名"
        }
    }
}

​
响应字段

字段类型描述
idstring数据集的唯一标识符
fieldsobject包含数据集中每个字段的元数据

​
字段元数据

fields 对象中的每个字段包含以下属性：
属性类型描述
typestring字段的数据类型（例如，text、number、url）
activeboolean指示字段当前是否激活
requiredboolean指示字段是否为必填（如适用）
descriptionstring字段的简要描述

​
示例用例

​
获取数据集元数据

要获取 “Crunchbase companies information” 数据集的元数据：

​
请求

GET http://api.brightdata.com/datasets/gd_l1vijqt9jfj7olije/metadata

​
响应

{
    "id": "gd_l1vijqt9jfj7olije",
    "fields": {
        "name": {
            "type": "text",
            "active": true,
            "description": "公司名称"
        },
        "url": {
            "type": "url",
            "required": true,
            "description": "与公司关联的 URL 或网页地址"
        },
        "cb_rank": {
            "type": "number",
            "description": "公司在 Crunchbase 的排名"
        }
    }
}

​
故障排除与常见问题

​
问题: “Unauthorized” 响应

解决方案：确保请求头中包含有效的 API Key。

​
问题: “Dataset not found”

解决方案：确认 dataset_id 是否正确，并且存在于数据集列表中。

​
问题: “Field missing in metadata”

解决方案：某些字段可能对特定数据集处于非激活状态或不可用。

​
相关文档