# 前言

数字中心 OpenAPI 是 FinClip 服务端的开放出来的一些核心链路的接口。允许您以编程方式与 FinClip 服务端交互。用于自动执行任务、与其他工具集成并创建自定义工作流程等

# 快速开始

  1. 在数字中心的个人中心中,选择创建 Personal Access Token
  2. 勾选当前 Token 需要具备的权限,并创建。注意:请妥善保存创建生成的 Access Token,后续无法找回,只能重置
  3. 选择下面任意的OpenAPI接口,在请求头嵌入Authorization 的 header,值为: Bearer {PersonalAccessToken}
    • 注意:这个header是所有 OpenAPI 接口都需要传的参数

# 授权范围

授权范围是OpenAPI权限集

以下是具体的授权范围的说明

授权组 授权范围 说明
用户 用户-查看 数字中心用户的查看
用户-编辑 邀请 & 移除数字中心用户
角色-查看 查看系统中定义的角色及其权限
角色-编辑 编辑角色权限及分配角色给成员
生态 生态-查看 查看开发中心的组织 & 账号相关信息
生态-编辑 管理开发中心的组织 & 账号相关信息
小程序 小程序-查看 查看小程序的基本信息
小程序统一认证 小程序统一认证相关的接口

# API

以下的 OpenAPI 接口会以授权范围作为目录,只有拥有了该授权范围的 Personal Access Token 才可以访问具体的接口。

# 1. 通用接口

通用接口指不依赖任何授权范围的 OpenAPI,主要是一些用户账户相关的一些基础功能接口

# 1.1 获取菜单权限树

请求URL

GET /api/v1/open/oper/auth/tree

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 无

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "permissionTree": { // 权限树
            "childrenIds": [
                ""
            ],
            "desc": "",
            "exist": true,
            "hasPermission": true,
            "id": "",
            "itemType": 1,
            "name": "",
            "parentId": ""
        }
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 1.2 解密字符串

请求URL

POST /api/v1/open/oper/decrypt

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
str string 待解密的字符串

请求示例

{
    "str": "42b0ec79222a3a95577a86883890dc24ddcc6f7feec88b01f9ec22326e27f2c4"
}

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "str": "解密后的结果"
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 2. 用户-查看

# 2.1 获取账号角色列表

请求URL

GET /api/v1/open/oper/account/role/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
accountId string
pageNo int 页码。从1开始
pageSize int 每页数量

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "items": {
            "builtinRoleKey": "", // 内置角色的key,现有:admin,data_analyst,developer,super_admin 四种
            "name": "", // 角色名称
            "roleId": "" // 角色id
        },
        "total": 1
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 2.2 获取账号列表

请求URL

GET /api/v1/open/oper/account/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
pageNo int 页码。从1开始
pageSize int 每页数量
keyword string 账号模糊搜索关键字

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "accounts": {
            "account": "", // 账户名
            "accountId": "", // 账户id 
            "createTime": 1, // 创建时间
            "email": "", // 邮箱
            "phone": "", // 手机号
            "status": 1 // 状态 1=启用 2=禁用
        }
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 3. 用户-编辑

# 3.1 账号绑定角色

备注 每次请求进来的都是全量的角色列表,会将旧的关系删除

请求URL

POST /api/v1/open/oper/account/role/binding

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
accountId string 账户id
roleIds string[] 角色id列表

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 3.2 更新用户是否冻结状态

请求URL

POST /api/v1/open/oper/account/frozen/update

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
isFrozen int 是否冻结 0=解冻 1=冻结
operAccountId string 数字中心用户id

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 3.3 重置密码

请求URL

POST /api/v1/open/oper/account/password/reset

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
accountId string 账户id
password string 新密码

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 3.4 创建账号

请求URL

POST /api/v1/open/oper/account/create

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
phone string 手机号
roleIds string[] 绑定的角色id
account string 账号名
areaCode string 手机区号,示例 +86
email string 邮箱
password string 密码

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "accountId": ""
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 3.5 删除账号

