PostHog

产品分析与功能管理

配置

捕获事件

操作
捕获事件
区域
美国云
项目 API 密钥*
••••••••
事件名称*
例如:page_view、button_clicked
唯一 ID*
用户的唯一标识符
属性(JSON)
{"key": "value"}
时间戳(ISO 8601)
2024-01-01T12:00:00Z
捕获事件(posthog_capture_event)

在 PostHog 中捕获单个事件。用于跟踪用户操作、页面浏览或自定义事件。

输入
参数类型必填说明
projectApiKeystring是PostHog 项目 API 密钥 (用于事件采集的公开令牌)
regionstring否PostHog 区域:us(默认)或 eu
eventstring是要捕获的事件名称(例如 "page_view"、"button_clicked")
distinctIdstring是用户或设备的唯一标识符。可以是用户 ID、设备 ID 或匿名 ID
propertiesstring否事件属性的 JSON 字符串(例如 {"button_name": "signup", "page": "homepage"})
timestampstring否事件发生时间的 ISO 8601 时间戳。未提供时使用当前时间
输出
参数类型说明
statusstring指示事件是否已成功捕获的状态消息

批量事件

操作
批量事件
区域
美国云
项目 API 密钥*
••••••••
批量事件(JSON 数组)*
[{"event": "page_view", "distinct_id": "user123", "properties": {...}}]
批量事件 (posthog_batch_events)

在 PostHog 中一次性捕获多个事件。用于批量事件摄入以提高性能。

输入
参数类型必填说明
projectApiKeystring是PostHog 项目 API 密钥 (用于事件摄入的公开令牌)
regionstring否PostHog 区域:us (默认) 或 eu
batchstring是要捕获的事件 JSON 数组。每个事件应包含:event、distinct_id,以及可选的 properties、timestamp。示例:[{"event": "page_view", "distinct_id": "user123", "properties": {"page": "/"}}]
输出
参数类型说明
statusstring指示该批次是否成功捕获的状态消息
eventsProcessednumber批次中已处理的事件数量

列出人物

操作
列出人物
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
唯一 ID 筛选
user123
限制
100
偏移
0
搜索
搜索查询
列出人物(posthog_list_persons)

列出 PostHog 中的人物(用户)。返回包含其属性和 distinct ID 的用户资料。

输入
参数类型必填说明
personalApiKeystring是PostHog 个人 API 密钥 (用于已认证的 API 访问)
regionstring否PostHog 区域:us (默认) 或 eu
projectIdstring是PostHog 项目 ID
limitnumber否返回的人物数量 (默认:100,最大:100)
offsetnumber否分页时跳过的人物数量
searchstring否按邮箱、姓名或 distinct ID 搜索人物
distinctIdstring否按指定 distinct_id 筛选
输出
参数类型说明
personsarray人物列表,包含其属性和标识符
nextstring下一页结果的 URL (如有)

获取人物

操作
获取人物
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
人物 ID*
人物 ID 或 UUID
获取人员 (posthog_get_person)

通过 ID 或 UUID 获取 PostHog 中特定人员的详细信息。

输入
参数类型必填说明
personalApiKeystring是PostHog 个人 API 密钥(用于经过身份验证的 API 访问)
regionstring否PostHog 区域:us(默认)或 eu
projectIdstring是PostHog 项目 ID
personIdstring是要获取的人员 ID 或 UUID
输出
参数类型说明
personobject人员详情,包括属性和标识符

删除人员

操作
删除人员
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
人员 ID*
人员 ID 或 UUID
删除人物 (posthog_delete_person)

从 PostHog 中删除人物。这将移除所有关联的事件和数据。请谨慎使用。

输入
参数类型必填说明
personalApiKeystring是PostHog 个人 API 密钥(用于经过身份验证的 API 访问)
regionstring否PostHog 区域:us(默认)或 eu
projectIdstring是PostHog 项目 ID
personIdstring是要删除的人物 ID 或 UUID
输出
参数类型说明
statusstring指示人物是否已成功删除的状态消息

