Skip to content

API 查询数据集

API 查询数据集是指通过 API 查询将一个 HTTP 的 JSON API 转化成一个数据集。

创建数据集

请参照如下步骤创建 API 查询数据集。

创建入口

在数据集界面,点击新建数据集,选择 API 查询 。

API 支持的请求配置

请求方法支持 GET 或者 POST。

  1. 请求 Header,通过配置 Header,可以传递自定义 HTTP 请求中的请求头,例如常用的可以将Content-Type 配置为application/json,或者通过配置 AuthorizationBasic SOME-BASE64来支持一些简单的认证功能。

  1. 查询参数,一般用来指定查询的对象或者配置翻页。例如某些接口通过?compainId=123来指定活动 ID,也可以结合下面的翻页配置来实现翻页的功能,例如某一个接口支持?page=1这样的方式来翻页,就可以结合分页设置中指定的分页参数 PAGE 来实现翻页,定义 ?page={{$PAGE}} 就可以了。

  1. 请求 Body 的定义,和查询参数类似,也可以指定具体的查询需要传递的请求体。

  1. 分页设置,支持2种分页方式,按照页数的分页方式?page=1&n=10 ,按照偏移量翻页的方式offset=20&limit=10

  1. 认证方式支持 Basic 的用户名密码认证,或者 OAuth2的认证授权码模式。

JSON 字段拆分

数据获取配置完成之后,需要进行 JSON 解析的配置,JSON 解析的语法和 JSON 拆分功能的语法保持一致,支持拆分一级 JSON,每个拆分的自动都需要有一个别名,别名不允许重复,拆分的字段类型只支持数字,文本和时间这几种类型。

字段拆分配置完成之后,可以预览第一页的拆分结果,如果拆分结果不符合预期可以返回上一页修改字段拆分配置。如果符合预期则可以直接保存为一个数据集。

默认 API 数据集是没有导入引擎的,如果需要进行计算分析的话,可以在创建数据集时或者修改数据集设置为导入引擎,并配置更新计划。

衡石分析平台使用手册