请求URL

POST /api/v1/open/oper/account/delete

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
accountIds string[] 账户id

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 4. 角色-查看

# 4.1 获取角色列表

请求URL

GET /api/v1/open/oper/role/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
pageNo int 页码。从1开始
pageSize int 每页数量
keyword string 角色名称模糊搜索关键字

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 4.2 获取角色下的账号列表

请求URL

GET /api/v1/open/oper/role/account/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
roleId string 角色id
pageNo int 页码。从1开始
pageSize int 每页数量

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "accounts": {
            "account": "", // 账户名
            "accountId": "", // 账户id
            "createTime": 1, // 账户创建时间
            "email": "", // 邮箱
            "phone": "" // 手机号
        },
        "total": 1
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 5. 角色-编辑

# 5.1 更新角色

请求URL

POST /api/v1/open/oper/role/update

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
idePermissionTree map<string, object> ide_权限树
permissionTree map<string, object> 权限树
roleId string

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 5.2 删除角色

请求URL

POST /api/v1/open/oper/role/delete

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
roleId string 角色id

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 5.3 角色中移除账号

请求URL

POST /api/v1/open/oper/role/account/delete

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
accountIds string[] 成员id列表
roleId string 角色id

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 5.4 创建角色

请求URL

POST /api/v1/open/oper/role/create

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
idePermissionTree object ide 权限树
permissionTree object 权限树
roleName string 角色名称

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "roleId": ""
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 5.5 绑定账号到角色

备注 每次请求进来的都是增量的成员列表,不会将旧的关系删除

请求URL

POST /api/v1/open/oper/role/account/binding

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
accountIds string[] 成员id列表
roleId string 角色id

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 6. 生态-查看

# 6.1 获取开发端账号加入的组织列表

请求URL

GET /api/v1/open/oper/dev-account/ecology/organ/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
devAccountId string 账号id
pageNo int 页码。从1开始
pageSize int 每页数量

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "items": {
            "organId": "",
            "organName": "",
            "reviewStatus": 1,
            "role": ""
        },
        "total": 1
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 6.2 获取开发端账号列表

请求URL

GET /api/v1/open/oper/dev-account/ecology/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
organId string 组织id的过滤
organName string 组织name的过滤
pageNo int 页码。从1开始
pageSize int 每页数量
search string 账户模糊搜索关键字

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "items": {
            "account": "",
            "createTime": 1,
            "devAccountId": "",
            "email": "",
            "organCount": 1,
            "phone": ""
        },
        "total": 1
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 6.3 获取开发端组织详情

请求URL

GET /api/v1/open/oper/organ/ecology/info

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
devOrganId string 组织id

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "access": true,
        "applyTime": 1,
        "devOrganAuditRecordId": "",
        "enterpriseInfo": "",
        "enterpriseName": "",
        "enterpriseType": "",
        "operReviewResult": 1,
        "rejectReason": "",
        "reviewerId": "",
        "workflowNodeInstanceId": ""
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 6.4 获取开发端组织列表

请求URL

GET /api/v1/open/oper/organ/ecology/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
enterpriseType string 已认证组织的子类型过滤
organName string 组织名称过滤
organReviewStatus string
pageNo int 页码。从1开始
pageSize int 每页数量
type int 组织类型。1=未认证组织 2=已认证组织

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "items": {
            "applyPassTime": 1,
            "createTime": 1,
            "devOrganId": "",
            "enterpriseType": "",
            "name": "",
            "reviewStatus": 1,
            "type": 1
        },
        "total": 1
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 6.5 获取开发端账号详情

请求URL

GET /api/v1/open/oper/dev-account/ecology/get

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: query

字段 类型 含义
devAccountId string 开发者账号ID

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "devAccountId": "2309190000000000",
        "account": "宝树",
        "email": "test@gmail.com",
        "phone": "13000000000",
        "areaCode": "+86"
    },
    "traceid": "a0560a999f6f41f8af00a661264fd0d0"
}