运行查询 (HogQL)

操作
运行查询 (HogQL)
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
查询*
HogQL 查询或 JSON 对象
查询值 (JSON)
{"param1": "value1"}
运行查询 (HogQL) (posthog_query)

在 PostHog 中执行 HogQL 查询。HogQL 是 PostHog 用于分析的类 SQL 查询语言。可用于高级数据检索与分析。

输入
参数类型必填说明
personalApiKeystring是PostHog 个人 API 密钥 (用于经过身份验证的 API 访问)
regionstring否PostHog 区域:us (默认) 或 eu
projectIdstring是PostHog 项目 ID
querystring是要执行的 HogQL 查询。示例:{"kind": "HogQLQuery", "query": "SELECT event, count() FROM events WHERE timestamp > now() - INTERVAL 1 DAY GROUP BY event"}
valuesstring否参数化查询的可选 JSON 参数值字符串。示例:{"user_id": "123"}
输出
参数类型说明
resultsarray查询结果,以行数组形式返回
columnsarray结果集中的列名
typesarray结果集中各列的数据类型
hogqlstring实际执行的 HogQL 查询
hasMoreboolean是否还有更多结果

列出洞察

操作
列出洞察
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出洞察 (posthog_list_insights)

列出 PostHog 项目中的所有洞察。返回洞察配置、筛选条件和元数据。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu" (默认:"us")
limitnumber否每页返回的结果数量 (默认:100)
offsetnumber否分页跳过的结果数量
输出
参数类型说明
countnumber项目中的洞察总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL
resultsarray洞察列表及其配置和元数据

获取洞察

操作
获取洞察
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
洞察 ID*
洞察 ID
获取洞察 (posthog_get_insight)

根据 ID 从 PostHog 获取指定洞察。返回洞察的详细配置、筛选条件和元数据。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
insightIdstring是要获取的洞察 ID
regionstring否PostHog 云区域:"us" 或 "eu" (默认:"us")
输出
参数类型说明
idnumber洞察的唯一标识符
namestring洞察名称
descriptionstring洞察描述
filtersobject洞察的筛选配置
queryobject洞察的查询配置
created_atstring洞察创建时的 ISO 时间戳
created_byobject创建该洞察的用户
last_modified_atstring洞察上次修改时的 ISO 时间戳
last_modified_byobject上次修改该洞察的用户
savedboolean洞察是否已保存
dashboardsarray该洞察所在仪表盘的 ID
tagsarray与该洞察关联的标签
favoritedboolean洞察是否已收藏

创建洞察

操作
创建洞察
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
名称
输入名称
描述
输入描述
筛选条件(JSON)
{"groups": [...]}
查询(JSON)
{"kind": "HogQLQuery", "query": "SELECT ..."}
仪表盘 ID(逗号分隔)
123, 456, 789
标签(逗号分隔)
分析, 收入, 重要
创建洞察 (posthog_create_insight)

在 PostHog 中创建新洞察。需要洞察名称以及筛选配置或查询。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu"(默认:"us")
namestring否洞察名称(可选 - 未提供时 PostHog 将生成派生名称)
descriptionstring否洞察描述
filtersstring否洞察筛选配置的 JSON 字符串
querystring否洞察查询配置的 JSON 字符串
dashboardsstring否要添加此洞察的仪表板 ID 列表,逗号分隔
tagsstring否洞察标签列表,逗号分隔
输出
参数类型说明
idnumber已创建洞察的唯一标识符
namestring洞察名称
descriptionstring洞察描述
filtersobject洞察的筛选配置
queryobject洞察的查询配置
created_atstring洞察创建时的 ISO 时间戳
created_byobject创建该洞察的用户
last_modified_atstring洞察上次修改时的 ISO 时间戳
savedboolean洞察是否已保存
dashboardsarray显示此洞察的仪表板 ID
tagsarray与该洞察关联的标签

列出仪表盘

操作
列出仪表盘
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
条数上限
100
偏移量
0
列出仪表盘(posthog_list_dashboards)

