活动日志 API

使用活动日志 API 查看企业中发生的事件。

入门

谁可以使用活动日志 API

• 活动日志 API 仅适用于企业版。
• 只有企业管理员才能生成访问令牌。

活动日志 API 允许你对企业事件进行编程访问，你可以查看任意企业中成员和访客在企业中发生的事件，你可以使用活动日志 API 构建你的自定义应用程序。

生成企业访问令牌

1. 1.在侧边栏点击「企业管理」。
2. 2.进入「设置」页。
3. 3.点击「企业访问令牌」。
4. 4.点击「生成访问令牌」。
5. 5.设置令牌的名称和过期时间。
6. 6.点击「生成令牌」。生成后请立刻复制并妥善保管令牌，一旦关闭弹窗，将没有机会再次查看。

使用企业访问令牌

你可以通过将令牌传递到 Authorization: Bearer <token> 请求头中来调用 API。 以下是一个示例：

curl 'https://api.motiff.cn/api/v1/organizations/activity_logs?orgId=${orgId}' \
--header 'Authorization: Bearer <TOKEN>'

Endpoints

返回活动日志事件列表。

HTTP Endpoint

GET /api/v1/organizations/activity_logs

注：只能查询到 2024 年 9 月 15 日之后的事件。

Error codes

使用查询字符串参数向你的请求添加过滤器。你可以添加路径参数的组合来创建特定查询。以下是一些示例：

• 获取过去所有管理员修改席位的记录

curl -H 'Authorization: Bearer <TOKEN>'  
'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 之间的所有创建团队事件

curl -H 'Authorization: Bearer <TOKEN>' 
'https://api.motiff.cn/api/v1/organizations/activity_logs?
orgId=xxx&actionTypes=create_team&startTime=1717222800000&endTime=1722534308000'

• 事件总数超过 limit 上限时，使用响应中的 cursor 字段获取下一批事件，需要将 orgId 和 cursor 参数添加到新的查询字符串中

curl -H 'Authorization: Bearer <TOKEN>' 
'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表示相关的元数据。查看支持的操作类型和对应元数据
• entity 是被 actor 执行操作的实体。它可以是用户、文件、项目或其他资源类型。查看支持的 entity 类型和属性
• context 包含事件的其他上下文信息：
  • orgId: 事件发生所在企业的 ID。
  • teamId: 事件发生所在团队的 ID。

此示例显示管理员邀请用户加入企业时记录的事件：

{
    "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

File

Project

Team

Organization

Action Types

以下是你可以在 API 响应的 action 字段下找到的操作类型：