使用活动日志 API 查看企业中发生的事件。 # **入门** **谁可以使用活动日志 API** * 活动日志 API 仅适用于企业版。 * 只有企业管理员才能生成访问令牌。活动日志 API 允许你对企业事件进行编程访问，你可以查看任意企业中成员和访客在企业中发生的事件，你可以使用活动日志 API 构建你的自定义应用程序。 ## **生成企业访问令牌** 1. 在侧边栏点击「企业管理」。 2. 进入「设置」页。 3. 点击「企业访问令牌」。 4. 点击「生成访问令牌」。 5. 设置令牌的名称和过期时间。 6. 点击「生成令牌」。生成后请立刻复制并妥善保管令牌，一旦关闭弹窗，将没有机会再次查看。 ## **使用企业访问令牌** 你可以通过将令牌传递到 `Authorization: Bearer ` 请求头中来调用 API。以下是一个示例： ``` curl 'https://api.motiff.cn/api/v1/organizations/activity_logs?orgId=${orgId}' \ --header 'Authorization: Bearer ' ``` # **Endpoints** 返回活动日志事件列表。 ## **HTTP Endpoint** `GET /api/v1/organizations/activity_logs` | 路径参数 | 是否必填 | 参数类型 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | orgId | 是 | String | 查询企业的 ID | | actionTypes | 否 | String | 响应事件的操作类型。可以有多个值，用逗号分隔。默认情况下返回所有操作类型的事件。 | | startTime | 否 | Number | 查询最远事件的 Unix 时间戳(毫秒)。如果未指定，默认 0 。 | | endTime | 否 | Number | 查询最近事件的 Unix 时间戳(毫秒)。如果未指定，默认为当前时间戳。 | | limit | 否 | Number | 单次请求返回的最大事件数。如果未指定，此参数默认为 1000。 | | order | 否 | String | 按时间戳对事件进行排序。该参数可以是“ASC”（默认）或“DESC”。 | | cousor | 否 | String | 事件总数超过 `limit` 上限时，API 将对结果进行分页，响应中包含 `cursor` 字段。要获取下一批事件，请将 `cursor` 参数添加到新的查询字符串中。 | 注：只能查询到 2024 年 9 月 15 日之后的事件。 ## **Error codes** | **Error code** | **Description** | | -------------- | -------------------------- | | 400 | 参数错误 | | 401 | 认证失败 | | 403 | 无权限访问所请求的活动日志 | | 429 | 接口限流 | 使用查询字符串参数向你的请求添加过滤器。你可以添加路径参数的组合来创建特定查询。以下是一些示例： * 获取过去所有管理员修改席位的记录 ```javascript curl -H 'Authorization: Bearer ' 'https://api.motiff.cn/api/v1/organizations/activity_logs? orgId=xxx&actionTypes=upgrade_seat,downgrade_seat' ``` * 获取 2024-06-01 08:20:00 UTC 到 2024-08-01 17:05:08 UTC 之间的所有创建团队事件 ```javascript curl -H 'Authorization: Bearer ' 'https://api.motiff.cn/api/v1/organizations/activity_logs? orgId=xxx&actionTypes=create_team&startTime=1717222800000&endTime=1722534308000' ``` * 事件总数超过 `limit` 上限时，使用响应中的 `cursor` 字段获取下一批事件，需要将 `orgId` 和 `cursor` 参数添加到新的查询字符串中 ```javascript curl -H 'Authorization: Bearer ' 'https://api.motiff.cn/api/v1/organizations/activity_logs?orgId=xxx&cursor=Y3Vyc29yIGN1cnNvciBjdXJzb3I=' ``` # **Events** 活动日志 API 返回的每个事件都包含四个部分：actor、action、entity 和 context。 * `actor` 是执行该操作的用户。可以通过三个属性来识别用户: email、 id 和 name 。 * `action` 是 `actor` 执行的任务或活动。其中 action\_type 表示操作的类型，details表示相关的元数据。[查看支持的操作类型和对应元数据](https://wukong.yuanfudao.biz/help/others/269261270998789#13-action%20types) * `entity` 是被 `actor` 执行操作的实体。它可以是用户、文件、项目或其他资源类型。[查看支持的 entity 类型和属性](https://wukong.yuanfudao.biz/help/others/269261270998789#7-entity%20type) * `context` 包含事件的其他上下文信息： * orgId: 事件发生所在企业的 ID。 * teamId: 事件发生所在团队的 ID。此示例显示管理员邀请用户加入企业时记录的事件： ```javascript { "actor": { "name": "admin" "id": "19799193456756", "email": "admin@motiff.com", }, "action": { "action_type": "invite_org_member" "details": { "seat_type": "viewer" }, }, "entity": { "nickname": "username", "id": "187991918120844", "type": "user" "email": "username@motiff.com", }, "context": { "teamId": "wUSjbhzh4xaR1gTeU7mRRX" "orgId": "AH0gDGssK5AVX01hsTQjag", }, "id": "208397249393110", "eventTime": 1717222800000 } ``` # Entity Type 以下是你可以在 API 响应的 Entity 字段下找到的常见类型： ## User | 字段 | 类型 | 描述 | | -------- | ------ | ------------ | | id | Number | 用户唯一标识 | | nickname | String | 姓名 | | email | String | 邮箱 | ## File | 字段 | 类型 | 描述 | | ------------ | ------ | ---------------- | | id | String | 文件唯一标识 | | name | String | 文档名称 | | link\_access | String | 文件链接分享权限 | ## Project | 字段 | 类型 | 描述 | | ---- | ------ | ------------ | | id | String | 项目唯一标识 | | name | String | 项目名称 | ## Team | 字段 | 类型 | 描述 | | ---- | ------ | ------------ | | id | String | 团队唯一标识 | | name | String | 团队名称 | ## Organization | 字段 | 类型 | 描述 | | ---- | ------ | ------------ | | id | String | 组织唯一标识 | | name | String | 组织名称 | # **Action Types** 以下是你可以在 API 响应的 `action` 字段下找到的操作类型： | action\_type | description | details | | --------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | create\_file | 创建文件 | project\_id 项目 ID
project\_name 项目名称
| | ai\_create\_file | 生成设计系统文件 | project\_id 项目 ID
project\_name 项目名称
| | import\_file | 导入文件 | project\_id 项目 ID
project\_name 项目名称
| | copy\_file | 创建文件副本 |