列出 PostHog 项目中的所有仪表盘。返回仪表盘配置、图块和元数据。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu" (默认:"us")
limitnumber否每页返回的结果数量 (默认:100)
offsetnumber否分页跳过的结果数量
输出
参数类型说明
countnumber项目中的仪表盘总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL
resultsarray仪表盘列表及其配置和元数据

获取仪表盘

操作
获取仪表盘
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
仪表盘 ID*
仪表盘 ID
获取仪表盘(posthog_get_dashboard)

根据 ID 从 PostHog 获取指定仪表盘。返回详细的仪表盘配置、磁贴和元数据。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
dashboardIdstring是要获取的仪表盘 ID
regionstring否PostHog 云区域:"us" 或 "eu" (默认:"us")
输出
参数类型说明
idnumber仪表盘的唯一标识符
namestring仪表盘名称
descriptionstring仪表盘描述
pinnedboolean仪表盘是否已固定
created_atstring仪表盘创建时的 ISO 时间戳
created_byobject创建该仪表盘的用户
last_modified_atstring仪表盘上次修改时的 ISO 时间戳
last_modified_byobject上次修改该仪表盘的用户
tilesarray仪表盘上的磁贴/小组件及其配置
filtersobject应用于仪表盘的全局筛选器
tagsarray与仪表盘关联的标签
restriction_levelnumber仪表盘的访问限制级别

列出行为

操作
列出行为
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出行为 (posthog_list_actions)

列出 PostHog 项目中的所有行为。返回行为定义、步骤和元数据。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu" (默认:"us")
limitnumber否每页返回的结果数量 (默认:100)
offsetnumber否分页跳过的结果数量
输出
参数类型说明
countnumber项目中行为的总数量
nextstring下一页结果的 URL
previousstring上一页结果的 URL
resultsarray包含定义和元数据的行为列表

列出群体

操作
列出群体
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出群组(posthog_list_cohorts)

列出 PostHog 项目中的所有群组。返回群组定义、筛选条件和用户数量。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu" (默认:"us")
limitnumber否每页返回的结果数量 (默认:100)
offsetnumber否分页时跳过的结果数量
输出
参数类型说明
countnumber项目中的群组总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL
resultsarray群组列表,包含定义和元数据

获取群组

操作
获取群组
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
群组 ID*
群组 ID
获取群组 (posthog_get_cohort)

根据 ID 从 PostHog 获取指定群组。返回详细的群组定义、筛选条件以及用户数量。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
cohortIdstring是要获取的群组 ID
regionstring否PostHog 云区域:"us" 或 "eu"(默认:"us")
输出
参数类型说明
idnumber群组的唯一标识符
namestring群组名称
descriptionstring群组描述
groupsarray定义该群组的分组
deletedboolean群组是否已删除
filtersobject群组的筛选配置
queryobject群组的查询配置
created_atstring群组创建时的 ISO 时间戳
created_byobject创建该群组的用户
is_calculatingboolean群组是否正在计算
last_calculationstring上次计算的 ISO 时间戳
errors_calculatingnumber计算过程中的错误次数
countnumber群组中的用户数量
is_staticboolean群组是否为静态
versionnumber群组版本号

创建队列

操作
创建队列
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
查询
HogQL 查询或 JSON 对象
名称
输入名称
描述
输入描述
筛选条件 (JSON)
{"groups": [...]}
分组 (JSON 数组)
[{"properties": [...]}]
静态队列
Disabled
创建队列(posthog_create_cohort)

