指标API功能,需要在包含"指标平台"产品时才支持该功能,旨在将指标创建为API,实现下游应用系统指标数据查询的业务场景需求,补齐产品短板,增强产品能力。

指标API在获取数据时与新建API存在差异,当指标API创建完成后,支持复用其他功能,包括复制、API升级、锁定、版本历史管理(暂不支持下载pdf或者excel文件)等功能。

新建标签画像API

在新建下拉中选择"指标API"进入API创建页面。

指标API - 图1

配置基础信息

第一步需要配置指标API的基础信息,包括类型、名称、请求方式等。

指标API - 图2

除API类型外,其他字段内容同"新建API"流程,包括API协助管理者、传输加密等字段均通用。

配置参数

第二步需要选择当前项目下的指标,用来配置参数信息。

若在第一步选择的API类型是"单指标API",则仅需选择指标;若在第一步选择的API类型是"汇总指标API",则需选择模型、维度、指标。

指标API - 图3

配置返回和排序参数以及配置查询条件,交互方式同"新建API",从弹窗中选择对应指标/维度作为参数即可。

指标API - 图4

测试API

指标API基本信息和参数配置完成之后,第三步可以对API进行在线测试,测试步骤同"新建API"流程。

指标API - 图5

指标API其他功能

指标API创建成功之后,发布、上线、绑定应用授权、复制、锁定、查看版本历史(下载word或者excel暂不支持标签画像API)等操作同 新建API