关于 pp-klaviyo
pp-klaviyo 是供 Agent 检查和操作 Klaviyo 数据及工作流的命令行技能。它结合营销活动操作、本地数据分析、用户资料清理和结构化增长规划。
主要功能
- 01检查用户资料、营销活动、流程和指标
- 02部署营销活动草稿并替换图片
- 03分析流程表现衰减和群组留存
- 04将收入归因到营销活动和流程
- 05查找重复资料并核对订单
- 06制定增长策略并执行发布检查
适用场景
- 01根据邮件模板准备营销活动草稿
- 02发现互动表现下降的自动化流程
- 03比较群组留存和重复行为
- 04用订单证据核对营销活动表现
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ mvanhorn/ printing-press-library --skill pp-klaviyo安装后在 Claude Code 中输入/pp-klaviyo确认已加载。
详细介绍
Klaviyo — Printing Press CLI
前提条件:安装 CLI
此技能通过 klaviyo-pp-cli 二进制文件运行。**调用此技能中的任何命令前,必须确认 CLI 已安装。**如果尚未安装,请先安装:
- 使用 Printing Press 安装程序进行安装。在 macOS/Linux 上,二进制文件默认安装到
$HOME/.local/bin;在 Windows 上,则安装到%LOCALAPPDATA%\Programs\PrintingPress\bin:npx -y @mvanhorn/printing-press-library install klaviyo --cli-only - 验证:
klaviyo-pp-cli --version - 确保报告的安装目录位于将调用此技能的 Agent/运行时的
$PATH中。
如果 npx 安装失败(没有 Node、处于离线状态等),请改用直接通过 Go 安装(需要 Go 1.26.6 或更高版本):
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-cli@latest
如果安装后 --version 报告“command not found”,说明运行时无法在 $PATH 中找到二进制文件目录。验证成功前,请勿继续执行技能命令。
何时使用此 CLI
当 Agent 需要在不使用 Web UI 的情况下检查或操作 Klaviyo 时,请使用此 CLI,尤其适用于档案、事件、营销活动、流程、细分、模板、指标以及复合增长工作流。
独特功能
这些功能在此 API 的其他任何工具中均不可用。
营销活动操作
-
campaigns deploy— 创建电子邮件模板、创建营销活动草稿,并在一个可审计的工作流中将模板分配给营销活动消息。Agent 可以创建营销活动草稿,无需手动拼接三个端点调用。
klaviyo-pp-cli campaigns deploy --template-html ./email.html --campaign-name "May offer" --list-id LIST_ID --subject "May offer" --from-email [email protected] --from-label "Marketing" --json -
campaigns image-swap— 查找营销活动消息模板,并替换 HTML 中的图片 URL,同时保留草稿的其余部分。Agent 可以安全地替换创意素材,无需重建整个营销活动。
klaviyo-pp-cli campaigns image-swap --campaign-id CAMPAIGN_ID --old-url https://cdn.example.com/old.jpg --new-url https://cdn.example.com/new.jpg --json
行为图分析
-
flow-decay— 使用同步的本地数据,识别近期时间段内打开或点击表现下滑的流程。Agent 可以在生命周期自动化进一步影响收入之前,发现需要更新的自动化流程。
klaviyo-pp-cli flow-decay --days 90 --threshold 0.15 --json -
cohort— 按首次事件日期对档案分组,并根据同步的档案和事件计算留存率或重复操作曲线。Agent 无需导出 CSV,即可了解哪些获客群体会持续购买。
klaviyo-pp-cli cohort --metric "Placed Order" --interval month --json --select cohort,profiles,retained -
attribution— 将订单事件与营销活动和流程归因属性关联,按渠道和来源汇总收入。Agent 可以使用本地事件证据,说明哪些自动化流程或营销活动带来了收入。
klaviyo-pp-cli attribution --metric "Placed Order" --group-by flow --since 2026-01-01 --json
数据清理
-
dedup— 在本地档案镜像中查找因电子邮件、电话号码或跨渠道冲突而出现重复的档案。Agent 可以标记因身份信息不一致而导致客户记录中的行为和收入历史分散的情况。
klaviyo-pp-cli dedup --by email,phone --json -
reconcile— 比较营销活动的 UTM 证据与本地 Klaviyo 订单事件,并在可用时使用可选的 Shopify 凭据。Agent 可以在报告数据前,检查营销活动表现是否与订单证据相符。
klaviyo-pp-cli reconcile --campaign-id CAMPAIGN_ID --since 2026-01-01 --json
增长规划
-
plan brief-to-strategy— 将增长简报转化为结构化的 Klaviyo 营销活动、流程、细分和实验策略。Agent 可以将策略笔记转化为具体的 Klaviyo 执行计划。
klaviyo-pp-cli plan brief-to-strategy --brief ./brief.md --json -
plan qa-gate— 运行发布就绪检查清单,检查链接、优惠、日期、时区、回退令牌、退订位置、合规性和投递能力标记。Agent 可以根据明确的检查结果阻止有风险的营销活动发布,而非只给出含糊的审核意见。
klaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --html ./email.html --json
命令参考
accounts — 账户
klaviyo-pp-cli accounts get— 获取与给定私有 API 密钥关联的账户。此命令将在数组中返回 1 个账户对象……klaviyo-pp-cli accounts get-id— 根据账户 ID 获取单个账户对象。你只能请求与该私有 API 密钥关联的账户……
back-in-stock-subscriptions — 管理到货提醒订阅
-
klaviyo-pp-cli back-in-stock-subscriptions— 订阅档案,以接收商品到货通知。请参阅[我们的 Back in Stock API…… campaign-clone — 管理营销活动克隆 -
klaviyo-pp-cli campaign-clone— 克隆现有营销活动,返回一个基于原营销活动的新营销活动,并分配新的 ID 和名称。
*速率...
campaign-message-assign-template — 管理营销活动消息模板分配
klaviyo-pp-cli campaign-message-assign-template— 创建一个不可重复使用的模板版本,并将其分配给消息。
速率限制:
突发:...
campaign-messages — 管理营销活动消息
klaviyo-pp-cli campaign-messages get— 根据必需的 id 返回特定消息。
速率限制:
突发:10/s
稳定:150/m...klaviyo-pp-cli campaign-messages update— 更新营销活动消息
速率限制:
突发:10/s
稳定:150/m权限范围:campaigns:write
campaign-recipient-estimation-jobs — 管理营销活动收件人数估算任务
klaviyo-pp-cli campaign-recipient-estimation-jobs get— 获取通过Create Campaign Recipient Estimation Job触发的收件人数估算任务的状态...klaviyo-pp-cli campaign-recipient-estimation-jobs refresh-campaign-recipient-estimation— 触发异步任务,以更新指定营销活动 ID 的估算收件人数。使用 `Get...
campaign-recipient-estimations — 管理营销活动收件人数估算
klaviyo-pp-cli campaign-recipient-estimations <id>— 获取指定营销活动 ID 对应的估算收件人数。可以使用...刷新此人数
campaign-send-jobs — 管理营销活动发送任务
klaviyo-pp-cli campaign-send-jobs cancel-campaign-send— 永久取消营销活动,将状态设为 CANCELED;或撤销营销活动,将状态恢复为...klaviyo-pp-cli campaign-send-jobs get— 获取营销活动发送任务
速率限制:
突发:10/s
稳定:150/m权限范围:campaigns:readklaviyo-pp-cli campaign-send-jobs send-campaign— 触发异步发送营销活动
速率限制:
突发:10/s
稳定:150/m权限范围:...
campaign-values-reports — 管理营销活动价值报告
klaviyo-pp-cli campaign-values-reports— 返回请求的营销活动分析价值数据
速率限制:
突发:1/s
稳定:...
campaigns — 营销活动
klaviyo-pp-cli campaigns create— 根据一组参数创建营销活动,然后返回该营销活动。
速率限制:
突发:10/s
稳定:...klaviyo-pp-cli campaigns delete— 删除指定营销活动 ID 对应的营销活动。
速率限制:
突发:10/s
稳定:150/m权限范围:...klaviyo-pp-cli campaigns get— 根据筛选条件返回部分或全部营销活动。列出营销活动时必须提供渠道筛选条件。请提供...klaviyo-pp-cli campaigns get-id— 根据必需的 id 返回特定营销活动。
速率限制:
突发:10/s
稳定:150/m...klaviyo-pp-cli campaigns update— 更新指定营销活动 ID 对应的营销活动。
速率限制:
突发:10/s
稳定:150/m权限范围:...
catalog-categories — 管理目录分类
klaviyo-pp-cli catalog-categories create-catalog-category— 创建新的目录类别。
速率限制:
突发:75/s
稳定:750/m作用域:catalogs:writeklaviyo-pp-cli catalog-categories delete-catalog-category— 使用指定的类别 ID 删除目录类别。
速率限制:
突发:75/s
稳定:750/m...klaviyo-pp-cli catalog-categories get— 获取账户中的所有目录类别。目录类别可按以下字段升序和...klaviyo-pp-cli catalog-categories get-catalog-category— 获取指定类别 ID 对应的目录类别。
速率限制:
突发:350/s
稳定:3500/m...klaviyo-pp-cli catalog-categories update-catalog-category— 更新指定类别 ID 对应的目录类别。
速率限制:
突发:75/s
稳定:750/m...
catalog-category-bulk-create-jobs — 管理目录类别批量创建作业
klaviyo-pp-cli catalog-category-bulk-create-jobs bulk-create-catalog-categories— 创建目录类别批量创建作业,以批量创建目录类别。最多接受 100 个目录...klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-job— 获取指定作业 ID 对应的目录类别批量创建作业。可提供include参数以获取...klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-jobs— 获取所有目录类别批量创建作业。每个请求最多返回 100 个作业。
*速率...
catalog-category-bulk-delete-jobs — 管理目录类别批量删除作业
klaviyo-pp-cli catalog-category-bulk-delete-jobs bulk-delete-catalog-categories— 创建目录类别批量删除作业,以批量删除目录类别。最多接受 100 个目录...klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-job— 获取指定作业 ID 对应的目录类别批量删除作业。
速率限制:
突发:350/s
稳定:...klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-jobs— 获取所有目录类别批量删除作业。每个请求最多返回 100 个作业。
*速率...
catalog-category-bulk-update-jobs — 管理目录类别批量更新作业
klaviyo-pp-cli catalog-category-bulk-update-jobs bulk-update-catalog-categories— 创建目录类别批量更新作业,以批量更新目录类别。最多接受 100 个目录...klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-job— 获取指定作业 ID 对应的目录类别批量更新作业。可提供include参数以获取...klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-jobs— 获取所有目录类别批量更新作业。每个请求最多返回 100 个作业。
*速率...
catalog-item-bulk-create-jobs — 管理目录项目批量创建作业
klaviyo-pp-cli catalog-item-bulk-create-jobs bulk-create-catalog-items— 创建目录项目批量创建作业,以批量创建目录项目。每个请求最多接受 100 个目录项目...klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-job— 获取指定作业 ID 对应的目录项目批量创建作业。可提供include参数以获取...klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-jobs— 获取所有目录项目批量创建作业。每个请求最多返回 100 个作业。
速率限制:
突发:...
catalog-item-bulk-delete-jobs — 管理目录项目批量删除作业
klaviyo-pp-cli catalog-item-bulk-delete-jobs bulk-delete-catalog-items— 创建目录项批量删除任务,以删除一批目录项。每次最多接受 100 个目录项……klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-job— 使用给定的任务 ID 获取目录项批量删除任务。
速率限制:
突发:350/s
稳定:...klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-jobs— 获取所有目录项批量删除任务。每次请求最多返回 100 个任务。
速率限制:
突发:...
catalog-item-bulk-update-jobs — 管理目录项批量更新任务
klaviyo-pp-cli catalog-item-bulk-update-jobs bulk-update-catalog-items— 创建目录项批量更新任务,以更新一批目录项。每次最多接受 100 个目录项……klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-job— 使用给定的任务 ID 获取目录项批量更新任务。可提供include参数来获取……klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-jobs— 获取所有目录项批量更新任务。每次请求最多返回 100 个任务。
速率限制:
突发:...
catalog-items — 管理目录项
klaviyo-pp-cli catalog-items create— 创建新的目录项。
速率限制:
突发:75/s
稳定:750/m作用域:catalogs:writeklaviyo-pp-cli catalog-items delete— 删除具有给定项 ID 的目录项。
速率限制:
突发:75/s
稳定:750/m作用域:...klaviyo-pp-cli catalog-items get— 获取账户中的所有目录项。目录项可按以下字段升序和……klaviyo-pp-cli catalog-items get-catalogitems— 使用给定的项 ID 获取特定目录项。
速率限制:
突发:350/s
稳定:3500/m...klaviyo-pp-cli catalog-items update— 使用给定的项 ID 更新目录项。
速率限制:
突发:75/s
稳定:750/m作用域:...
catalog-variant-bulk-create-jobs — 管理目录变体批量创建任务
klaviyo-pp-cli catalog-variant-bulk-create-jobs bulk-create-catalog-variants— 创建目录变体批量创建任务,以创建一批目录变体。每次最多接受 100 个目录变体……klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-job— 使用给定的任务 ID 获取目录变体批量创建任务。可提供include参数来获取……klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-jobs— 获取所有目录变体批量创建任务。每次请求最多返回 100 个任务。
速率限制:
突发:...
catalog-variant-bulk-delete-jobs — 管理目录变体批量删除任务
klaviyo-pp-cli catalog-variant-bulk-delete-jobs bulk-delete-catalog-variants— 创建目录变体批量删除任务,以删除一批目录变体。每次最多接受 100 个目录变体……klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-job— 使用给定的任务 ID 获取目录变体批量删除任务。
速率限制:
突发:350/s
稳定:...klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-jobs— 获取所有目录变体批量删除任务。每次请求最多返回 100 个任务。
速率限制:
突发:...
catalog-variant-bulk-update-jobs — 管理目录变体批量更新任务
klaviyo-pp-cli catalog-variant-bulk-update-jobs bulk-update-catalog-variants— 创建目录变体批量更新作业,以更新一批目录变体。最多接受 100 个目录变体...klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-job— 获取具有指定作业 ID 的目录变体批量更新作业。可提供include参数以获取...klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-jobs— 获取所有目录变体批量更新作业。每个请求最多返回 100 个作业。
速率限制:
突发:...
catalog-variants — 管理目录变体
klaviyo-pp-cli catalog-variants create— 为关联的目录项目创建新变体。
速率限制:
突发:75/s
稳定:750/m...klaviyo-pp-cli catalog-variants delete— 删除具有指定变体 ID 的目录项目变体。
速率限制:
突发:75/s
稳定:750/m...klaviyo-pp-cli catalog-variants get— 获取账户中的所有变体。变体可以按以下字段升序或降序排序:...klaviyo-pp-cli catalog-variants get-catalogvariants— 获取具有指定变体 ID 的目录项目变体。
速率限制:
突发:350/s
稳定:3500/m...klaviyo-pp-cli catalog-variants update— 更新具有指定变体 ID 的目录项目变体。
速率限制:
突发:75/s
稳定:750/m...
client — 客户端
klaviyo-pp-cli client bulk-create-events— 创建新事件以跟踪个人资料的活动。此端点专为从...调用而设计klaviyo-pp-cli client create-back-in-stock-subscription— 订阅个人资料以接收商品到货通知。请查看[我们的商品到货 API...klaviyo-pp-cli client create-event— 创建新事件以跟踪个人资料的活动。此端点专为从...调用而设计klaviyo-pp-cli client create-profile— 创建或更新个人资料属性,而不跟踪相关事件。此端点专为...klaviyo-pp-cli client create-push-token— 创建或更新推送令牌。此端点专为从我们的移动 SDK...调用而设计klaviyo-pp-cli client create-review— 创建具有指定 ID 的评论。此端点仅适用于客户端环境。
*速率...klaviyo-pp-cli client create-subscription— 根据提供的email和...为电子邮件和/或 SMS 渠道创建订阅及同意记录klaviyo-pp-cli client get-geofences— 获取账户中的所有地理围栏。返回指定公司的所有地理围栏的分页列表。这是 GA...klaviyo-pp-cli client get-review-values-reports— 获取账户中的所有评论价值报告。
速率限制:
突发:10/s
稳定:150/mklaviyo-pp-cli client get-reviews— 获取所有评论。此端点仅适用于客户端环境;如需在服务端使用,请参阅...klaviyo-pp-cli client unregister-push-token— 注销推送令牌。此端点专为从我们的移动 SDK...调用而设计
conversation-messages — 管理会话消息
klaviyo-pp-cli conversation-messages— 向会话发送外发消息。需要 OAuth 身份验证并启用账户级功能。如需申请...
coupon-code-bulk-create-jobs — 管理优惠券代码批量创建作业
klaviyo-pp-cli coupon-code-bulk-create-jobs bulk-create-coupon-codes— 创建一个优惠码批量创建任务,以批量创建优惠码列表。每个任务最多可包含的优惠码数量为……klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-code-jobs— 获取所有优惠码批量创建任务。每次请求最多返回 100 个任务。
速率限制:
突发:...klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-codes-job— 获取指定任务 ID 的优惠码批量创建任务。
速率限制:
突发:75/s
稳定:750/m...
coupon-codes — 管理优惠码
klaviyo-pp-cli coupon-codes create— 同步为指定优惠券创建优惠码。
速率限制:
突发:350/s
稳定:...klaviyo-pp-cli coupon-codes delete— 根据给定标识符同步删除指定的优惠码。如果某个档案已被分配到该优惠券……klaviyo-pp-cli coupon-codes get— 获取与一个或多个优惠券或档案关联的优惠码列表。一个或多个优惠券或……klaviyo-pp-cli coupon-codes get-couponcodes— 返回由给定标识符指定的优惠码。
速率限制:
突发:350/s
稳定:3500/m...klaviyo-pp-cli coupon-codes update— 根据给定标识符同步更新优惠码。允许更新“status”和……
coupons — 优惠券
klaviyo-pp-cli coupons create— 创建新优惠券。
速率限制:
突发:3/s
稳定:60/mScopes:coupons:writeklaviyo-pp-cli coupons delete— 删除给定优惠券 ID 对应的优惠券。
速率限制:
突发:3/s
稳定:60/mScopes:...klaviyo-pp-cli coupons get— 获取账户中的所有优惠券。了解详情,请参阅我们的 [优惠券 API...klaviyo-pp-cli coupons get-id— 获取给定优惠券 ID 对应的特定优惠券。
速率限制:
突发:75/s
稳定:750/m...klaviyo-pp-cli coupons update— 速率限制:
突发:3/s
稳定:60/mScopes:coupons:write
custom-metrics — 管理自定义指标
klaviyo-pp-cli custom-metrics create— 创建新的自定义指标。自定义指标对象必须包含name和definition。
*速率...klaviyo-pp-cli custom-metrics delete— 删除给定自定义指标 ID 对应的自定义指标。
速率限制:
突发:3/s
稳定:60/m...klaviyo-pp-cli custom-metrics get— 获取账户中的所有自定义指标。
速率限制:
突发:3/s
稳定:60/mScopes:metrics:readklaviyo-pp-cli custom-metrics get-custommetrics— 获取给定自定义指标 ID 对应的自定义指标。
速率限制:
突发:3/s
稳定:60/m...klaviyo-pp-cli custom-metrics update— 更新给定自定义指标 ID 对应的自定义指标。
速率限制:
突发:1/s
稳定:...
data-privacy-deletion-jobs — 管理数据隐私删除任务
klaviyo-pp-cli data-privacy-deletion-jobs— 请求删除符合以下任一标识符的档案:email、phone_number,或……
data-source-record-bulk-create-jobs — 管理数据源记录批量创建任务
klaviyo-pp-cli data-source-record-bulk-create-jobs— 创建数据源记录批量导入任务,以创建一批记录。每次请求最多接受 500 条记录。该……
data-source-record-create-jobs — 管理数据源记录创建任务
klaviyo-pp-cli data-source-record-create-jobs— 创建数据源记录导入任务,以创建单条记录。每条记录允许的最大负载大小为……
data-sources — 管理数据源
klaviyo-pp-cli data-sources create— 在账户中创建新的数据源
速率限制:
突发:3/s
稳定:60/m权限范围:...klaviyo-pp-cli data-sources delete— 删除账户中的数据源。
速率限制:
突发:3/s
稳定:60/m权限范围:...klaviyo-pp-cli data-sources get— 获取账户中的所有数据源。
速率限制:
突发:3/s
稳定:60/m权限范围:...klaviyo-pp-cli data-sources get-datasources— 检索账户中的数据源。
速率限制:
突发:3/s
稳定:60/m权限范围:...
event-bulk-create-jobs — 管理事件批量创建作业
klaviyo-pp-cli event-bulk-create-jobs— 为一个或多个档案创建一批事件。请注意,此端点允许你创建新的档案或...
events — 事件
klaviyo-pp-cli events create— 创建新的事件,以跟踪档案的活动。请注意,此端点允许你创建新的档案或...klaviyo-pp-cli events get— 获取账户中的所有事件。请求可以按以下字段排序:datetime、timestamp[自定义...klaviyo-pp-cli events get-id— 获取具有指定事件 ID 的事件。
速率限制:
突发:10/s
稳定:150/m权限范围:...
flow-actions — 管理流程操作
klaviyo-pp-cli flow-actions get— 获取具有指定流程操作 ID 的流程中的流程操作。
速率限制:
突发:3/s
稳定:60/m...klaviyo-pp-cli flow-actions update— 更新流程操作。
速率限制:
突发:3/s
稳定:60/m权限范围:flows:write
flow-messages — 管理流程消息
klaviyo-pp-cli flow-messages <id>— 获取具有指定流程消息 ID 的流程中的流程消息。
速率限制:
突发:3/s
稳定:...
flow-series-reports — 管理流程系列报告
klaviyo-pp-cli flow-series-reports— 返回请求的流程分析系列数据
速率限制:
突发:1/s
稳定:2/m
每日:...
flow-values-reports — 管理流程值报告
klaviyo-pp-cli flow-values-reports— 返回请求的流程分析值数据
速率限制:
突发:1/s
稳定:2/m
每日:...
flows — 流程
klaviyo-pp-cli flows create— 使用编码后的流程定义创建新流程。流程定义中的新对象(例如操作)将...klaviyo-pp-cli flows delete— 删除具有指定流程 ID 的流程。
速率限制:
突发:3/s
稳定:60/m权限范围:flows:writeklaviyo-pp-cli flows get— 获取账户中的所有流程。每个请求最多返回 50 个流程,可通过基于游标的方式进行分页...klaviyo-pp-cli flows get-id— 获取具有指定流程 ID 的流程。
速率限制:
突发:3/s
稳定:60/m权限范围:flows:readklaviyo-pp-cli flows update— 更新具有指定流程 ID 的流程状态及该流程中的所有操作。
速率限制:
突发:...
form-series-reports — 管理表单系列报告
klaviyo-pp-cli form-series-reports— 返回请求的表单分析系列数据。
速率限制:
突发:1/s
稳定:2/m
每日:...
form-values-reports — 管理表单值报告
klaviyo-pp-cli form-values-reports— 返回请求的表单分析值数据。
速率限制:
突发:1/s
稳定:2/m
每日:...
form-versions — 管理表单版本
klaviyo-pp-cli form-versions <id>— 获取具有指定 ID 的表单版本。
速率限制:
突发:3/s
稳定:60/m权限范围:forms:read
forms — 表单
klaviyo-pp-cli forms create— 创建新表单。
速率限制:
突发:3/s
稳定:60/m范围:forms:writeklaviyo-pp-cli forms delete— 删除指定表单。
速率限制:
突发:3/s
稳定:60/m范围:forms:writeklaviyo-pp-cli forms get— 获取账户中的所有表单。
速率限制:
突发:3/s
稳定:60/m范围:forms:readklaviyo-pp-cli forms get-id— 获取具有指定 ID 的表单。
速率限制:
突发:3/s
稳定:60/m范围:forms:read
image-upload — 管理图片上传
klaviyo-pp-cli image-upload— 从文件上传图片。若要从现有 URL 或 data URI 导入图片,请使用 Upload Image...
images — 图片
klaviyo-pp-cli images get— 获取账户中的所有图片。
速率限制:
突发:10/s
稳定:150/m范围:images:readklaviyo-pp-cli images get-id— 获取具有指定图片 ID 的图片。
速率限制:
突发:10/s
稳定:150/m范围:...klaviyo-pp-cli images update— 更新具有指定图片 ID 的图片。
速率限制:
突发:10/s
稳定:150/m范围:...klaviyo-pp-cli images upload-from-url— 从 URL 或 data URI 导入图片。若要从文件上传图片,请使用 Upload Image From File...
lists — 列表
klaviyo-pp-cli lists create— 创建新列表。
速率限制:
突发:10/s
稳定:150/m
每日:150/d范围:lists:writeklaviyo-pp-cli lists delete— 删除具有指定列表 ID 的列表。
速率限制:
突发:10/s
稳定:150/m范围:...klaviyo-pp-cli lists get— 获取账户中的所有列表。可通过筛选请求获取所有列表的子集。列表可按id、name、... 筛选klaviyo-pp-cli lists get-id— 获取具有指定列表 ID 的列表。
速率限制:
突发:75/s
稳定:750/m
速率限制适用于...klaviyo-pp-cli lists update— 更新具有指定列表 ID 的列表名称。
速率限制:
突发:10/s
稳定:150/m...
mapped-metrics — 管理映射指标
klaviyo-pp-cli mapped-metrics get— 获取账户中的所有映射指标。
速率限制:
突发:3/s
稳定:60/m范围:metrics:readklaviyo-pp-cli mapped-metrics get-mappedmetrics— 获取具有指定 ID 的映射指标。
速率限制:
突发:3/s
稳定:60/m范围:...klaviyo-pp-cli mapped-metrics update— 更新具有指定 ID 的映射指标。
速率限制:
突发:1/s
稳定:15/m
每日:30/d...
metric-aggregates — 管理指标聚合
klaviyo-pp-cli metric-aggregates— 查询并聚合与指标相关联的事件数据,包括 Klaviyo 原生指标、特定集成...
metric-properties — 管理指标属性
klaviyo-pp-cli metric-properties <id>— 获取具有指定指标属性 ID 的指标属性。
速率限制:
突发:1/s
稳定:15/m...
metrics — 指标
klaviyo-pp-cli metrics get— 获取账户中的所有指标。请求可按以下字段筛选:集成name、集成...klaviyo-pp-cli metrics get-id— 获取具有指定指标 ID 的指标。
速率限制:
突发:10/s
稳定:150/m范围:...
profile-bulk-import-jobs — 管理个人资料批量导入作业
klaviyo-pp-cli profile-bulk-import-jobs bulk-import-profiles— 创建批量资料导入作业,以创建或更新一批资料。每个请求最多接受 10,000 个资料条目……klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-job— 获取指定作业 ID 对应的批量资料导入作业。
速率限制:
突发:10/s
稳定:150/m……klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-jobs— 获取所有批量资料导入作业。每个请求最多返回 100 个作业。
速率限制:
突发:……
profile-import — 管理资料导入
klaviyo-pp-cli profile-import— 根据一组资料属性(以及可选的 ID)创建或更新资料。新建资料时返回 201……
profile-merge — 管理资料合并
klaviyo-pp-cli profile-merge— 将指定的相关资料合并到具有指定资料 ID 的资料中。relationships下提供的资料……
profile-subscription-bulk-create-jobs — 管理资料订阅批量创建作业
klaviyo-pp-cli profile-subscription-bulk-create-jobs— 将一个或多个资料订阅电子邮件营销、SMS 营销、WhatsApp 或推送通知。如果提供的列表中有重复……
profile-subscription-bulk-delete-jobs — 管理资料订阅批量删除作业
klaviyo-pp-cli profile-subscription-bulk-delete-jobs— > 🚧 > > 不在指定列表中的资料将被全局取消订阅。请务必确认资料是否属于该列表……
profile-suppression-bulk-create-jobs — 管理资料抑制批量创建作业
klaviyo-pp-cli profile-suppression-bulk-create-jobs bulk-suppress-profiles— 按电子邮件地址手动抑制资料,或指定细分群组/列表 ID,以抑制其中所有当前成员……klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-job— 获取指定作业 ID 对应的批量资料抑制作业。
速率限制:
突发:75/s
稳定:750/m……klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-jobs— 获取所有批量资料抑制作业的状态。
速率限制:
突发:75/s
稳定:750/m……
profile-suppression-bulk-delete-jobs — 管理资料抑制批量删除作业
klaviyo-pp-cli profile-suppression-bulk-delete-jobs bulk-unsuppress-profiles— 按电子邮件地址手动取消抑制资料,或指定细分群组/列表 ID,以取消抑制其中所有当前成员……klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-job— 获取指定作业 ID 对应的批量资料取消抑制作业。
速率限制:
突发:75/s
稳定:……klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-jobs— 获取所有批量资料取消抑制作业。
速率限制:
突发:75/s
稳定:750/m范围:……
profiles — 资料
klaviyo-pp-cli profiles create— 创建新资料。使用additional-fields参数可包含订阅和预测分析数据……klaviyo-pp-cli profiles get— 获取账户中的所有资料。资料可按以下字段升序或降序排序:……klaviyo-pp-cli profiles get-id— 获取指定资料 ID 对应的资料。使用additional-fields参数可包含订阅和……klaviyo-pp-cli profiles update— 更新指定资料 ID 对应的资料。使用additional-fields参数可包含订阅和……
push-tokens — 管理推送令牌
klaviyo-pp-cli push-tokens create— 创建或更新推送令牌。此端点可用于将推送令牌从其他平台迁移到 Klaviyo……klaviyo-pp-cli push-tokens delete— 根据推送令牌 ID 删除指定的推送令牌。
速率限制:
突发:3/s
稳定:60/m权限范围:……klaviyo-pp-cli push-tokens get— 返回与公司关联的推送令牌。
速率限制:
突发:10/s
稳定:150/m权限范围:……klaviyo-pp-cli push-tokens get-pushtokens— 根据推送令牌 ID 返回指定的推送令牌。
速率限制:
突发:10/s
稳定:150/m权限范围:……
reviews — 评论
klaviyo-pp-cli reviews get— 获取所有评论。
速率限制:
突发:10/s
稳定:150/m权限范围:reviews:readklaviyo-pp-cli reviews get-id— 获取指定 ID 的评论。
速率限制:
突发:10/s
稳定:150/m权限范围:reviews:readklaviyo-pp-cli reviews update— 更新评论。
速率限制:
突发:10/s
稳定:150/m权限范围:reviews:write
segment-series-reports — 管理细分系列报告
klaviyo-pp-cli segment-series-reports— 返回所请求的细分分析系列数据。
速率限制:
突发:1/s
稳定:……
segment-values-reports — 管理细分值报告
klaviyo-pp-cli segment-values-reports— 返回所请求的细分分析值数据。
速率限制:
突发:1/s
稳定:……
segments — 细分
klaviyo-pp-cli segments create— 创建细分。
速率限制:
突发:1/s
稳定:15/m
每日:100/d权限范围:segments:writeklaviyo-pp-cli segments delete— 删除指定细分 ID 的细分。
速率限制:
突发:3/s
稳定:60/m权限范围:……klaviyo-pp-cli segments get— 获取账户中的所有细分。可通过筛选请求获取部分细分。细分可按name、……筛选klaviyo-pp-cli segments get-id— 获取指定细分 ID 的细分。
速率限制:
突发:75/s
稳定:750/m
速率……klaviyo-pp-cli segments update— 更新指定细分 ID 的细分。
速率限制:
突发:1/s
稳定:15/m
每日:……
tag-groups — 管理标签组
klaviyo-pp-cli tag-groups create— 创建标签组。一个账户最多只能有 50 个不同的标签组。如果未指定exclusive……klaviyo-pp-cli tag-groups delete— 删除指定标签组 ID 的标签组。该标签组中的所有标签,以及这些标签与其他资源之间的所有关联……klaviyo-pp-cli tag-groups get— 列出账户中的所有标签组。每个账户都有一个默认标签组。标签组可按name……筛选klaviyo-pp-cli tag-groups get-taggroups— 获取指定标签组 ID 的标签组。
速率限制:
突发:3/s
稳定:60/m……klaviyo-pp-cli tag-groups update— 更新指定标签组 ID 的标签组。只能更改标签组的name。标签组的……
tags — 标签
klaviyo-pp-cli tags create— 创建标签。一个账户最多只能有 500 个不同的标签。每个标签只能属于一个标签组。如果……klaviyo-pp-cli tags delete— 删除指定标签 ID 的标签。该标签与其他资源之间的所有关联也将……klaviyo-pp-cli tags get— 列出账户中的所有标签。标签可按name筛选,并按name或id升序或降序排列……klaviyo-pp-cli tags get-id— 获取指定标签 ID 的标签。
速率限制:
突发:3/s
稳定:60/m权限范围:tags:readklaviyo-pp-cli tags update— 更新指定标签 ID 的标签。只能更改标签的name。不能将标签从一个标签组移至……
template-clone — 管理模板克隆
klaviyo-pp-cli template-clone— 使用给定的模板 ID 创建模板副本。如果账户中有 1,000 个或更多模板,克隆……
template-render — 管理模板渲染
klaviyo-pp-cli template-render— 使用给定的模板 ID 和上下文属性渲染模板。返回 AMP、HTML 和纯文本版本……
template-universal-content — 管理模板通用内容
klaviyo-pp-cli template-universal-content create-universal-content— 创建通用内容。目前支持的区块类型包括:button、drop_shadow、horizontal_rule、html、……klaviyo-pp-cli template-universal-content delete-universal-content— 删除具有给定 ID 的通用内容。
速率限制:
突发:75/s
稳定:750/m……klaviyo-pp-cli template-universal-content get-all-universal-content— 获取账户中的所有通用内容。
速率限制:
突发:75/s
稳定:750/m权限范围:……klaviyo-pp-cli template-universal-content get-universal-content— 获取具有给定 ID 的通用内容。
速率限制:
突发:75/s
稳定:750/m权限范围:……klaviyo-pp-cli template-universal-content update-universal-content— 更新通用内容。目前仅可更新以下区块类型的definition字段:……
templates — 模板
klaviyo-pp-cli templates create— 创建新的 HTML 或拖放式模板。如果账户中有 1,000 个或更多模板,创建将失败……klaviyo-pp-cli templates delete— 删除具有给定模板 ID 的模板。
速率限制:
突发:75/s
稳定:750/m权限范围:……klaviyo-pp-cli templates get— 获取账户中的所有模板。使用additional-fields[template]=definition可包含完整模板……klaviyo-pp-cli templates get-id— 获取具有给定模板 ID 的模板。
速率限制:
突发:75/s
稳定:750/m权限范围:……klaviyo-pp-cli templates update— 更新具有给定模板 ID 的模板。
速率限制:
突发:75/s
稳定:750/m权限范围:……
tracking-settings — 跟踪设置
klaviyo-pp-cli tracking-settings get— 获取账户中的所有 UTM 跟踪设置。返回一个包含单个跟踪设置的数组。有关……的更多信息klaviyo-pp-cli tracking-settings get-trackingsettings— 获取具有给定账户 ID 的 UTM 跟踪设置。有关 UTM 跟踪设置的更多信息,请参阅……klaviyo-pp-cli tracking-settings update— 更新具有给定账户 ID 的 UTM 跟踪设置。有关 UTM 跟踪设置的更多信息,请参阅……
web-feeds — Web 订阅源
klaviyo-pp-cli web-feeds create— 创建 Web 订阅源。
速率限制:
突发:1/s
稳定:15/m权限范围:web-feeds:writeklaviyo-pp-cli web-feeds delete— 删除具有给定 ID 的 Web 订阅源。
速率限制:
突发:1/s
稳定:15/m权限范围:……klaviyo-pp-cli web-feeds get— 获取账户的所有 Web 订阅源。
速率限制:
突发:1/s
稳定:15/m权限范围:web-feeds:readklaviyo-pp-cli web-feeds get-webfeeds— 获取具有给定 ID 的 Web 订阅源。
速率限制:
突发:1/s
稳定:15/m权限范围:web-feeds:readklaviyo-pp-cli web-feeds update— 更新具有给定 ID 的 Web 订阅源。
速率限制:
突发:1/s
稳定:15/m权限范围:……
webhook-topics — 管理 Webhook 主题
klaviyo-pp-cli webhook-topics get— 获取 Klaviyo 账户中的所有 Webhook 主题。
速率限制:
突发:1/s
稳定:15/m权限范围:……klaviyo-pp-cli webhook-topics get-webhooktopics— 获取具有给定 ID 的 Webhook 主题。
速率限制:
突发:1/s
稳定:15/m权限范围:……
webhooks — Webhook
klaviyo-pp-cli webhooks create— 创建新的 Webhook
速率限制:
突发:1/s
稳定:15/m权限范围:webhooks:writeklaviyo-pp-cli webhooks delete— 删除指定 ID 的 webhook。
速率限制:
突发:1/s
稳定:15/m权限范围:webhooks:writeklaviyo-pp-cli webhooks get— 获取账户中的所有 webhook。
速率限制:
突发:1/s
稳定:15/m权限范围:webhooks:readklaviyo-pp-cli webhooks get-id— 获取指定 ID 的 webhook。
速率限制:
突发:1/s
稳定:15/m权限范围:webhooks:readklaviyo-pp-cli webhooks update— 更新指定 ID 的 webhook。
速率限制:
突发:1/s
稳定:15/m权限范围:...
查找合适的命令
知道要做什么,但不清楚该用哪个命令时,直接向 CLI 提问:
klaviyo-pp-cli which "<capability in your own words>"
which 会根据自然语言功能查询,从此 CLI 精选的功能索引中找出最匹配的命令。退出代码 0 表示至少找到一个匹配项;退出代码 2 表示没有可信的匹配项——请改用 --help 或缩小查询范围。
使用示例
简洁地检查个人资料
klaviyo-pp-cli profiles list --limit 1 --json --select data.id,data.email,data.first_name
获取一个个人资料,并只选择 Agent 需要的字段。
查找收入指标
klaviyo-pp-cli metrics list --json --select data.id,data.name | jq '.data[] | select(.name=="Placed Order")'
在进行归因或群组分析之前,先找到 Placed Order 指标。
执行发布前 QA 检查
klaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --html ./email.html --json
在发布前检查优惠、链接、取消订阅、合规性、日期和送达能力问题。缺失或损坏的取消订阅标签会导致检查不通过;campaigns deploy 在创建模板前也会执行相同检查。请将 {% unsubscribe %} 用作独立文本,或在 href 中使用 {% unsubscribe_link %}。
身份验证设置
将 KLAVIYO_API_KEY 设置为私有 Klaviyo API 密钥。请求会发送 Authorization: Klaviyo-API-Key ,并使用生成的 OpenAPI 规范中固定的修订版本。
运行 klaviyo-pp-cli doctor 验证设置。
Agent 模式
在任何命令中添加 --agent。它会扩展为:--json --compact --no-input --no-color --yes。
-
可通过管道传输 — JSON 输出到 stdout,错误输出到 stderr
-
可筛选 —
--select保留字段子集。带点路径会深入嵌套结构;数组会逐元素遍历。在冗长 API 中,这对控制上下文大小至关重要:klaviyo-pp-cli accounts get --agent --select id,name,status -
可预览 —
--dry-run显示请求但不发送 -
适合离线使用 — 同步/搜索命令在本地 SQLite 存储可用时可以使用它
-
非交互式 — 从不提示输入,每项输入都通过标志传入
响应封装
从本地存储或 API 读取数据的命令会将输出封装在一个来源信息对象中:
{
"meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
"results": <data>
}
解析 .results 获取数据,并查看 .meta.source 判断数据来自实时 API 还是本地存储。只有在 stdout 是终端时,才会将人类可读的 N results (live) 摘要打印到 stderr——通过管道或由 Agent 使用时,stdout 只包含纯 JSON。
Agent 反馈
当你(或 Agent)发现此 CLI 有不妥之处时,请记录下来:
klaviyo-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
klaviyo-pp-cli feedback --stdin < notes.txt
klaviyo-pp-cli feedback list --json --limit 10
条目会存储在本地的 ~/.klaviyo-pp-cli/feedback.jsonl。除非设置了 KLAVIYO_FEEDBACK_ENDPOINT,并且传入了 --send 或将 KLAVIYO_FEEDBACK_AUTO_SEND 设置为 true,否则绝不会发送 POST 请求。默认行为仅保存到本地。
写下让你感到意外的地方,而不是提交错误报告。简短、具体、单行记录:这才是能持续积累价值的部分。
输出传递
每条命令都接受 --deliver <sink>。除了输出到 stdout,也可以将输出发送到指定的目标;还可以仅输出到该目标,让 Agent 无需手动通过管道传递命令结果。支持三种目标:
| 目标 | 效果 |
|---|---|
stdout | 默认;仅写入 stdout |
file:<path> | 原子地将输出写入 <path>(临时文件 + 重命名) |
webhook:<url> | 将输出正文 POST 到该 URL(使用 --compact 时为 application/json 或 application/x-ndjson) |
遇到未知方案时会拒绝处理,并返回结构化错误,指出支持的方案。Webhook 请求失败时会返回非零退出代码,并在 stderr 中记录 URL 和 HTTP 状态码。
命名配置
配置文件是一组已保存的标志值,可在多次调用中重复使用。如果定时 Agent 每次运行时都使用相同配置调用同一命令,请使用它——这是 HeyGen 的“Beacon”模式。
klaviyo-pp-cli profile save briefing --json
klaviyo-pp-cli --profile briefing accounts get
klaviyo-pp-cli profile list --json
klaviyo-pp-cli profile show briefing
klaviyo-pp-cli profile delete briefing --yes
显式标志始终优先于配置文件中的值;配置文件中的值优先于默认值。agent-context 会在 available_profiles 下列出所有可用配置文件,方便内省型 Agent 在运行时发现它们。
退出代码
| 代码 | 含义 |
|---|---|
| 0 | 成功 |
| 2 | 用法错误(参数错误) |
| 3 | 未找到资源 |
| 4 | 需要身份验证 |
| 5 | API 错误(上游问题) |
| 7 | 受到速率限制(等待后重试) |
| 10 | 配置错误 |
参数解析
解析 $ARGUMENTS:
- 为空、
help或--help→ 显示klaviyo-pp-cli --help的输出 - 以
install开头 → 以mcp结尾 → 安装 MCP;否则 → 参见上文的先决条件 - 其他任何内容 → 直接使用(将其作为 CLI 命令执行,并带上
--agent)
MCP 服务安装
- 安装 MCP 服务:
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-mcp@latest - 在 Claude Code 中注册:
claude mcp add klaviyo-pp-mcp -- klaviyo-pp-mcp - 验证:
claude mcp list
直接使用
- 检查是否已安装:
which klaviyo-pp-cli如果未找到,请提供安装选项(参见本技能顶部的先决条件)。 - 根据用户查询,从上文的独特功能和命令参考中选择最合适的命令。
- 使用
--agent标志执行:klaviyo-pp-cli <command> [subcommand] [args] --agent - 如果有歧义,请深入查看子命令帮助:
klaviyo-pp-cli <command> --help。