# 7. 生态-编辑

# 7.1 -重置开发端账号密码

请求URL

POST /api/v1/open/oper/dev-account/ecology/reset/password

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
devAccountId string 账号id
password string 密码

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 7.2 更新企业冻结状态

请求URL

POST /api/v1/open/oper/organ/ecology/frozen-status/update

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
devOrganId string 组织id
isFrozen int 是否冻结 1=未冻结 2=已冻结

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 7.3 更新企业审核状态

请求URL

POST /api/v1/open/oper/organ/ecology/review-status/update

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
devOrganId string 组织id
operReviewResult int
rejectReason string 拒绝原因
workflowNodeInstanceId string 节点实例id

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 7.4 添加开发中心成员账号

请求URL

POST /api/v1/open/oper/dev-account/ecology/create

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
account string 账户名
areaCode string 手机区号
email string 邮箱
password string 密码
phone string 手机号

示例响应


{
    "errcode": "",
    "error": "",
    "data": {},
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 7.5 检查小程序权限

请求URL

POST /api/v1/open/oper/resource-groups/mini-app/check

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数 参数位置: body

字段 类型 含义
accountId string 账号ID
miniAppId string 小程序ID

请求示例

{
    "accountId": "2309190518932677",
    "miniAppId": "fc2524431909802053"
}

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "hasPermission": true // 是否有权限
    },
    "traceid": "63500886a1f541249545fc0afbc52394"
}

# 8. 小程序-查看

# 8.1 获取小程序详情

请求URL

GET /api/v1/open/oper/mini-apps/{miniAppId}

请求参数 参数位置: path

字段 类型 含义
miniAppId string 小程序id

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "appClass": "", // 小程序分类
        "appClassKey": "", // 小程序分类key
        "createBy": "", // 创建人
        "createTime": 1, // 创建时间
        "creatorAccount": "", // 创建人账号
        "desc": "", // 小程序简介
        "detailDesc": "", // 小程序详细描述
        "displayLang": "", // 小程序显示语言
        "isForbidden": true, // 是否禁用
        "logo": "", // 小程序logo
        "miniAppId": "", // 小程序id
        "name": "", // 小程序名称
        "organId": "", // 小程序所属组织id
        "organName": "", // 小程序所属组织名称
        "privacySettingType": 1, // 小程序隐私设置情况。0=未设置 1=已设置自定义内容 2=已设置默认内容
        "projectType": 1, // 小程序子类型。1=小程序 2=小游戏 3=h5 4=小组件 5=低功耗
        "searchable": true, // 是否允许搜索
        "status": 1, // 小程序当前生命周期的状态。1=开发中,未上传代码包 2=上架审核中 3=上架审核已撤回 4=上架审核已通过 5=上架审核已拒绝 6=已上架 7=已下架(开发端主动) 8=已下架(被运营端管理员) 9=开发中,仅上传代码包 10=创建审核中 11=创建审核已撤回 12=创建审核已拒绝
        "testInfo": 1, // 小程序测试信息
        "updateTime": 1, // 更新时间
        "version": "" // 上架的版本号
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 8.2 获取小程序关联的宿主应用列表

请求URL

GET /api/v1/open/oper/mini-apps/{miniappid}/host-apps

请求参数 参数位置: query

字段 类型 含义
miniAppId string
pageNo int
pageSize int

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

示例响应

{
    "error": "",
    "errcode": "OK",
    "data": {
        "items": {
            "bundleIdPublic": true,
            "createTime": 1,
            "desc": "",
            "displayLang": "",
            "hostAppId": "",
            "hostAppPublic": true,
            "isBuiltin": true,
            "logo": "",
            "name": "",
            "organId": "",
            "organName": "",
            "owner": "",
            "platform": 1,
            "source": 1,
            "status": 1,
            "updateTime": 1
        },
        "total": 1
    },
    "traceid": "a17b2855affb46c08485937aca8243ef"
}

# 9. 分析

# 9.1 获取小程序列表

