指标视图列表

接口描述

本接口用于实现依据关键词对指标视图列表进行模糊匹配搜索的功能。

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/analysisview/list

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

请求方式

公共请求参数(HEADERS)

参数	类型	是否必选	最大长度	描述
tenant-id	String	是	32	租户ID，用于指标查询内容所在的租户
auth-type	String	是	32	认证方式，用于设置身份认证方式 UID：使用 UID 进行身份认证TOKEN：使用 TOKEN 进行身份认证
auth-value	String	是	32	UID或者TOKEN值，与auth-type 类型选择一致

公共参数获取方式

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

请求参数

参数	类型	是否必选	最大长度	描述
keyword	String	否	32	指标视图名称关键字，如果不传，则查询所有的
pageNumber	Integer	否		要请求的页码，从1开始，如果没传，默认是第一页
pageSize	Integer	否		每页的记录数，默认20

响应参数

响应参数说明

参数	类型	是否必选	最大长度	描述
code	String	是	32	接口响应码
message	String	是	512	消息体
traceId	String	是	128	跟踪ID，用于问题排查
data	object	是		结果数据，具体参数详情参见：4.1 data 参数说明

data参数说明

参数	类型	是否必选	最大长度	描述
pageNumber	Integer	是		当前页码
pageSize	Integer	是		每页条数
totalPageSize	Integer	是		总条数
data	Array[Object]	是		当前页数据。具体参数详情参见：4.2data 参数详情

data 参数说明

参数	类型	是否必选	最大长度	描述
id	Integer	是		指标视图id
viewName	String	是	50	指标视图名称
displayName	String	是		指标视图展示名
description	String	否	300	指标视图描述
metrics	Array[String]	是		指标列表
dimensions	Array[String]	否		维度列表
filters	Array[String]	否		筛选器
time_constraint	String	否		日期范围
orders	Array[String]	否		查询的排序规则。引用的维度需要包含在“dimensions”参数中。

请求示例

http://127.0.0.1/anymetrics/api/v1/analysisview/list?keyword=order&pageNumber=1&pageSize=20

响应示例

{
    "code": "200",
    "message": "请求成功",
    "traceId": "fdde6861bd554805998343f9ff2dcd70.292.16857691758642861",
    "data": {
        "pageNumber": 1,
        "pageSize": 20,
        "total": 50,
        "data": [
            {
                "id": 1,
                "viewName": "OrderAnalysisView2",
                "description": "订单指标视图2",
                "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"
                    }
                ]
            }
        ]
    }
}