工作流 - 管理员

使用审核日志

概述

Frame.io 支持并维护其应用程序中绝大多数活动的审核日志。这包括对核心资源的基本增删改查 (CRUD) 操作，以及一些特殊的抽象处理（例如 AssetVersioned）。

审核日志在 30 天后截断

Frame.io 审核日志可通过 API 获取最近 30 天的滚动窗口数据，之后它们将被移入冷存储。因此，如果您希望保留 Frame.io 事件的长期历史记录，请确保您自行独立存储历史日志数据。

权限范围与权限

只有帐户管理员可以访问帐户的审核日志，并且对审核日志端点的所有调用都必须限定在 account_id 范围内，如下所示：

GET https://api.frame.io/v2/accounts/:id/audit_logs

响应

审核日志响应都采用类似的格式：

1{
2    "_type": "audit",
3    "account_id": "<account-id>",
4    "action": "<ActionTaken>",
5    "actor": {
6        "_type": "user",
7        "id": "<user-id>",
8    },
9    "actor_id": "<user-id>",
10    "id": "<audit-id>",
11    "inserted_at": "<ISO-8601-datetime>",
12    "item_id": "<resource-id>",
13    "item_type": "<ResourceType>",
14    "resource": {...},
15    "team_id": "<team-id>",
16    "updated_at": "<ISO-8601-datetime>"
17}
不要忘记进行分页！

审核日志响应数据可能相当冗长，因此请确保您熟悉分页！

筛选条件

审核日志支持多种筛选条件，包括日期范围。与 Frame.io 的搜索端点不同，筛选条件只能以 GET 查询字符串参数的形式发送。

筛选条件都遵循相同的格式：

GET + 查询字符串

1GET
2https://api.frame.io/accounts/:id/audit_logs?filter[filter_type1]=value1&filter[filter_type2]=value2
每种筛选类型仅支持一个值

目前，审核日志每种筛选类型仅支持一个值。如果您提供了两个相同类型的筛选条件（例如 filter[action]=ActionOne&amp;filter[action]=ActionTwo），则第二个筛选条件将优先生效。

关键筛选类型

用于筛选和导航审核日志的关键筛选类型包括：

筛选类型描述示例值
item_type筛选单一类型的所有资源。Presentation、Comment、ReviewLink、Asset
item_id筛选单个特定资源，例如一个资产或演示文稿。<asset-id>, <presentation-id>
action筛选单个操作，通常与 item_type 相关联ProjectCreated、AssetVersioned、CommentDeleted
actor_id筛选特定用户（操作者）的 ID。<user-id>
team_id筛选与单个团队相关的活动。此筛选条件仅可用于拥有多个团队的团队。<team-id>
inserted_at筛选在特定日期时间之前或之后发生的审核事件。必须为 ISO-8601 格式，UTC。2022-08-25T00:00:00Z

项目类型和操作

资源操作
帐户AccountCreated、AccountUpdate、AccountLocked
资产AssetCopied、AssetCreated、AssetDeleted、AssetUpdated、AssetVersioned、AssetUnversioned、AssetLabelUpdated、AssetMoved、AssetPreserved、AssetPrivatized、AssetPublicized、AssetRestored
协作者CollaboratorCreated、CollaboratorDeleted
评论CommentCreated、CommentCompleted、CommentDeleted、CommentLiked、CommentUncompleted、CommentUnliked、CommentUpdated、ReplyCreated
演示文稿PresentationCreated、PresentationDeleted、PresentationUpdated
项目ProjectCreated、ProjectDeleted、ProjectMoved、ProjectRestored、ProjectUpdated
ReviewLinkReviewLinkCreated、ReviewLinkDeleted、ReviewLinkUpdated
团队TeamCreated、TeamUpdated、TeamDeleted
团队成员TeamMemberCreated、TeamMemberAccepted、TeamMemberDeclined、TeamMemberRemoved、TeamMemberUpdated

筛选条件示例

所有筛选条件都采用类似的格式，如上所述。下面是一些针对特定用例的示例，可以帮助您快速入门。

场景查询字符串
由单个用户执行的操作。?filter[actor_id]=<user-id>
特定演示文稿上的所有活动。?filter[item_id]=<presentation-id>
用户留下的评论。?filter[action]=CommentCreated&amp;filter[actor_id]=<user-id>
团队上的所有审阅链接活动。?filter[item_type]=ReviewLink&amp;filter[team_id]=<team-id>

日期范围

日期范围是一个稍微特殊的情况，因为需要同时指定 inserted_at 日期时间值 (value)，以及要应用于该日期时间的操作 (op)。因此，日期范围查询将始终包含两个筛选元素，每个元素本身都嵌套在 [inserted_at] 参数旁边。

支持的操作包括：

  • gt：大于
  • gte：大于或等于
  • lt：小于
  • lte：小于或等于

日期范围示例

场景查询字符串
从某个日期开始的所有审核日志记录。?filter[inserted_at][op]=gt&amp;filter[inserted_at][value]=2019-03-25T00:00:00Z
特定用户在某个日期之前上传的所有资产。?filter[inserted_at][op]=lt&amp;filter[inserted_at][value]=2019-03-25T00:00:00Z&amp;filter[actor_id]=<user-id>&amp;filter[action]=AssetCreated