文档

ListRecentViewReports - 获取首页看板常看和足迹列表

更新时间:

获取指定用户在首页看板中展示的常看和足迹列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
UserIdstring

要查询的用户在 Quick BI 中的 UserID。

b5d8fd9348cc4327****afb604
Keywordstring

作品名称的关键字。

财务报表
TreeTypestring

查询作品的类型(填空查询所有类型)。取值范围 :

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • REPORT:电子表格
PAGE
QueryModestring

查询模式。取值范围:

  • 1:按访问次数排序
  • 2:按最近访问时间排序
1
PageSizeinteger

查询作品列表的行数:

  • 默认值:10
  • 最大值:9999
10
OffsetDayinteger

查询最近多少天的数据(默认 10 天)。

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回查询结果。

TotalNuminteger

总行数。

1
TotalPagesinteger

总页数。

1
PageNuminteger

页码。

1
PageSizeinteger

每页显示的数据条数。

  • 默认为 10 条
  • 最大为 100 条
10
Dataobject []

查询到的作品列表。

TreeIdstring

作品 ID。

977c7698-****-****-****-44b7304d20fc
Typestring

作品类型。取值范围 :

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • REPORT:电子表格
PAGE
Namestring

作品名称。

测试报表
OwnerNumstring

作品所有者的 UserID。

1365*****238860
OwnerNamestring

作品所有者的阿里云账号名。

李四
GmtCreatestring

作品创建时间戳。

1496651577000
GmtModifiedstring

作品修改的时间戳。

1640595729000
PublishStatusinteger

作品的发布状态。取值范围:

  • 0:未发布
  • 1:已发布
  • 2:已修改保存未发布
  • 3:已下线
1
Favoriteboolean

查询用户是否收藏了该作品。

true
HasViewAuthboolean

查询用户是拥有作品的查看权限。

true
HasEditAuthboolean

查询用户是拥有作品的编辑权限。

true
WorkspaceIdstring

作品所属的工作空间 ID。

523793cb-****-****-****-aa71c65ffa39
WorkspaceNamestring

作品所属的工作空间名称。

测试工作空间
ViewCountlong

作品被访问的次数。

7
LatestViewTimestring

作品最后一次被访问的时间戳。

1642067498000
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalNum": 1,
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "Data": [
      {
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "Name": "测试报表",
        "OwnerNum": "1365*****238860",
        "OwnerName": "李四",
        "GmtCreate": "1496651577000",
        "GmtModified": "1640595729000",
        "PublishStatus": 1,
        "Favorite": true,
        "HasViewAuth": true,
        "HasEditAuth": true,
        "WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
        "WorkspaceName": "测试工作空间",
        "ViewCount": 7,
        "LatestViewTime": "1642067498000"
      }
    ],
    "Attention": "当前API返回的分页参数如TotalNum等即将下线,如有使用请及时修改"
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Invalid.User.OrganizationThe user is not in your organization.该用户不在您的组织中。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