| | copy\_file\_to\_draft | 创建文件副本到草稿 |

| | move\_file | 移动文件 | project\_id\_old 操作前的项目 ID
project\_name\_old 操作前的项目名称
project\_id\_new 操作后的项目 ID
project\_name\_new 操作后的项目名称
| | trash\_file | 删除文件 |

| | delete\_file | 永久删除文件 |

| | restore\_file | 恢复文件 | project\_id 项目 ID
project\_name 项目名称

| | open\_file | 访问文件 | access 访问文件时的权限 | | rename\_file | 重命名文件 | file\_name\_old 操作前的文件名称
file\_name\_new 操作后的文件名称
| | export\_file | 导出文件内容 |

| | invite\_file\_member | 邀请用户加入文件 | file\_id 文档 ID
file\_name 文档名称
user\_permission 用户权限
| | remove\_file\_member | 从文件中移除用户 | file\_id 文档 ID
file\_name 文档名称
user\_permission\_old 操作前的用户权限
| | leave\_file | 离开文件 | file\_id 文档 ID
file\_name 文档名称
user\_permission\_old 操作前的用户权限
| | change\_file\_member\_access | 修改文件成员权限 | file\_id 文档 ID
file\_name 文档名称
user\_permission\_old 操作前的用户权限
user\_permission\_new 操作后的用户权限
| | change\_file\_inherited\_access | 修改文件的项目继承权限 | inherited\_access\_old 操作前的继承权限
inherited\_access\_new 操作后的继承权限
| | enable\_file\_link\_access | 启用文件链接分享 |

| | disable\_file\_link\_access | 禁用文件链接分享 |

| | change\_file\_link\_access | 修改文件链接分享配置 | file\_link\_access\_old 操作前的文件的链接分享配置
file\_link\_access\_new 操作后的文件的链接分享配置
| | open\_file\_password | 打开文件的链接分享密码 |

| | close\_file\_password | 关闭文件的链接分享密码 |

| | reset\_file\_password | 重置文件的链接分享密码 |

| | create\_project | 在团队下创建项目 | team\_id 团队 ID
team\_name 团队名称
| | delete\_project | 删除项目 | team\_id 团队 ID
team\_name 团队名称
| | move\_project | 移动项目 | team\_id\_old 操作前的团队id
team\_name\_old 操作前的团队名称
team\_id\_new 操作后的团队id
team\_name\_new 操作后的团队名称
| | rename\_project | 重命名项目 | team\_name\_old 操作前的团队名称
team\_name\_new 操作后的团队名称
| | invite\_project\_member | 邀请用户加入项目 | project\_id 项目 ID
project\_name 项目名称
user\_permission 用户权限
| | remove\_project\_member | 从项目中移除成员 | project\_id 项目 ID
project\_name 项目名称
user\_permission\_old 操作前的用户权限
| | leave\_project | 从项目中离开 | project\_id 项目 ID
project\_name 项目名称
user\_permission\_old 操作前的用户权限
| | change\_project\_member\_access | 修改项目成员权限 | project\_id 项目 ID
project\_name 项目名称
user\_permission\_old 操作前的用户权限
user\_permission\_new 操作后的用户权限
| | change\_project\_inherited\_access | ==修改项目的团队继承权限== | inherited\_access\_old 操作前的继承权限
inherited\_access\_new 操作后的继承权限
| | create\_team | 创建团队 | team\_org\_access 团队公开性配置 | | delete\_team | 删除团队 |

| | restore\_team | 恢复团队 |

