目录
此内容是否有帮助?

# 看板报表管理 API

调用方法请参见Open API文档中的调用方法描述。

建议先阅读 TA 使用手册数据看板部分了解相关功能:数据看板

# 一、报表管理

# 查询Root账号的报表列表

接口URL

/open/manage-reports?token=xxx&projectId=0

请求方式

GET

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID

成功响应示例

{
  "data": {
    "reports": [
      {
        "createType": "MANUAL_CREATE",
        "dashboardIds": [],
        "reportDesc": "",
        "reportId": 34214,
        "reportModel": 0,
        "reportName": "event_3的总次数(4)",
        "updateTime": "2021-02-04 16:44:03"
      },
      {
        "createType": "IMPORTED",
        "dashboardIds": [
          3015
        ],
        "reportDesc": "",
        "reportId": 25565,
        "reportModel": 0,
        "reportName": "登陆次数-上月(1)",
        "updateTime": "2020-12-18 14:03:32"
      }
    ],
    "dashboards": [
      {
        "dashbord_id": 3015,
        "dashbord_name": "性能测试"
      }
    ]
  },
  "return_code": 0,
  "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
dashboards -
List
看板信息
dashbord_id 1440
Integer
看板ID
dashbord_name 条件通用筛选看板
String
看板名称
reports -
List
报表信息
createType MANUAL_CREATE
String
报表创建方式:
MANUAL_CREATE:手动创建
IMPORTED:看板导入创建
COPIED:看板复制创建
dashboardIds 2378
Integer
看板ID集合(该报表相关的看板ID列表,为空表明该报表不在任何看板上)
reportDesc -
Object
报表注释
reportId 4049
Integer
报表ID
reportModel 0
Integer
分析模型
0:事件分析
1:留存分析
2:漏斗分析
3:用户属性分析
4:路径分析
5:分布分析
reportName 直指
String
报表名称
updateTime 2019-12-20 15:59:44
Date
更新时间
return_code
0
Integer
返回码
return_message
success
String
返回信息

# 查询项目报表列表

接口URL

/open/list-project-reports?token=xxx&projectId=0

请求方式

GET

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID

成功响应示例

{
    "data": [
        {
            "reportId": 34214,
            "createType": "MANUAL_CREATE",
            "reportDesc": "此处是报表描述",
            "projectId": 0,
            "reportName": "此处是报表名",
            "reportModel": "EVENT",
            "creator": {
                "openId": "UIODASBJ-Jiodas312",
                "loginName": "user1",
                "userName": "用户1"
            },
            "dashboardIds": [
                109,
                91
            ]
        }
    ],
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
List
返回数据
reportId 34214
Long
报表ID
reportName 此处是报表名
Integer
报表名称
reportDesc 此处是报表描述
String
报表描述
projectId 0
Integer
项目ID
createType MANUAL_CREATE
String
报表创建方式:
MANUAL_CREATE:手动创建
IMPORTED:导入创建
COPIED:复制创建
SCENE_CREATE 基于模板创建
PACK_IMPORT 项目导入创建
reportModel EVENT
String
EVENT:事件分析报表
RETENTION: 留存分析报表
FUNNEL: 漏斗分析报表
PROP_ANALYSIS: 属性分析报表
PATH_ANALYSIS :路径分析报表
SQL :SQL报表
INTERVAL_ANALYSIS :间隔分析报表
creator -
Object
报表创建人
openId
UIODASBJ-Jiodas312
String
openId
loginName
user1
String
登录账号
userName
用户1
String
昵称
dashboardIds [109, 91]
List
看板ID
return_code
0
Integer
返回码
return_message
success
String
返回信息

# 批量删除报表

接口URL

/open/report-batch-del?token=xxx&projectId=0

请求方式

POST

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
String

项目ID

请求Body参数

{
    "reportIds": [
        34214
    ]
}
参数名 示例值 参数类型 是否必填 参数描述
reportIds
[34214]
List

报表ID列表

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
String
返回码
return_message
success
String
返回信息

# 二、看板管理

# 看板报表管理/导入看板

接口URL

/open/import-dashboards?token=xxx&projectId=0&dashboardNameConflictPolicy=RENAME_CREATE&spaceDashboardPolicy=IN_EXISTED_SPACE_OR_CREATE_SPACE

请求方式

POST

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
dashboardNameConflictPolicy
RENAME_CREATE
String

看板名称冲突策略,默认取值RENAME_CREATE,
RENAME_CREATE:自动改名
SKIP:跳过
REPLACE:替换
spaceDashboardPolicy
IN_EXISTED_SPACE_OR_CREATE_SPACE
String

共享空间的看板放置策略,默认取值IN_EXISTED_SPACE_OR_CREATE_SPACE
CREATE_SPACE:把看板放在新创建的空间里
IN_EXISTED_SPACE_OR_CREATE_SPACE:把看板放在已经存在的同名空间里或者新创建的空间里
IN_PRIVATE:放在我的看板下

成功响应示例

{
    "data": {
        "boardCreateFailed": 1,
        "boardCreated": 1,
        "boardTotal": 2,
        "folderCreated": 1,
        "reportCreateFailed": 1,
        "reportCreated": 1,
        "reportTotal": 2
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
boardCreateFailed 1
Integer
看板创建失败数量
boardCreated 1
Integer
看板创建成功数量
boardTotal 2
Integer
看板总数
folderCreated 1
Integer
文件夹创建数量
reportCreateFailed 1
Integer
报表创建失败数量
reportCreated 1
Integer
报表创建数量
reportTotal 2
Integer
报表总数
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名 示例值 参数类型 参数描述
return_code
-3004
String
返回码
return_message
无效项目
String
返回信息

# 删除空间看板

注意

如果看板是API调用者创建的,则删除该看板;否则将看板从空间移到创建者的私有目录下。

接口URL

/open/delete-dashboard-from-space?token=xxx&projectId=0&dashboardId=1&spaceId=1

请求方式

POST

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
dashboardId
1
Integer

看板ID
spaceId
1
Integer

空间ID

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "参数错误,dashboard not in space"
}
参数名 示例值 参数类型 参数描述
return_code
-1008
Integer
返回码
return_message
参数错误,dashboard not in space
String
返回信息

# 三、空间管理

# 查询空间ID和看板列表

接口URL

/open/get-space-dashboards-by-space-name?token=xxx&projectId=377&spaceName=b

请求方式

GET

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
377
Integer

项目ID
spaceName
b
String

空间名称

成功响应示例

{
    "data": {
        "dashboards": [
            {
                "dashbordId": 3590,
                "dashbordName": "lzm"
            }
        ],
        "spaceId": 31
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
dashboards -
List
看板信息
dashbordId 3590
Integer
看板ID
dashbordName lzm
String
看板名称
spaceId 31
Integer
空间ID
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1006,
    "return_message": "您无权限操作(view space dashboards)"
}
参数名 示例值 参数类型 参数描述
return_code
-1006
Integer
返回码
return_message
您无权限操作(view space dashboards)
String
返回信息

# 查询空间ID和成员权限列表

接口URL

/open/get-space-members-by-space-name?token=xxx&projectId=377&spaceName=b

请求方式

GET

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
377
Integer

项目ID
spaceName
b
String

空间名称

成功响应示例

{
    "data": {
        "allAuthUserAuthority": "MEMBER",
        "authUserGroups": [
            {
                "authority": "ADMIN",
                "id": 1301,
                "name": "test1"
            }
        ],
        "authUsers": [
            {
                "authority": "ADMIN",
                "id": 1149,
                "name": "test2"
            }
        ],
        "creator": {
            "id": 928,
            "name": "test3"
        },
        "spaceId": 31
    },
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
data
-
Object
返回数据
allAuthUserAuthority MEMBER
String
全体人员权限
authUserGroups -
List
权限组列表
authority ADMIN
String
权限
id 1301
Integer
用户ID
name test1
String
用户名称
authUsers -
List
用户列表
authority ADMIN
String
权限
id 1149
Integer
用户ID
name test2
String
用户名称
creator -
Object
创建人信息
id 928
Integer
创建人用户ID
name test3
String
创建人姓名
spaceId 31
Integer
空间ID
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1006,
    "return_message": "您无权限操作(view space members)"
}
参数名 示例值 参数类型 参数描述
return_code
-1006
Integer
返回码
return_message
您无权限操作(view space members)
String
返回信息

# 更新空间成员权限列表

可用于更新空间名称,空间默认权限,添加或修改空间人员权限,添加或修改空间成员组权限

注意

提交的成员权限列表将整体替换掉原来的成员列表

接口URL

/open/update-space?token=xxx&projectId=0&spaceId=0

请求方式

POST

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
spaceId
0
Integer

空间ID

请求Body参数

{
  "allAuthUserAuthority": "MEMBER",
  "authUserGroups": [
    {
      "id": 99,
      "authority": "MEMBER",
      "name": "member99"
    }
  ],
  "authUsers": [
    {
      "id": 88,
      "authority": "ADMIN",
      "name": "admin88"
    }
  ],
  "spaceName": "spaceTest"
}
参数名 示例值 参数类型 是否必填 参数描述
allAuthUserAuthority
string
String

全部成员权限
MEMBER:普通成员
ADMIN:管理员
authUserGroups
-
List

字段显示名
id 99
Integer

用户组ID
name MEMBER
String

用户组姓名
authority member99
String

用户组权限
MEMBER:普通成员
ADMIN:管理员
authUsers
-
List

字段描述
id 88
Integer

用户ID
name ADMIN
String

用户姓名
authority admin88
String

用户权限
MEMBER:普通成员
ADMIN:管理员
spaceName
spaceTest
String

属性类型,event:事件属性,user:用户属性

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "看板空间不存在"
}
参数名 示例值 参数类型 参数描述
return_code
-1023
Integer
返回码
return_message
看板空间不存在
String
返回信息

# 删除空间

接口URL

/open/delete-space?token=xxx&projectId=0&spaceId=1

请求方式

POST

Content-Type

application/json

请求Query参数

参数名 示例值 参数类型 是否必填 参数描述
token
xxx
String

查询密钥
projectId
0
Integer

项目ID
spaceId
1
Integer

空间ID

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名 示例值 参数类型 参数描述
return_code
0
Integer
返回码
return_message
success
String
返回信息

错误响应示例

{
    "return_code": -1023,
    "return_message": "看板空间不存在"
}
参数名 示例值 参数类型 参数描述
return_code
-1023
Integer
返回码
return_message
看板空间不存在
String
返回信息