在 PostHog 中创建新队列。需要队列名称以及筛选或查询配置。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu"(默认:"us")
namestring否队列名称(可选 - 未提供时 PostHog 将使用 "Untitled cohort")
descriptionstring否队列描述
filtersstring否队列筛选配置的 JSON 字符串
querystring否队列查询配置的 JSON 字符串
is_staticboolean否队列是否为静态(默认:false)
groupsstring否定义该队列的分组 JSON 字符串
输出
参数类型说明
idnumber已创建队列的唯一标识符
namestring队列名称
descriptionstring队列描述
groupsarray定义该队列的分组
deletedboolean队列是否已删除
filtersobject队列的筛选配置
queryobject队列的查询配置
created_atstring队列创建时的 ISO 时间戳
created_byobject创建该队列的用户
is_calculatingboolean队列是否正在计算
countnumber队列中的用户数
is_staticboolean队列是否为静态
versionnumber队列版本号

列出注释

操作
列出注释
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出注释 (posthog_list_annotations)

列出 PostHog 项目中的所有注释。返回注释内容、时间戳以及关联的洞察。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu"(默认:"us")
limitnumber否每页返回的结果数量(默认:100)
offsetnumber否分页时跳过的结果数量
输出
参数类型说明
countnumber项目中的注释总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL
resultsarray包含内容和元数据的注释列表

创建注释

操作
创建注释
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
名称
输入名称
内容*
注释内容
日期标记 (ISO 8601)*
2024-01-01T12:00:00Z
范围
项目
创建注释(posthog_create_annotation)

在 PostHog 中创建新注释。用日期和描述在图表上标记重要事件。

输入
参数类型必填描述
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:"us" 或 "eu" (默认:"us")
contentstring是注释的内容/文本
date_markerstring是标注注释生效时间的 ISO 时间戳 (例如:"2024-01-15T10:00:00Z")
scopestring否注释范围:"project" 或 "dashboard_item" (默认:"project")
dashboard_itemstring否要将此注释附加到的仪表盘项 ID
insight_short_idstring否要将此注释附加到的洞察短 ID
输出
参数类型描述
idnumber所创建注释的唯一标识符
contentstring注释的内容/文本
date_markerstring标注注释生效时间的 ISO 时间戳
created_atstring注释创建时的 ISO 时间戳
updated_atstring注释上次更新时的 ISO 时间戳
created_byobject创建该注释的用户
dashboard_itemnumber此注释所附加的仪表盘项 ID
insight_short_idstring此注释所附加的洞察短 ID
insight_namestring此注释所附加的洞察名称
scopestring注释范围 (project 或 dashboard_item)
deletedboolean注释是否已删除

列出功能标志

操作
列出功能标志
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出功能开关 (posthog_list_feature_flags)

列出 PostHog 项目中的所有功能开关

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
limitnumber否返回结果数量
offsetnumber否跳过的结果数量
输出
参数类型说明
resultsarray功能开关列表
countnumber功能开关总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL

获取功能开关

操作
获取功能开关
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
功能开关 ID*
功能开关 ID
获取功能标志 (posthog_get_feature_flag)

获取指定功能标志的详细信息

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
flagIdstring是功能标志 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
输出
参数类型说明
flagobject功能标志详情

创建功能标志

操作
创建功能标志
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
名称
输入名称
描述
输入描述
标志键*
feature_flag_key
筛选条件 (JSON)
{"groups": [...]}
启用
Disabled
放量百分比
100
确保体验连续性
Disabled
创建功能标志 (posthog_create_feature_flag)

在 PostHog 中创建新的功能标志

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
namestring否功能标志名称(可选,可为空)
keystring是功能标志键(唯一标识符)
filtersstring否功能标志筛选条件,JSON 字符串
activeboolean否标志是否启用(默认:true)
ensureExperienceContinuityboolean否是否保证体验连续性(默认:false)
rolloutPercentagenumber否发布百分比(0-100)
输出
参数类型说明
flagobject已创建的功能标志

更新功能标志

操作
更新功能标志
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
功能标志 ID*
功能标志 ID
名称
输入名称
描述
输入描述
标志键
feature_flag_key
筛选条件 (JSON)
{"groups": [...]}
启用
Disabled
发布百分比
100
保证体验连续性
Disabled
更新功能标志(posthog_update_feature_flag)