| | invite\_team\_member | 邀请用户加入团队 | team\_id 团队 ID
team\_name 团队名称
user\_permission 用户权限
| | remove\_team\_member | 从团队中移除成员 | team\_id 团队 ID
team\_name 团队名称
user\_permission\_old 操作前的用户权限
| | leave\_team | 离开团队 | team\_id 团队 ID
team\_name 团队名称
user\_permission\_old 操作前的用户权限
| | change\_team\_member\_access | 修改团队成员权限 | team\_id 团队 ID
team\_name 团队名称
user\_permission\_old 操作前的用户权限
user\_permission\_new 操作后的用户权限
| | join\_team\_by\_invite\_link | 通过团队邀请链接加入团队 | team\_id 团队 ID
team\_name 团队名称
| | rename\_team | 重命名团队 | team\_name\_old 操作前的团队名称
team\_name\_new 操作后的团队名称
| | login | 登录 |

| | logout | 退出登录 |

| | remove\_org\_member | 移除企业成员 |

| | join\_org\_by\_access\_file | 访问文件加入企业 | file\_id 文档 ID
file\_name 文档名称
| | add\_org\_admin | 将企业成员设为企业管理员 |

| | remove\_org\_admin | 移除企业管理员 |

| | open\_file\_prototype | 访问文件原型 |

| | invite\_org\_member | 邀请用户加入企业 | seat\_type 席位类型 | | apply\_org\_seat\_when\_import\_file | 申请席位：导入文件 | seat\_type 席位类型
project\_id 项目 ID
project\_name 项目名称
| | apply\_org\_seat\_when\_create\_file | 申请席位：创建文件 | seat\_type 席位类型
project\_id 项目 ID
project\_name 项目名称
| | apply\_org\_seat\_when\_move\_file | 申请席位：移动文件 | seat\_type 席位类型
project\_id\_old 操作前的项目 ID
project\_name\_old 操作前的项目名称
project\_id\_new 操作后的项目 ID
project\_name\_new 操作后的项目名称
file\_id 文档 ID
file\_name 文档名称
| | apply\_org\_seat\_when\_edit\_file | 申请席位：编辑文件 | seat\_type 席位类型
file\_id 文档 ID
file\_name 文档名称
| | apply\_org\_seat\_when\_use\_dev\_mode | 申请席位：在文件中使用研发模式 | seat\_type 席位类型
file\_id 文档 ID
file\_name 文档名称
| | approve\_seat\_request | 通过席位申请 | seat\_type 席位类型 | | deny\_seat\_application | 拒绝席位申请 | seat\_type 席位类型 | | upgrade\_themselves\_when\_import\_file | 自主升级席位：导入文件 | seat\_type 席位类型
project\_id 项目 ID
project\_name 项目名称
| | upgrade\_themselves\_when\_create\_file | 自主升级席位：创建文件 | seat\_type 席位类型
project\_id 项目 ID
project\_name 项目名称
| | upgrade\_themselves\_when\_move\_file | 自主升级席位：移动文件 | seat\_type 席位类型
project\_id\_old 操作前的项目 ID
project\_name\_old 操作前的项目名称
project\_id\_new 操作后的项目 ID
project\_name\_new 操作后的项目名称
file\_id 文档 ID
file\_name 文档名称
| | upgrade\_themselves\_when\_edit\_file | 自主升级席位：编辑文件 | seat\_type 席位类型
file\_id 文档 ID
file\_name 文档名称
| | upgrade\_themselves\_when\_use\_dev\_mode | 自主升级席位：在文件中使用研发模式 | seat\_type 席位类型
file\_id 文档 ID
file\_name 文档名称
| | seat\_start\_billing\_as\_grace\_period\_ends | 席位结束宽限期开始计费 | seat\_type 席位类型 | | upgrade\_seat | 升级席位 | seat\_type\_old 操作前的席位类型
seat\_type\_new 操作后的席位类型
| | downgrade\_seat | 降级席位 | seat\_type\_old 操作前的席位类型
seat\_type\_new 操作后的席位类型
| | open\_org\_public\_link\_sharing | 启用对外链接分享 |

| | close\_org\_public\_link\_sharing | 禁用对外链接分享 |

| | upgrade\_themselves\_when\_batch\_move\_file | 自主升级席位：批量移动文件 | seat\_type 席位类型
project\_id 项目 ID
project\_name 项目名称
| | apply\_org\_seat\_when\_batch\_move\_file | 申请席位：批量移动文件 | seat\_type 席位类型
project\_id 项目 ID
project\_name 项目名称
| | enable\_file\_viewer\_permissions | 修改文件的可查看者权限为允许复制、分享、导出 |

| | disable\_file\_viewer\_permissions | 修改文件的可查看者权限为不允许复制、分享、导出 |

| | change\_team\_org\_access | 修改团队对企业的公开性 | team\_org\_access\_old 操作后的团队公开性配置
team\_org\_access\_new 操作前的团队公开性配置
| | upgrade\_themselves\_when\_share\_drafts\_v2 | 自主升级席位：分享草稿文件 | seat\_type 席位类型
file\_id 文档 ID
file\_name 文档名称
| | apply\_org\_seat\_when\_share\_drafts\_V2 | 申请席位：分享草稿文件 | seat\_type 席位类型
file\_id 文档 ID
file\_name 文档名称
|