请求URL

GET /api/v1/open/oper/mini-apps/list

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
appStatus integer 否 query 小程序状态
applyEndTime integer 否 query 申请时间-结束范围
applyStartTime integer 否 query 申请时间-开始范围
exportId string 否 query 导出任务id
frozenStatus integer 否 query 冻结状态(0全部 1正常 2已冻结)
isExport boolean 否 query 是否导出数据
keyword string 否 query 关键字
organId string 否 query 企业id
organName string 否 query 企业名称模糊匹配
pageNo integer 否 query 页码
pageSize integer 否 query 每页数量
projectType string 否 query 项目类型(多选逗号分隔)
publishEndTime integer 否 query 上架时间-结束范围
publishStartTime integer 否 query 上架时间-开始范围
sortType string 否 query 排序类型

响应参数

参数名 类型 描述
items array 数据项列表
items.applyTime integer 申请时间
items.assignees array 负责人列表
items.auditStatus integer 审核状态
items.createTime integer 创建时间
items.miniAppId string 小程序id
items.name string 名称
items.organId string 企业id
items.organName string 企业名称
items.projectType integer 项目类型
items.publishStatus integer 发布状态
items.publishTime integer 发布时间
total integer 总数

示例响应

{
  "items": [
    {
      "applyTime": 1704067200000,
      "assignees": ["张三"],
      "auditStatus": 1,
      "createTime": 1704067200000,
      "miniAppId": "123456",
      "name": "示例小程序",
      "organId": "789",
      "organName": "测试企业",
      "projectType": 1,
      "publishStatus": 2,
      "publishTime": 1704067200000
    }
  ],
  "total": 100
}

# 9.2 数据看板-PV总和

请求URL

GET /api/v1/open/oper/stat/basic/billboard/total/pv

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
devOrganIds string 否 query 组织ids
endTime integer 否 query 结束时间
exportId string 否 query 导出ID
isExport boolean 否 query 是否导出数据
metricType integer 否 query 统计类型
miniAppIds string 否 query 小程序ids
pageNo integer 否 query 页码
pageSize integer 否 query 每页数量
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
hasData boolean 是否有数据
items array 数据项列表
items.activeDeviceCount integer 活跃设备数
items.date string 日期
items.dateMs integer 日期时间戳(毫秒)
items.deviceCount integer 设备数
items.duration integer 使用时长(秒)
items.existCount integer 已有数量
items.formattedDuration string 格式化时长
items.miniAppId string 小程序id
items.name string 名称
items.openCount integer 打开次数
total integer 总数

示例响应

{
  "hasData": true,
  "items": [
    {
      "activeDeviceCount": 100,
      "date": "2024-01-01",
      "dateMs": 1704067200000,
      "deviceCount": 500,
      "duration": 3600,
      "existCount": 200,
      "formattedDuration": "1小时",
      "miniAppId": "123456",
      "name": "示例小程序",
      "openCount": 1000
    }
  ],
  "total": 100
}

# 9.3 获取小程序统计折线图

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/pillar

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 灰度结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 灰度开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.activeDeviceCount integer 活跃设备数
items.date string 日期
items.dateMs integer 日期时间戳(毫秒)
items.deviceCount integer 设备数
items.duration integer 使用时长(秒)
items.newDeviceCount integer 新增设备数
items.openCount integer 打开次数
items.val integer 数值
maxTotal integer 最大总数

示例响应

{
  "items": [
    {
      "activeDeviceCount": 100,
      "date": "2024-01-01",
      "dateMs": 1704067200000,
      "deviceCount": 500,
      "duration": 3600,
      "newDeviceCount": 50,
      "openCount": 200,
      "val": 1000
    }
  ],
  "maxTotal": 5000
}

# 9.4 数据看板-平均访问时长总和

请求URL

