跳转至

概述

Aloudata CAN 平台面向开发者提供了详尽的 API 服务接口,主要包含访问凭据管理、指标查询、指标多维归因、维度管理、指标管理、指标/维度类目管理、分析视图管理等。

用户&租户管理

API 标题 API 概述
用户注册 本接口用于向指标平台新增用户
租户注册 本接口用于实现在指标平台中新增租户
添加用户到租户 本接口用于将用户绑定到租户

数据源管理

API 标题 API 概述
数据源注册 本接口用于向指标平台添加数据源

权限管理

API 标题 API 概述
授权 本接口用于在指标平台中为用户添加指定权限

访问凭证管理

认证令牌操作:支持获取、撤销访问令牌及按用户名检索密钥对(Access Key & Secret Key)。

API 标题 API 概述
获取访问凭证 本接口用于向指标平台申请接口访问授权凭证(Token)
删除访问凭证 本接口用于实现对现存访问令牌的主动注销操作
根据用户获取访问密钥 本接口用于根据指定的用户名,检索与该用户账户关联的访问密钥

指标查询

API 标题 API 概述
指标数据查询 本接口用于使用指标和维度组合,查询指定的指标计算结果。

维度管理

维度实体操作:涵盖维度创建、编辑、删除、详情查询、列表浏览及维指预览功能。

API 标题 API 概述
创建维度 本接口用于在指标平台上创建新的维度信息
修改维度 本接口用于实现对指定维度元数据的更新操作
删除维度 本接口用于实现维度的删除操作
查询维度详情 本接口用于获取指定维度的详细信息
查询维度列表 本接口用于获取指定条件下的维度列表信息
获取维度值 本接口用于预览指定维度的取值情况

指标管理

指标管理:实现新指标创建、删除、调整,提供指标数据检索、列表查询(含树状结构展示)、维度兼容性检查及单个或批量指标详情查询。

API 标题 API 概述
新建指标 本接口适用于在指标管理系统中新建指标
修改指标 本接口用于实现对指定指标元数据的更新操作
删除指标 本接口用于实现指标的删除操作
查询指标列表 本接口用于获取某个租户下所有的指标列表
指标列表查询-树状结构 本接口是用于获取树状结构的指标列表
指标可用维度查询 本接口用于查询某个指标可用的维度,以及多个指标的可用维度(交集)
指标可用维度全量查询 本接口用于查询某个指标或者一组指标的可用维度
单个指标详情查询 本接口适用于查询指标的详情
批量指标详情查询 本接口是批量查询指标详情

指标/维度类目管理

指标/维度类目维护功能:涵盖指标/维度类目的新增、修改、删除及目录汇总展示。

API 标题 API 概述
创建类目 本接口用于在指标平台中新建指标类目或维度类目
修改类目 本接口用于在指标平台中修改指标类目或维度类目
删除类目 本接口用于在指标平台中删除指标类目或维度类目
类目列表 本接口用于展示指定类型的类目列表

指标视图管理

分析视图管理:允许用户创建、删除、编辑分析视图,查询视图详情与列表(含树状结构展示),通过ID检索特定视图详情。

API 标题 API 概述
创建指标视图 本接口适用于在指标管理系统中新建指标视图
修改指标视图 本接口用于实现对指定指标视图的更新操作
删除指标视图 本接口用于实现指标视图的删除操作
指标视图列表 本接口用于实现依据关键词对指标视图列表进行模糊匹配搜索的功能
指标视图详情查询 本接口适用于获取指标指标视图的配置信息
指标视图结果查询 本接口用于获取指标指标视图的结果集
指标视图列表树状结构 本接口是用于获取树状结构的指标视图列表
根据 ID 查询指标视图详情 本接口适用于根据 ID 查询指标视图

指标归因分析

多维度归因分析:提供指标多维归因下钻分析、查询验证机制及复合归因分析能力。

API 标题 API 概述
指标树归因分析查询 本接口是针对指标以树解耦对其进行归因分析报告查询
指标多维归因分析查询 本接口是针对指标以及维度进行多维归因结果的查询
指标多维归因分析查询校验 本接口用于校验指标是否能够进行指标的归因分析
指标多维归因分析下钻查询 本接口是针对指标以及维度进行多维归因结果的查询

指标加速(结果加速)

API 标题 API 概述
新建加速 本接口用于在 Aloudata CAN 平台上创建应用加速。
回补数据 本接口用于在 Aloudata CAN 平台上创建应用加速方案回刷数据任务
查看加速详情 本接口用于在 Aloudata CAN 平台上查看应用加速详情。
查询更新状态 本接口用于在 Aloudata CAN 平台上查看物化表的最新刷新时间和数据日期。

加速数据更新

数据更新:使用 API 的方式对数据集下游物化表进行数据更新。

API 标题 API 概述
数据更新 本接口用于更新该表相关物化表数据