事件名称*
例如:page_view、button_clicked
时间戳(ISO 8601)
2024-01-01T12:00:00Z
捕获事件(posthog_capture_event)
在 PostHog 中捕获单个事件。用于跟踪用户操作、页面浏览或自定义事件。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectApiKey | string | 是 | PostHog 项目 API 密钥 (用于事件采集的公开令牌) |
region | string | 否 | PostHog 区域:us(默认)或 eu |
event | string | 是 | 要捕获的事件名称(例如 "page_view"、"button_clicked") |
distinctId | string | 是 | 用户或设备的唯一标识符。可以是用户 ID、设备 ID 或匿名 ID |
properties | string | 否 | 事件属性的 JSON 字符串(例如 {"button_name": "signup", "page": "homepage"}) |
timestamp | string | 否 | 事件发生时间的 ISO 8601 时间戳。未提供时使用当前时间 |
输出
| 参数 | 类型 | 说明 |
|---|
status | string | 指示事件是否已成功捕获的状态消息 |
批量事件(JSON 数组)*
[{"event": "page_view", "distinct_id": "user123", "properties": {...}}]
批量事件 (posthog_batch_events)
在 PostHog 中一次性捕获多个事件。用于批量事件摄入以提高性能。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectApiKey | string | 是 | PostHog 项目 API 密钥 (用于事件摄入的公开令牌) |
region | string | 否 | PostHog 区域:us (默认) 或 eu |
batch | string | 是 | 要捕获的事件 JSON 数组。每个事件应包含:event、distinct_id,以及可选的 properties、timestamp。示例:[{"event": "page_view", "distinct_id": "user123", "properties": {"page": "/"}}] |
输出
| 参数 | 类型 | 说明 |
|---|
status | string | 指示该批次是否成功捕获的状态消息 |
eventsProcessed | number | 批次中已处理的事件数量 |
列出人物(posthog_list_persons)
列出 PostHog 中的人物(用户)。返回包含其属性和 distinct ID 的用户资料。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
personalApiKey | string | 是 | PostHog 个人 API 密钥 (用于已认证的 API 访问) |
region | string | 否 | PostHog 区域:us (默认) 或 eu |
projectId | string | 是 | PostHog 项目 ID |
limit | number | 否 | 返回的人物数量 (默认:100,最大:100) |
offset | number | 否 | 分页时跳过的人物数量 |
search | string | 否 | 按邮箱、姓名或 distinct ID 搜索人物 |
distinctId | string | 否 | 按指定 distinct_id 筛选 |
输出
| 参数 | 类型 | 说明 |
|---|
persons | array | 人物列表,包含其属性和标识符 |
next | string | 下一页结果的 URL (如有) |
获取人员 (posthog_get_person)
通过 ID 或 UUID 获取 PostHog 中特定人员的详细信息。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
personalApiKey | string | 是 | PostHog 个人 API 密钥(用于经过身份验证的 API 访问) |
region | string | 否 | PostHog 区域:us(默认)或 eu |
projectId | string | 是 | PostHog 项目 ID |
personId | string | 是 | 要获取的人员 ID 或 UUID |
输出
| 参数 | 类型 | 说明 |
|---|
person | object | 人员详情,包括属性和标识符 |
删除人物 (posthog_delete_person)
从 PostHog 中删除人物。这将移除所有关联的事件和数据。请谨慎使用。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
personalApiKey | string | 是 | PostHog 个人 API 密钥(用于经过身份验证的 API 访问) |
region | string | 否 | PostHog 区域:us(默认)或 eu |
projectId | string | 是 | PostHog 项目 ID |
personId | string | 是 | 要删除的人物 ID 或 UUID |
输出
| 参数 | 类型 | 说明 |
|---|
status | string | 指示人物是否已成功删除的状态消息 |
查询值 (JSON)
{"param1": "value1"}
运行查询 (HogQL) (posthog_query)
在 PostHog 中执行 HogQL 查询。HogQL 是 PostHog 用于分析的类 SQL 查询语言。可用于高级数据检索与分析。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
personalApiKey | string | 是 | PostHog 个人 API 密钥 (用于经过身份验证的 API 访问) |
region | string | 否 | PostHog 区域:us (默认) 或 eu |
projectId | string | 是 | PostHog 项目 ID |
query | string | 是 | 要执行的 HogQL 查询。示例:{"kind": "HogQLQuery", "query": "SELECT event, count() FROM events WHERE timestamp > now() - INTERVAL 1 DAY GROUP BY event"} |
values | string | 否 | 参数化查询的可选 JSON 参数值字符串。示例:{"user_id": "123"} |
输出
| 参数 | 类型 | 说明 |
|---|
results | array | 查询结果,以行数组形式返回 |
columns | array | 结果集中的列名 |
types | array | 结果集中各列的数据类型 |
hogql | string | 实际执行的 HogQL 查询 |
hasMore | boolean | 是否还有更多结果 |
列出洞察 (posthog_list_insights)
列出 PostHog 项目中的所有洞察。返回洞察配置、筛选条件和元数据。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu" (默认:"us") |
limit | number | 否 | 每页返回的结果数量 (默认:100) |
offset | number | 否 | 分页跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
count | number | 项目中的洞察总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
results | array | 洞察列表及其配置和元数据 |
获取洞察 (posthog_get_insight)
根据 ID 从 PostHog 获取指定洞察。返回洞察的详细配置、筛选条件和元数据。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
insightId | string | 是 | 要获取的洞察 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu" (默认:"us") |
输出
| 参数 | 类型 | 说明 |
|---|
id | number | 洞察的唯一标识符 |
name | string | 洞察名称 |
description | string | 洞察描述 |
filters | object | 洞察的筛选配置 |
query | object | 洞察的查询配置 |
created_at | string | 洞察创建时的 ISO 时间戳 |
created_by | object | 创建该洞察的用户 |
last_modified_at | string | 洞察上次修改时的 ISO 时间戳 |
last_modified_by | object | 上次修改该洞察的用户 |
saved | boolean | 洞察是否已保存 |
dashboards | array | 该洞察所在仪表盘的 ID |
tags | array | 与该洞察关联的标签 |
favorited | boolean | 洞察是否已收藏 |
筛选条件(JSON)
{"groups": [...]}
查询(JSON)
{"kind": "HogQLQuery", "query": "SELECT ..."}
仪表盘 ID(逗号分隔)
123, 456, 789
创建洞察 (posthog_create_insight)
在 PostHog 中创建新洞察。需要洞察名称以及筛选配置或查询。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu"(默认:"us") |
name | string | 否 | 洞察名称(可选 - 未提供时 PostHog 将生成派生名称) |
description | string | 否 | 洞察描述 |
filters | string | 否 | 洞察筛选配置的 JSON 字符串 |
query | string | 否 | 洞察查询配置的 JSON 字符串 |
dashboards | string | 否 | 要添加此洞察的仪表板 ID 列表,逗号分隔 |
tags | string | 否 | 洞察标签列表,逗号分隔 |
输出
| 参数 | 类型 | 说明 |
|---|
id | number | 已创建洞察的唯一标识符 |
name | string | 洞察名称 |
description | string | 洞察描述 |
filters | object | 洞察的筛选配置 |
query | object | 洞察的查询配置 |
created_at | string | 洞察创建时的 ISO 时间戳 |
created_by | object | 创建该洞察的用户 |
last_modified_at | string | 洞察上次修改时的 ISO 时间戳 |
saved | boolean | 洞察是否已保存 |
dashboards | array | 显示此洞察的仪表板 ID |
tags | array | 与该洞察关联的标签 |
列出仪表盘(posthog_list_dashboards)
列出 PostHog 项目中的所有仪表盘。返回仪表盘配置、图块和元数据。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu" (默认:"us") |
limit | number | 否 | 每页返回的结果数量 (默认:100) |
offset | number | 否 | 分页跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
count | number | 项目中的仪表盘总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
results | array | 仪表盘列表及其配置和元数据 |
获取仪表盘(posthog_get_dashboard)
根据 ID 从 PostHog 获取指定仪表盘。返回详细的仪表盘配置、磁贴和元数据。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
dashboardId | string | 是 | 要获取的仪表盘 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu" (默认:"us") |
输出
| 参数 | 类型 | 说明 |
|---|
id | number | 仪表盘的唯一标识符 |
name | string | 仪表盘名称 |
description | string | 仪表盘描述 |
pinned | boolean | 仪表盘是否已固定 |
created_at | string | 仪表盘创建时的 ISO 时间戳 |
created_by | object | 创建该仪表盘的用户 |
last_modified_at | string | 仪表盘上次修改时的 ISO 时间戳 |
last_modified_by | object | 上次修改该仪表盘的用户 |
tiles | array | 仪表盘上的磁贴/小组件及其配置 |
filters | object | 应用于仪表盘的全局筛选器 |
tags | array | 与仪表盘关联的标签 |
restriction_level | number | 仪表盘的访问限制级别 |
列出行为 (posthog_list_actions)
列出 PostHog 项目中的所有行为。返回行为定义、步骤和元数据。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu" (默认:"us") |
limit | number | 否 | 每页返回的结果数量 (默认:100) |
offset | number | 否 | 分页跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
count | number | 项目中行为的总数量 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
results | array | 包含定义和元数据的行为列表 |
列出群组(posthog_list_cohorts)
列出 PostHog 项目中的所有群组。返回群组定义、筛选条件和用户数量。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu" (默认:"us") |
limit | number | 否 | 每页返回的结果数量 (默认:100) |
offset | number | 否 | 分页时跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
count | number | 项目中的群组总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
results | array | 群组列表,包含定义和元数据 |
获取群组 (posthog_get_cohort)
根据 ID 从 PostHog 获取指定群组。返回详细的群组定义、筛选条件以及用户数量。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
cohortId | string | 是 | 要获取的群组 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu"(默认:"us") |
输出
| 参数 | 类型 | 说明 |
|---|
id | number | 群组的唯一标识符 |
name | string | 群组名称 |
description | string | 群组描述 |
groups | array | 定义该群组的分组 |
deleted | boolean | 群组是否已删除 |
filters | object | 群组的筛选配置 |
query | object | 群组的查询配置 |
created_at | string | 群组创建时的 ISO 时间戳 |
created_by | object | 创建该群组的用户 |
is_calculating | boolean | 群组是否正在计算 |
last_calculation | string | 上次计算的 ISO 时间戳 |
errors_calculating | number | 计算过程中的错误次数 |
count | number | 群组中的用户数量 |
is_static | boolean | 群组是否为静态 |
version | number | 群组版本号 |
筛选条件 (JSON)
{"groups": [...]}
分组 (JSON 数组)
[{"properties": [...]}]
创建队列(posthog_create_cohort)
在 PostHog 中创建新队列。需要队列名称以及筛选或查询配置。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu"(默认:"us") |
name | string | 否 | 队列名称(可选 - 未提供时 PostHog 将使用 "Untitled cohort") |
description | string | 否 | 队列描述 |
filters | string | 否 | 队列筛选配置的 JSON 字符串 |
query | string | 否 | 队列查询配置的 JSON 字符串 |
is_static | boolean | 否 | 队列是否为静态(默认:false) |
groups | string | 否 | 定义该队列的分组 JSON 字符串 |
输出
| 参数 | 类型 | 说明 |
|---|
id | number | 已创建队列的唯一标识符 |
name | string | 队列名称 |
description | string | 队列描述 |
groups | array | 定义该队列的分组 |
deleted | boolean | 队列是否已删除 |
filters | object | 队列的筛选配置 |
query | object | 队列的查询配置 |
created_at | string | 队列创建时的 ISO 时间戳 |
created_by | object | 创建该队列的用户 |
is_calculating | boolean | 队列是否正在计算 |
count | number | 队列中的用户数 |
is_static | boolean | 队列是否为静态 |
version | number | 队列版本号 |
列出注释 (posthog_list_annotations)
列出 PostHog 项目中的所有注释。返回注释内容、时间戳以及关联的洞察。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu"(默认:"us") |
limit | number | 否 | 每页返回的结果数量(默认:100) |
offset | number | 否 | 分页时跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
count | number | 项目中的注释总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
results | array | 包含内容和元数据的注释列表 |
日期标记 (ISO 8601)*
2024-01-01T12:00:00Z
创建注释(posthog_create_annotation)
在 PostHog 中创建新注释。用日期和描述在图表上标记重要事件。
输入
| 参数 | 类型 | 必填 | 描述 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:"us" 或 "eu" (默认:"us") |
content | string | 是 | 注释的内容/文本 |
date_marker | string | 是 | 标注注释生效时间的 ISO 时间戳 (例如:"2024-01-15T10:00:00Z") |
scope | string | 否 | 注释范围:"project" 或 "dashboard_item" (默认:"project") |
dashboard_item | string | 否 | 要将此注释附加到的仪表盘项 ID |
insight_short_id | string | 否 | 要将此注释附加到的洞察短 ID |
输出
| 参数 | 类型 | 描述 |
|---|
id | number | 所创建注释的唯一标识符 |
content | string | 注释的内容/文本 |
date_marker | string | 标注注释生效时间的 ISO 时间戳 |
created_at | string | 注释创建时的 ISO 时间戳 |
updated_at | string | 注释上次更新时的 ISO 时间戳 |
created_by | object | 创建该注释的用户 |
dashboard_item | number | 此注释所附加的仪表盘项 ID |
insight_short_id | string | 此注释所附加的洞察短 ID |
insight_name | string | 此注释所附加的洞察名称 |
scope | string | 注释范围 (project 或 dashboard_item) |
deleted | boolean | 注释是否已删除 |
列出功能开关 (posthog_list_feature_flags)
列出 PostHog 项目中的所有功能开关
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
limit | number | 否 | 返回结果数量 |
offset | number | 否 | 跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
results | array | 功能开关列表 |
count | number | 功能开关总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
获取功能标志 (posthog_get_feature_flag)
获取指定功能标志的详细信息
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
flagId | string | 是 | 功能标志 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
输出
筛选条件 (JSON)
{"groups": [...]}
创建功能标志 (posthog_create_feature_flag)
在 PostHog 中创建新的功能标志
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
name | string | 否 | 功能标志名称(可选,可为空) |
key | string | 是 | 功能标志键(唯一标识符) |
filters | string | 否 | 功能标志筛选条件,JSON 字符串 |
active | boolean | 否 | 标志是否启用(默认:true) |
ensureExperienceContinuity | boolean | 否 | 是否保证体验连续性(默认:false) |
rolloutPercentage | number | 否 | 发布百分比(0-100) |
输出
筛选条件 (JSON)
{"groups": [...]}
更新功能标志(posthog_update_feature_flag)
更新 PostHog 中的现有功能标志
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
flagId | string | 是 | 功能标志 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
name | string | 否 | 功能标志名称 |
key | string | 否 | 功能标志键 (唯一标识符) |
filters | string | 否 | 功能标志筛选条件,JSON 字符串 |
active | boolean | 否 | 标志是否启用 |
ensureExperienceContinuity | boolean | 否 | 是否确保体验连续性 |
rolloutPercentage | number | 否 | 发布百分比 (0-100) |
输出
删除功能标志 (posthog_delete_feature_flag)
从 PostHog 删除功能标志
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
flagId | string | 是 | 要删除的功能标志 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
输出
| 参数 | 类型 | 说明 |
|---|
success | boolean | 删除是否成功 |
message | string | 确认消息 |
群组 (JSON)
{"company": "company_id_in_your_db"}
用户属性 (JSON)
{"email": "user@example.com", "plan": "enterprise"}
群组属性 (JSON)
{"plan": "enterprise", "seats": 100}
评估标志(posthog_evaluate_flags)
为特定用户或组评估功能标志。这是使用项目 API 密钥的公开端点。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
region | string | 是 | PostHog 云区域:us 或 eu |
projectApiKey | string | 是 | PostHog 项目 API 密钥(非个人 API 密钥) |
distinctId | string | 是 | 要评估功能标志的用户 distinct ID |
groups | string | 否 | 组,JSON 字符串(例如 {"company": "company_id_in_your_db"}) |
personProperties | string | 否 | 用户属性,JSON 字符串 |
groupProperties | string | 否 | 组属性,JSON 字符串 |
输出
| 参数 | 类型 | 说明 |
|---|
featureFlags | object | 功能标志评估结果(键值对,值为布尔值或字符串变体) |
featureFlagPayloads | object | 附加到功能标志的额外载荷 |
errorsWhileComputingFlags | boolean | 计算功能标志时是否出错 |
列出实验(posthog_list_experiments)
列出 PostHog 项目中的所有实验
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
limit | number | 否 | 返回的结果数量 |
offset | number | 否 | 跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
results | array | 实验列表 |
count | number | 实验总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
获取实验 (posthog_get_experiment)
获取指定实验的详细信息
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
experimentId | string | 是 | 实验 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
输出
| 参数 | 类型 | 说明 |
|---|
experiment | object | 实验详情 |
筛选条件 (JSON)
{"groups": [...]}
功能标志键*
experiment_flag_key
参数 (JSON)
{"minimum_detectable_effect": 5}
变体 (JSON)
{"control": 50, "test": 50}
开始日期 (ISO 8601)
2024-01-01T00:00:00Z
结束日期 (ISO 8601)
2024-12-31T23:59:59Z
创建实验(posthog_create_experiment)
在 PostHog 中创建新实验
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
name | string | 否 | 实验名称 (可选) |
description | string | 否 | 实验描述 |
featureFlagKey | string | 是 | 用于该实验的功能标志键 |
parameters | string | 否 | 实验参数(JSON 字符串) |
filters | string | 否 | 实验筛选条件(JSON 字符串) |
variants | string | 否 | 实验变体(JSON 字符串) |
startDate | string | 否 | 实验开始日期 (ISO 格式) |
endDate | string | 否 | 实验结束日期 (ISO 格式) |
输出
| 参数 | 类型 | 说明 |
|---|
experiment | object | 已创建的实验 |
列出问卷 (posthog_list_surveys)
列出 PostHog 项目中的全部问卷。问卷用于收集用户反馈。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:us 或 eu (默认:us) |
limit | number | 否 | 返回结果数量 (默认:100) |
offset | number | 否 | 分页跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
surveys | array | 项目中的问卷列表 |
count | number | 问卷总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
获取问卷(posthog_get_survey)
根据 ID 获取 PostHog 中指定问卷的详细信息。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
surveyId | string | 是 | 要获取的问卷 ID |
region | string | 否 | PostHog 云区域:us 或 eu(默认:us) |
输出
问题(JSON 数组)*
[{"type": "open", "question": "你觉得怎么样?"}]
开始日期(ISO 8601)
2024-01-01T00:00:00Z
结束日期(ISO 8601)
2024-12-31T23:59:59Z
外观(JSON)
{"backgroundColor": "#ffffff", "position": "right"}
条件(JSON)
{"url": "contains", "value": "/checkout"}
定向开关筛选(JSON)
{"groups": [...]}
创建问卷(posthog_create_survey)
在 PostHog 中创建新问卷。支持的问题类型:基础(开放式)、链接、评分和多选题。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:us 或 eu(默认:us) |
name | string | 否 | 问卷名称(可选) |
description | string | 否 | 问卷描述 |
type | string | 否 | 问卷类型:popover(应用内)或 api(自定义实现)(默认:popover) |
questions | string | 是 | 问卷问题数组的 JSON 字符串。每个问题必须包含 type(open/link/rating/multiple_choice)和问题文本。评分题可包含 scale(1-10)、lowerBoundLabel、upperBoundLabel。多选题需要 choices 数组。链接题可包含 buttonText。 |
startDate | string | 否 | 问卷开始日期,ISO 8601 格式 |
endDate | string | 否 | 问卷结束日期,ISO 8601 格式 |
appearance | string | 否 | 外观配置的 JSON 字符串(颜色、位置等) |
conditions | string | 否 | 显示条件的 JSON 字符串(URL 匹配等) |
targetingFlagFilters | string | 否 | 用于定向的功能标志筛选器 JSON 字符串 |
linkedFlagId | string | 否 | 要关联到此问卷的功能标志 ID |
responsesLimit | number | 否 | 要收集的最大回复数 |
输出
| 参数 | 类型 | 说明 |
|---|
survey | object | 已创建的问卷详情 |
问题(JSON 数组)
[{"type": "open", "question": "What do you think?"}]
开始日期(ISO 8601)
2024-01-01T00:00:00Z
结束日期(ISO 8601)
2024-12-31T23:59:59Z
外观(JSON)
{"backgroundColor": "#ffffff", "position": "right"}
条件(JSON)
{"url": "contains", "value": "/checkout"}
定向标志筛选器(JSON)
{"groups": [...]}
更新调查问卷(posthog_update_survey)
更新 PostHog 中的现有调查问卷。可修改问题、外观、条件及其他设置。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
surveyId | string | 是 | 要更新的调查问卷 ID |
region | string | 否 | PostHog 云区域:us 或 eu (默认:us) |
name | string | 否 | 调查问卷名称 |
description | string | 否 | 调查问卷描述 |
type | string | 否 | 调查问卷类型:popover 或 api |
questions | string | 否 | 调查问卷问题数组的 JSON 字符串。每个问题必须包含 type (open/link/rating/multiple_choice) 和问题文本。 |
startDate | string | 否 | 调查问卷开始日期,ISO 8601 格式 |
endDate | string | 否 | 调查问卷结束日期,ISO 8601 格式 |
appearance | string | 否 | 外观配置的 JSON 字符串 (颜色、位置等) |
conditions | string | 否 | 显示条件的 JSON 字符串 (URL 匹配等) |
targetingFlagFilters | string | 否 | 用于定向的功能标志筛选器 JSON 字符串 |
linkedFlagId | string | 否 | 关联到此调查问卷的功能标志 ID |
responsesLimit | number | 否 | 要收集的最大回复数 |
archived | boolean | 否 | 归档或取消归档该调查问卷 |
输出
| 参数 | 类型 | 说明 |
|---|
survey | object | 更新后的问卷详情 |
列出会话录制 (posthog_list_session_recordings)
列出 PostHog 项目中的会话录制。会话录制会捕获用户与应用的交互。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:us 或 eu (默认:us) |
limit | number | 否 | 返回的结果数量 (默认:50) |
offset | number | 否 | 分页跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
recordings | array | 会话录制列表 |
count | number | 录制总数 |
next | string | 结果下一页的 URL |
previous | string | 结果上一页的 URL |
获取会话录制(posthog_get_session_recording)
按 ID 获取 PostHog 中指定会话录制的详细信息。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
recordingId | string | 是 | 要获取的会话录制 ID |
region | string | 否 | PostHog 云区域:us 或 eu(默认:us) |
输出
| 参数 | 类型 | 说明 |
|---|
recording | object | 会话录制详情 |
列出录制播放列表 (posthog_list_recording_playlists)
列出 PostHog 项目中的会话录制播放列表。播放列表用于整理和筛选会话录制。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
projectId | string | 是 | PostHog 项目 ID |
region | string | 否 | PostHog 云区域:us 或 eu (默认:us) |
limit | number | 否 | 返回结果数量 (默认:100) |
offset | number | 否 | 分页时跳过的结果数量 |
输出
| 参数 | 类型 | 说明 |
|---|
playlists | array | 会话录制播放列表 |
count | number | 播放列表总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
列出事件定义(posthog_list_event_definitions)
列出 PostHog 项目中的所有事件定义。事件定义表示已追踪的事件,并包含描述、标签和使用统计等元数据。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
limit | number | 否 | 每页返回的结果数量(默认:100) |
offset | number | 否 | 返回结果的起始索引 |
search | string | 否 | 按名称筛选事件定义的搜索词 |
输出
| 参数 | 类型 | 说明 |
|---|
count | number | 事件定义总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
results | array | 事件定义列表 |
获取事件定义(posthog_get_event_definition)
获取 PostHog 中特定事件定义的详细信息。返回该事件的完整信息,包括元数据、使用统计和验证状态。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
eventDefinitionId | string | 是 | 要获取的事件定义 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
输出
| 参数 | 类型 | 说明 |
|---|
id | string | 事件定义的唯一标识符 |
name | string | 事件名称 |
description | string | 事件描述 |
tags | array | 与该事件关联的标签 |
volume_30_day | number | 过去 30 天收到的事件数 |
query_usage_30_day | number | 过去 30 天该事件被查询的次数 |
created_at | string | 事件创建时的 ISO 时间戳 |
last_seen_at | string | 事件最后出现时的 ISO 时间戳 |
updated_at | string | 事件更新时的 ISO 时间戳 |
updated_by | object | 最后更新该事件的用户 |
verified | boolean | 该事件是否已验证 |
verified_at | string | 事件验证时的 ISO 时间戳 |
verified_by | string | 验证该事件的用户 |
更新事件定义(posthog_update_event_definition)
更新 PostHog 中的事件定义。可修改描述、标签和验证状态,以保持事件架构整洁。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
eventDefinitionId | string | 是 | 要更新的事件定义 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
description | string | 否 | 事件的更新描述 |
tags | string | 否 | 与该事件关联的标签,逗号分隔 |
verified | boolean | 否 | 是否将事件标记为已验证 |
输出
| 参数 | 类型 | 说明 |
|---|
id | string | 事件定义的唯一标识符 |
name | string | 事件名称 |
description | string | 更新后的事件描述 |
tags | array | 与该事件关联的更新后标签 |
volume_30_day | number | 过去 30 天收到的事件数量 |
query_usage_30_day | number | 过去 30 天该事件被查询的次数 |
created_at | string | 事件创建时的 ISO 时间戳 |
last_seen_at | string | 事件上次出现时的 ISO 时间戳 |
updated_at | string | 事件更新时的 ISO 时间戳 |
updated_by | object | 上次更新该事件的用户 |
verified | boolean | 事件是否已验证 |
verified_at | string | 事件验证时的 ISO 时间戳 |
verified_by | string | 验证该事件的用户 |
列出属性定义 (posthog_list_property_definitions)
列出 PostHog 项目中的所有属性定义。属性定义表示带有描述、标签、类型和使用统计等元数据的已追踪属性。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
limit | number | 否 | 每页返回的结果数量 (默认:100) |
offset | number | 否 | 返回结果的起始索引 |
search | string | 否 | 按名称筛选属性定义的搜索词 |
type | string | 否 | 按属性类型筛选:event、person 或 group |
输出
| 参数 | 类型 | 说明 |
|---|
count | number | 属性定义总数 |
next | string | 下一页结果的 URL |
previous | string | 上一页结果的 URL |
results | array | 属性定义列表 |
获取属性定义(posthog_get_property_definition)
获取 PostHog 中特定属性定义的详细信息。返回该属性的完整信息,包括元数据、类型、使用统计和验证状态。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
propertyDefinitionId | string | 是 | 要获取的属性定义 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
输出
| 参数 | 类型 | 说明 |
|---|
id | string | 属性定义的唯一标识符 |
name | string | 属性名称 |
description | string | 属性描述 |
tags | array | 与该属性关联的标签 |
is_numerical | boolean | 该属性是否为数值类型 |
is_seen_on_filtered_events | boolean | 该属性是否出现在已筛选事件中 |
property_type | string | 属性的数据类型 |
type | string | 属性类型:event、person 或 group |
volume_30_day | number | 过去 30 天内该属性出现的次数 |
query_usage_30_day | number | 过去 30 天内该属性被查询的次数 |
created_at | string | 属性创建时的 ISO 时间戳 |
updated_at | string | 属性更新时的 ISO 时间戳 |
updated_by | object | 最后更新该属性的用户 |
verified | boolean | 该属性是否已验证 |
verified_at | string | 属性验证时的 ISO 时间戳 |
verified_by | string | 验证该属性的用户 |
example | string | 该属性的示例值 |
更新属性定义(posthog_update_property_definition)
更新 PostHog 中的属性定义。可修改描述、标签、属性类型和验证状态,以保持属性架构整洁。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | PostHog 项目 ID |
propertyDefinitionId | string | 是 | 要更新的属性定义 ID |
region | string | 是 | PostHog 云区域:us 或 eu |
apiKey | string | 是 | PostHog 个人 API 密钥 |
description | string | 否 | 属性的更新描述 |
tags | string | 否 | 要与该属性关联的标签列表,以逗号分隔 |
verified | boolean | 否 | 是否将该属性标记为已验证 |
property_type | string | 否 | 属性的数据类型 (例如 String、Numeric、Boolean、DateTime 等) |
输出
| 参数 | 类型 | 说明 |
|---|
id | string | 属性定义的唯一标识符 |
name | string | 属性名称 |
description | string | 更新后的属性描述 |
tags | array | 与该属性关联的更新后标签 |
is_numerical | boolean | 该属性是否为数值类型 |
is_seen_on_filtered_events | boolean | 该属性是否出现在已筛选事件上 |
property_type | string | 属性的数据类型 |
type | string | 属性类型:event、person 或 group |
volume_30_day | number | 过去 30 天内该属性出现的次数 |
query_usage_30_day | number | 过去 30 天内该属性被查询的次数 |
created_at | string | 属性创建时的 ISO 时间戳 |
updated_at | string | 属性更新时的 ISO 时间戳 |
updated_by | object | 最后更新该属性的用户 |
verified | boolean | 该属性是否已验证 |
verified_at | string | 属性验证时的 ISO 时间戳 |
verified_by | string | 验证该属性的用户 |
example | string | 属性的示例值 |
列出项目 (posthog_list_projects)
列出组织中的所有项目。返回项目详情,包括 ID、名称、API 令牌和设置。可用于获取其他端点所需的项目 ID。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
region | string | 否 | 云区域:us 或 eu (默认:us) |
输出
| 参数 | 类型 | 说明 |
|---|
projects | array | 项目列表,包含其配置和设置 |
获取项目 (posthog_get_project)
按 ID 获取特定项目的详细信息。返回完整的项目配置、设置和功能标志。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
projectId | string | 是 | 项目 ID (数字 ID 或 UUID) |
apiKey | string | 是 | PostHog 个人 API 密钥 |
region | string | 否 | 云区域:us 或 eu (默认:us) |
输出
| 参数 | 类型 | 说明 |
|---|
project | object | 包含全部配置设置的详细项目信息 |
列出组织 (posthog_list_organizations)
列出用户有权访问的所有组织。返回组织详情,包括名称、slug、成员级别和可用产品功能。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
apiKey | string | 是 | PostHog 个人 API 密钥 |
region | string | 否 | 云区域:us 或 eu(默认:us) |
输出
| 参数 | 类型 | 说明 |
|---|
organizations | array | 包含设置和功能的组织列表 |
获取组织(posthog_get_organization)
根据 ID 获取指定组织的详细信息。返回完整的组织设置、功能、用量和团队信息。
输入
| 参数 | 类型 | 必填 | 说明 |
|---|
organizationId | string | 是 | 组织 ID (UUID) |
apiKey | string | 是 | PostHog 个人 API 密钥 |
region | string | 否 | 云区域:us 或 eu (默认:us) |
输出
| 参数 | 类型 | 说明 |
|---|
organization | object | 包含设置和功能的详细组织信息 |
将 PostHog 集成到你的工作流中。跟踪事件、管理功能标志、分析用户行为、运行实验、创建问卷,并访问会话录制。