创建指标视图

接口描述

本接口用于实现指标视图的创建功能，为用户提供自定义的数据分析界面配置能力。用户能够定义包含特定指标、维度、筛选条件及排序规则的指标视图。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/analysisview/create

anymetrics_host:anymetrics_port 获取方式请参考：调用方式

请求参数

公共请求参数(HEADERS)

参数	类型	是否必选	最大长度	描述
tenant-id	String	是	32	租户ID，用于指标查询内容所在的租户
auth-type	String	是	32	认证方式支持：UID（基于用户ID认证）TOKEN（基于令牌认证）。
auth-value	String	是	32	与选定的auth-type相对应的认证值。

公共参数获取方式

tenant-id 与 auth-value：在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

请求参数

参数	类型	是否必选	最大长度	描述
viewName	String	是	50	视图名称用于定义指标视图的名称
description	String	否	300	指标视图描述
displayName	String	是		指标视图展示名
metrics	Array[String]	是		指标名称
dimensions	Array[String]	否		维度名称
filters	Array[String]	否		维度筛选表达式
time_constraint	String	否		日期范围表达式
orders	Array[String]	否		排序规则

响应参数

参数	类型	是否必选	最大长度	描述
code	String	是	32	接口响应码
message	String	是	512	消息体
traceId	String	是	128	跟踪ID，用于问题排查
data	Boolean	是		操作结果

请求示例

{
    "viewName": "OrderAnalysisView",
    "description": "订单指标视图",
    "metrics": ["orderCount"],
    "dimensions": ["stories.category"],
    "filters": [{"name": "stories.isDraft", "operator": "=", "values": ["No"]}],
    "time_constraint": "BETWEEN 2023-01-01 AND 2023-01-10",
    "orders": [{"stories.time": "asc"}, {"stories.count": "desc"}]
}

响应示例

json复制代码{
    "code": "200",
    "message": "请求成功",
    "traceId": "fdde6861bd554805998343f9ff2dcd70.292.16857691758642861",
    "data": true
}