基础地址
BaseURL:https://api-datahub.bazhuayu.com
/v1 契约只增不改:新增字段和新增端点会随版本演进出现,已发布的字段不会改名或改语义。集成时忽略未知字段即可,不要依赖字段顺序。认证
需要身份的端点使用标准 Bearer 认证,把 DataHub API Key 放在Authorization 请求头中:
响应结构
成功响应统一包在data 字段里;错误响应统一包在 error 字段里,两者不会同时出现。
错误
各端点页的「错误」一节列出该端点特有的错误码。以下几条在多数端点都可能出现:
「不存在」与「不可见」返回相同的
404,是平台的一贯做法:私有 App、他人的运行、他人的数据集都不会通过错误码泄露存在性。
分页
列表类端点统一使用offset / limit 查询参数,响应中带 pagination 对象:
total 是筛选条件下的总条数,has_more 为 true 时把 offset 加上 count 继续读取。各端点的 limit 上限见各自说明。
时间参数
涉及时间范围的端点(运行列表、账单聚合、发布者分析等)共用同一套词汇:created_from:起点,包含。created_to:终点,不包含。- 两者都是 ISO-8601 绝对时间,例如
2026-09-01T00:00:00Z或2026-09-01T08:00:00+08:00。放进 URL 时+要编码为%2B。 - 一次运行归属到它的发起时间,与结束时间无关。
tz_offset 参数(分钟,相对 UTC,北京时间为 480),它只影响一次运行落到哪一天,不改变金额和范围本身。
App 的引用方式
凡是需要指定 App 的地方(路径中的{app_id}、筛选参数 data_app)都接受两种形式:
<namespace>/<app_name>:发布者用户名加应用名,人类可读,发布者或应用改名后失效。app_id:形如app_<hex>的稳定标识,改名不受影响。
app_id。
运行状态
端点分组
发现 Data App
搜索、详情、版本、README、规范与译文读取。
运行与结果
发起、查询、列表、取消、读取记录、调试留痕。
数据集
运行结果的持久化容器与保留标记。
账户与账单
累计消费与按时段、维度聚合的账单。
凭证密钥
App 作者为自己的 App 存放上游凭证。
发布与运营
草稿、Build、Release 三步链,运营开关、分享、译文、契约工具与发布者分析。