更新 PostHog 中的现有功能标志

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
flagIdstring是功能标志 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
namestring否功能标志名称
keystring否功能标志键 (唯一标识符)
filtersstring否功能标志筛选条件,JSON 字符串
activeboolean否标志是否启用
ensureExperienceContinuityboolean否是否确保体验连续性
rolloutPercentagenumber否发布百分比 (0-100)
输出
参数类型说明
flagobject已更新的功能标志

删除功能标志

操作
删除功能标志
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
功能标志 ID*
功能标志 ID
删除功能标志 (posthog_delete_feature_flag)

从 PostHog 删除功能标志

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
flagIdstring是要删除的功能标志 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
输出
参数类型说明
successboolean删除是否成功
messagestring确认消息

评估标志

操作
评估标志
区域
美国云
项目 API 密钥*
••••••••
唯一 ID*
用户的唯一标识符
群组 (JSON)
{"company": "company_id_in_your_db"}
用户属性 (JSON)
{"email": "user@example.com", "plan": "enterprise"}
群组属性 (JSON)
{"plan": "enterprise", "seats": 100}
评估标志(posthog_evaluate_flags)

为特定用户或组评估功能标志。这是使用项目 API 密钥的公开端点。

输入
参数类型必填说明
regionstring是PostHog 云区域:us 或 eu
projectApiKeystring是PostHog 项目 API 密钥(非个人 API 密钥)
distinctIdstring是要评估功能标志的用户 distinct ID
groupsstring否组,JSON 字符串(例如 {"company": "company_id_in_your_db"})
personPropertiesstring否用户属性,JSON 字符串
groupPropertiesstring否组属性,JSON 字符串
输出
参数类型说明
featureFlagsobject功能标志评估结果(键值对,值为布尔值或字符串变体)
featureFlagPayloadsobject附加到功能标志的额外载荷
errorsWhileComputingFlagsboolean计算功能标志时是否出错

列出实验

操作
列出实验
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出实验(posthog_list_experiments)

列出 PostHog 项目中的所有实验

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
limitnumber否返回的结果数量
offsetnumber否跳过的结果数量
输出
参数类型说明
resultsarray实验列表
countnumber实验总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL

获取实验

操作
获取实验
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
实验 ID*
实验 ID
获取实验 (posthog_get_experiment)

获取指定实验的详细信息

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
experimentIdstring是实验 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
输出
参数类型说明
experimentobject实验详情

创建实验