GET /api/v1/open/oper/stat/basic/billboard/total/avg-duration

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
country string 否 query 国家
devOrganIds string 否 query 组织ids
endTime integer 否 query 结束时间
exportId string 否 query 导出标识符
isExport boolean 否 query 是否导出
isRunPlay boolean 否 query 是否run play
miniAppIds string 否 query 小程序ids
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
hasData boolean 是否有数据
items array 数据项列表
items.date string 日期
items.dateMs integer 日期时间戳(毫秒)
items.formattedVal string 格式化后的值
items.val integer 数值
totalCount integer 总数量

示例响应

{
  "hasData": true,
  "items": [
    {
      "date": "2024-01-01",
      "dateMs": 1704067200000,
      "formattedVal": "1,000",
      "val": 1000
    }
  ],
  "totalCount": 30
}

# 9.5 数据看板-活跃设备总和

请求URL

GET /api/v1/open/oper/stat/basic/billboard/total/active-device

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
country string 否 query 国家
devOrganIds string 否 query 组织ids
endTime integer 否 query 结束时间
exportId string 否 query 导出标识符
isExport boolean 否 query 是否导出
isRunPlay boolean 否 query 是否run play
miniAppIds string 否 query 小程序ids
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
hasData boolean 是否有数据
items array 数据项列表
items.date string 日期
items.dateMs integer 日期时间戳(毫秒)
items.formattedVal string 格式化后的值
items.val integer 数值
totalCount integer 总数量

示例响应

{
  "hasData": true,
  "items": [
    {
      "date": "2024-01-01",
      "dateMs": 1704067200000,
      "formattedVal": "1,000",
      "val": 1000
    }
  ],
  "totalCount": 30
}

# 9.6 数据看板-UV总和

请求URL

GET /api/v1/open/oper/stat/basic/billboard/total/uv

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
country string 否 query 国家
devOrganIds string 否 query 组织ids
endTime integer 否 query 结束时间
exportId string 否 query 导出标识符
isExport boolean 否 query 是否导出
isRunPlay boolean 否 query 是否run play
miniAppIds string 否 query 小程序ids
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
hasData boolean 是否有数据
items array 数据项列表
items.date string 日期
items.dateMs integer 日期时间戳(毫秒)
items.formattedVal string 格式化后的值
items.val integer 数值
totalCount integer 总数量

示例响应

{
  "hasData": true,
  "items": [
    {
      "date": "2024-01-01",
      "dateMs": 1704067200000,
      "formattedVal": "1,000",
      "val": 1000
    }
  ],
  "totalCount": 30
}

# 9.7 数据看板-宿主应用来源

请求URL

GET /api/v1/open/oper/stat/basic/billboard/host-app

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
country string 否 query 国家
devOrganIds string 否 query 组织ids
endTime integer 否 query 结束时间
exportId string 否 query 导出标识符
isExport boolean 否 query 是否导出
isRunPlay boolean 否 query 是否run play
miniAppIds string 否 query 小程序ids
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "App名称",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 9.8 数据看板-地域分布

请求URL

GET /api/v1/open/oper/stat/basic/billboard/country/region

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
country string 否 query 国家
devOrganIds string 否 query 组织ids
endTime integer 否 query 结束时间
exportId string 否 query 导出标识符
isExport boolean 否 query 是否导出
isRunPlay boolean 否 query 是否run play
miniAppIds string 否 query 小程序ids
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "北京",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 9.9 设备数据-获取小程序留存统计

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/retention

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.date string 日期
items.dateMs integer 日期时间戳(毫秒)
items.five integer 5日留存
items.formattedVal string 格式化后的值
items.four integer 4日留存
items.fourteen integer 14日留存
items.newUserCount integer 新增用户数
items.one integer 次日留存
items.seven integer 7日留存
items.six integer 6日留存
items.thirty integer 30日留存
items.three integer 3日留存
items.two integer 2日留存
items.val integer 数值

示例响应

{
  "items": [
    {
      "date": "2024-01-01",
      "dateMs": 1704067200000,
      "five": 100,
      "formattedVal": "1,000",
      "four": 120,
      "fourteen": 80,
      "newUserCount": 1000,
      "one": 500,
      "seven": 200,
      "six": 150,
      "thirty": 50,
      "three": 300,
      "two": 400,
      "val": 1000
    }
  ]
}