操作
创建实验
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
名称
输入名称
描述
输入描述
筛选条件 (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 中创建新实验

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
namestring否实验名称 (可选)
descriptionstring否实验描述
featureFlagKeystring是用于该实验的功能标志键
parametersstring否实验参数(JSON 字符串)
filtersstring否实验筛选条件(JSON 字符串)
variantsstring否实验变体(JSON 字符串)
startDatestring否实验开始日期 (ISO 格式)
endDatestring否实验结束日期 (ISO 格式)
输出
参数类型说明
experimentobject已创建的实验

列出问卷

操作
列出问卷
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出问卷 (posthog_list_surveys)

列出 PostHog 项目中的全部问卷。问卷用于收集用户反馈。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:us 或 eu (默认:us)
limitnumber否返回结果数量 (默认:100)
offsetnumber否分页跳过的结果数量
输出
参数类型说明
surveysarray项目中的问卷列表
countnumber问卷总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL

获取问卷

操作
获取问卷
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
问卷 ID*
问卷 ID
获取问卷(posthog_get_survey)

根据 ID 获取 PostHog 中指定问卷的详细信息。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
surveyIdstring是要获取的问卷 ID
regionstring否PostHog 云区域:us 或 eu(默认:us)
输出
参数类型说明
surveyobject问卷详情

创建问卷

操作
创建问卷
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
名称
输入名称
描述
输入描述
问题(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": [...]}
关联功能开关 ID
功能开关 ID
回复上限
1000
创建问卷(posthog_create_survey)

在 PostHog 中创建新问卷。支持的问题类型:基础(开放式)、链接、评分和多选题。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:us 或 eu(默认:us)
namestring否问卷名称(可选)
descriptionstring否问卷描述
typestring否问卷类型:popover(应用内)或 api(自定义实现)(默认:popover)
questionsstring是问卷问题数组的 JSON 字符串。每个问题必须包含 type(open/link/rating/multiple_choice)和问题文本。评分题可包含 scale(1-10)、lowerBoundLabel、upperBoundLabel。多选题需要 choices 数组。链接题可包含 buttonText。
startDatestring否问卷开始日期,ISO 8601 格式
endDatestring否问卷结束日期,ISO 8601 格式
appearancestring否外观配置的 JSON 字符串(颜色、位置等)
conditionsstring否显示条件的 JSON 字符串(URL 匹配等)
targetingFlagFiltersstring否用于定向的功能标志筛选器 JSON 字符串
linkedFlagIdstring否要关联到此问卷的功能标志 ID
responsesLimitnumber否要收集的最大回复数
输出
参数类型说明
surveyobject已创建的问卷详情

更新问卷

操作
更新问卷
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
问卷 ID*
问卷 ID
名称
输入名称
描述
输入描述
问题(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": [...]}
关联功能标志 ID
功能标志 ID
回复上限
1000
更新调查问卷(posthog_update_survey)

更新 PostHog 中的现有调查问卷。可修改问题、外观、条件及其他设置。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
surveyIdstring是要更新的调查问卷 ID
regionstring否PostHog 云区域:us 或 eu (默认:us)
namestring否调查问卷名称
descriptionstring否调查问卷描述
typestring否调查问卷类型:popover 或 api
questionsstring否调查问卷问题数组的 JSON 字符串。每个问题必须包含 type (open/link/rating/multiple_choice) 和问题文本。
startDatestring否调查问卷开始日期,ISO 8601 格式
endDatestring否调查问卷结束日期,ISO 8601 格式
appearancestring否外观配置的 JSON 字符串 (颜色、位置等)
conditionsstring否显示条件的 JSON 字符串 (URL 匹配等)
targetingFlagFiltersstring否用于定向的功能标志筛选器 JSON 字符串
linkedFlagIdstring否关联到此调查问卷的功能标志 ID
responsesLimitnumber否要收集的最大回复数
archivedboolean否归档或取消归档该调查问卷
输出
参数类型说明
surveyobject更新后的问卷详情

列出会话录制

操作
列出会话录制
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出会话录制 (posthog_list_session_recordings)

列出 PostHog 项目中的会话录制。会话录制会捕获用户与应用的交互。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:us 或 eu (默认:us)
limitnumber否返回的结果数量 (默认:50)
offsetnumber否分页跳过的结果数量
输出
参数类型说明
recordingsarray会话录制列表
countnumber录制总数
nextstring结果下一页的 URL
previousstring结果上一页的 URL

获取会话录制

操作
获取会话录制
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入 PostHog 项目 ID
录制 ID*
会话录制 ID
获取会话录制(posthog_get_session_recording)

按 ID 获取 PostHog 中指定会话录制的详细信息。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
recordingIdstring是要获取的会话录制 ID
regionstring否PostHog 云区域:us 或 eu(默认:us)
输出
参数类型说明
recordingobject会话录制详情

列出录制播放列表

操作
列出录制播放列表
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
列出录制播放列表 (posthog_list_recording_playlists)

列出 PostHog 项目中的会话录制播放列表。播放列表用于整理和筛选会话录制。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
projectIdstring是PostHog 项目 ID
regionstring否PostHog 云区域:us 或 eu (默认:us)
limitnumber否返回结果数量 (默认:100)
offsetnumber否分页时跳过的结果数量
输出
参数类型说明
playlistsarray会话录制播放列表
countnumber播放列表总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL

列出事件定义

操作
列出事件定义
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移
0
搜索
搜索查询
列出事件定义(posthog_list_event_definitions)

列出 PostHog 项目中的所有事件定义。事件定义表示已追踪的事件,并包含描述、标签和使用统计等元数据。

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
limitnumber否每页返回的结果数量(默认:100)
offsetnumber否返回结果的起始索引
searchstring否按名称筛选事件定义的搜索词
输出
参数类型说明
countnumber事件定义总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL
resultsarray事件定义列表

获取事件定义

操作
获取事件定义
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
事件定义 ID*
事件定义 ID
获取事件定义(posthog_get_event_definition)

获取 PostHog 中特定事件定义的详细信息。返回该事件的完整信息,包括元数据、使用统计和验证状态。

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
eventDefinitionIdstring是要获取的事件定义 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
输出
参数类型说明
idstring事件定义的唯一标识符
namestring事件名称
descriptionstring事件描述
tagsarray与该事件关联的标签
volume_30_daynumber过去 30 天收到的事件数
query_usage_30_daynumber过去 30 天该事件被查询的次数
created_atstring事件创建时的 ISO 时间戳
last_seen_atstring事件最后出现时的 ISO 时间戳
updated_atstring事件更新时的 ISO 时间戳
updated_byobject最后更新该事件的用户
verifiedboolean该事件是否已验证
verified_atstring事件验证时的 ISO 时间戳
verified_bystring验证该事件的用户

更新事件定义

操作
更新事件定义
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
事件定义 ID*
事件定义 ID
描述
输入描述
标签(逗号分隔)
tag1, tag2, tag3
更新事件定义(posthog_update_event_definition)

更新 PostHog 中的事件定义。可修改描述、标签和验证状态,以保持事件架构整洁。

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
eventDefinitionIdstring是要更新的事件定义 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
descriptionstring否事件的更新描述
tagsstring否与该事件关联的标签,逗号分隔
verifiedboolean否是否将事件标记为已验证
输出
参数类型说明
idstring事件定义的唯一标识符
namestring事件名称
descriptionstring更新后的事件描述
tagsarray与该事件关联的更新后标签
volume_30_daynumber过去 30 天收到的事件数量
query_usage_30_daynumber过去 30 天该事件被查询的次数
created_atstring事件创建时的 ISO 时间戳
last_seen_atstring事件上次出现时的 ISO 时间戳
updated_atstring事件更新时的 ISO 时间戳
updated_byobject上次更新该事件的用户
verifiedboolean事件是否已验证
verified_atstring事件验证时的 ISO 时间戳
verified_bystring验证该事件的用户

列出属性定义

操作
列出属性定义
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
限制
100
偏移量
0
搜索
搜索查询
列出属性定义 (posthog_list_property_definitions)

列出 PostHog 项目中的所有属性定义。属性定义表示带有描述、标签、类型和使用统计等元数据的已追踪属性。

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
limitnumber否每页返回的结果数量 (默认:100)
offsetnumber否返回结果的起始索引
searchstring否按名称筛选属性定义的搜索词
typestring否按属性类型筛选:event、person 或 group
输出
参数类型说明
countnumber属性定义总数
nextstring下一页结果的 URL
previousstring上一页结果的 URL
resultsarray属性定义列表

获取属性定义

操作
获取属性定义
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
属性定义 ID*
属性定义 ID
获取属性定义(posthog_get_property_definition)

获取 PostHog 中特定属性定义的详细信息。返回该属性的完整信息,包括元数据、类型、使用统计和验证状态。

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
propertyDefinitionIdstring是要获取的属性定义 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
输出
参数类型说明
idstring属性定义的唯一标识符
namestring属性名称
descriptionstring属性描述
tagsarray与该属性关联的标签
is_numericalboolean该属性是否为数值类型
is_seen_on_filtered_eventsboolean该属性是否出现在已筛选事件中
property_typestring属性的数据类型
typestring属性类型:event、person 或 group
volume_30_daynumber过去 30 天内该属性出现的次数
query_usage_30_daynumber过去 30 天内该属性被查询的次数
created_atstring属性创建时的 ISO 时间戳
updated_atstring属性更新时的 ISO 时间戳
updated_byobject最后更新该属性的用户
verifiedboolean该属性是否已验证
verified_atstring属性验证时的 ISO 时间戳
verified_bystring验证该属性的用户
examplestring该属性的示例值

更新属性定义

操作
更新属性定义
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
输入你的 PostHog 项目 ID
属性定义 ID*
属性定义 ID
描述
输入描述
标签(逗号分隔)
tag1, tag2, tag3
属性类型
Select...
更新属性定义(posthog_update_property_definition)

更新 PostHog 中的属性定义。可修改描述、标签、属性类型和验证状态,以保持属性架构整洁。

输入
参数类型必填说明
projectIdstring是PostHog 项目 ID
propertyDefinitionIdstring是要更新的属性定义 ID
regionstring是PostHog 云区域:us 或 eu
apiKeystring是PostHog 个人 API 密钥
descriptionstring否属性的更新描述
tagsstring否要与该属性关联的标签列表,以逗号分隔
verifiedboolean否是否将该属性标记为已验证
property_typestring否属性的数据类型 (例如 String、Numeric、Boolean、DateTime 等)
输出
参数类型说明
idstring属性定义的唯一标识符
namestring属性名称
descriptionstring更新后的属性描述
tagsarray与该属性关联的更新后标签
is_numericalboolean该属性是否为数值类型
is_seen_on_filtered_eventsboolean该属性是否出现在已筛选事件上
property_typestring属性的数据类型
typestring属性类型:event、person 或 group
volume_30_daynumber过去 30 天内该属性出现的次数
query_usage_30_daynumber过去 30 天内该属性被查询的次数
created_atstring属性创建时的 ISO 时间戳
updated_atstring属性更新时的 ISO 时间戳
updated_byobject最后更新该属性的用户
verifiedboolean该属性是否已验证
verified_atstring属性验证时的 ISO 时间戳
verified_bystring验证该属性的用户
examplestring属性的示例值

列出项目

操作
列出项目
区域*
美国云
个人 API 密钥*
••••••••
列出项目 (posthog_list_projects)

列出组织中的所有项目。返回项目详情,包括 ID、名称、API 令牌和设置。可用于获取其他端点所需的项目 ID。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
regionstring否云区域:us 或 eu (默认:us)
输出
参数类型说明
projectsarray项目列表,包含其配置和设置

获取项目

操作
获取项目
区域*
美国云
个人 API 密钥*
••••••••
项目 ID*
项目 ID
获取项目 (posthog_get_project)

按 ID 获取特定项目的详细信息。返回完整的项目配置、设置和功能标志。

输入
参数类型必填说明
projectIdstring是项目 ID (数字 ID 或 UUID)
apiKeystring是PostHog 个人 API 密钥
regionstring否云区域:us 或 eu (默认:us)
输出
参数类型说明
projectobject包含全部配置设置的详细项目信息

列出组织

操作
列出组织
区域*
美国云
个人 API 密钥*
••••••••
列出组织 (posthog_list_organizations)

列出用户有权访问的所有组织。返回组织详情,包括名称、slug、成员级别和可用产品功能。

输入
参数类型必填说明
apiKeystring是PostHog 个人 API 密钥
regionstring否云区域:us 或 eu(默认:us)
输出
参数类型说明
organizationsarray包含设置和功能的组织列表

获取组织

操作
获取组织
区域*
美国云
个人 API 密钥*
••••••••
组织 ID*
组织 ID
获取组织(posthog_get_organization)

根据 ID 获取指定组织的详细信息。返回完整的组织设置、功能、用量和团队信息。

输入
参数类型必填说明
organizationIdstring是组织 ID (UUID)
apiKeystring是PostHog 个人 API 密钥
regionstring否云区域:us 或 eu (默认:us)
输出
参数类型说明
organizationobject包含设置和功能的详细组织信息

使用说明

将 PostHog 集成到你的工作流中。跟踪事件、管理功能标志、分析用户行为、运行实验、创建问卷,并访问会话录制。

备注

  • 类别:tools
  • 类型:posthog