# 9.10 设备数据-获取小程序统计折线图

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/pillar

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 灰度结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 灰度开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.activeDeviceCount integer 活跃设备数
items.date string 日期
items.dateMs integer 日期时间戳(毫秒)
items.deviceCount integer 设备数
items.duration integer 使用时长(秒)
items.newDeviceCount integer 新增设备数
items.openCount integer 打开次数
items.val integer 数值
maxTotal integer 最大总数

示例响应

{
  "items": [
    {
      "activeDeviceCount": 100,
      "date": "2024-01-01",
      "dateMs": 1704067200000,
      "deviceCount": 500,
      "duration": 3600,
      "newDeviceCount": 50,
      "openCount": 200,
      "val": 1000
    }
  ],
  "maxTotal": 5000
}

# 9.11 设备数据-获取小程序设备分布

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/device

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "iOS",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 9.12 设备数据-获取小程序屏幕分辨率分布

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/screen

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "1920x1080",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 9.13 设备数据-获取小程序手机品牌分布

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/brand

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "华为",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 9.14 设备数据-获取小程序SDK版本分布

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/sdk-version

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "v3.0.0",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 9.15 设备数据-获取小程序基础包版本分布

请求URL

GET /api/v1/open/oper/stat/basic/mini-app/basic-pack-version

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
endTime integer 否 query 结束时间
miniAppId string 否 query 小程序id
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "v1.0.0",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 9.16 数据看板-区域应用来源分布

请求URL

GET /api/v1/open/oper/stat/basic/billboard/region

请求头部

Header 值
Authorization Bearer {PersonalAccessToken}

请求参数

参数名 类型 必填 位置 描述
country string 否 query 国家
devOrganIds string 否 query 组织ids
endTime integer 否 query 结束时间
exportId string 否 query 导出标识符
isExport boolean 否 query 是否导出
isRunPlay boolean 否 query 是否run play
miniAppIds string 否 query 小程序ids
startTime integer 否 query 开始时间

响应参数

参数名 类型 描述
items array 数据项列表
items.formattedVal string 格式化后的值
items.name string 名称
items.proportion string 占比
items.value integer 数值

示例响应

{
  "items": [
    {
      "formattedVal": "1,000",
      "name": "华东",
      "proportion": "50%",
      "value": 1000
    }
  ]
}

# 通用错误码

以下定义了一些接口之间通用的错误码字典,用于接口返回值判断和错误排查

errcode 错误码 描述
OK 成功
ECODE_PARAM_ERR 参数错误。请求的入参不合法,检查请求入参
ECODE_UNAUTHORIZED 未认证。无法识别到用户,检查当前的 PersonalAccessToken 是否正确
ECODE_FORBIDDEN 未授权。当前的 PersonalAccessToken 的对应的权限,不足以访问当前正在访问的接口
ECODE_SERVER_ERR 服务器内部错误。预期外的错误,请携带返回中的traceid向系统管理员反馈
ECODE_LICENSE_NOT_SUPPORT_OPEN_API_ERROR 当前license不支持open-api功能,无法使用
OPEN_API_ACCESS_TOKEN_NOT_FOUND_ERR 当前的 PersonalAccessToken 不存在
ECODE_PERSONAL_ACCESS_TOKEN_CROSS_PLATFORM_ERROR 使用开发中心或者数字中心的 PersonalAccessToken ,访问另一端的接口。
ECODE_PERSONAL_ACCESS_TOKEN_OUT_OF_SCOPE 无法识别到用户,检查当前的 PersonalAccessToken 是否正确
ECODE_PERSONAL_ACCESS_TOKEN_OUT_OF_SCOPE 当前的 PersonalAccessToken 的对应的权限,不足以访问当前正在访问的接口
© FinClip with ❤ , Since 2017