Zenler (独立出版社) (预览版)
Zenler 是一个一体的课程创建、交付和营销平台。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 连接器元数据 | |
|---|---|
| 发布者 | 特洛伊·泰勒 |
| 网站 | https://www.newzenler.com/ |
| 隐私策略 | https://www.newzenler.com/privacy-policy |
| 类别 | 商业管理 |
创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 密钥 | securestring | 此 API 的 API 密钥 | True |
| 帐户名 | securestring | 此 API 的帐户名称 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 删除用户 |
从帐户中删除用户。 |
| 取消注册用户 |
从课程取消注册用户。 |
| 取消注册类 |
取消注册实时类的用户。 |
| 取消注册网络研讨会 |
注销用户进行实时网络研讨会。 |
| 取消订阅漏斗图 |
取消订阅漏斗中的用户。 |
| 更新用户 |
更新用户的信息。 |
| 注册用户 |
将用户注册到课程。 |
| 注册类 |
为实时类注册用户。 |
| 注册网络研讨会 |
注册用户进行实时网络研讨会。 |
| 添加用户 |
创建新用户。 |
| 获取即将上课的类 |
检索即将上线的实时课程的列表。 |
| 获取即将举行的网络研讨会 |
检索即将推出的实时网络研讨会列表。 |
| 获取漏斗图 |
检索漏斗列表。 |
| 获取漏斗的注册 |
检索漏斗的注册列表。 |
| 获取用户列表 |
检索用户列表。 |
| 获取用户详细信息 |
检索有关用户的信息。 |
| 获取简短的关联报告 |
检索关联公司的简短报告。 |
| 获取简短的注册报告 |
检索注册的简短列表。 |
| 获取简短的课程进度报告 |
检索进度的简短报告。 |
| 获取简短的销售报表 |
检索销售的简短报表。 |
| 获取详细的关联报告 |
检索关联公司的详细报告。 |
| 获取详细的注册报告 |
检索注册的详细列表。 |
| 获取详细的课程进度报告 |
检索进度的详细报告。 |
| 获取详细的销售报表 |
检索详细的销售报表。 |
| 获取课程 |
按课程标识符检索课程。 |
| 获取课程列表 |
检索课程列表。 |
| 订阅漏斗图 |
将用户订阅漏斗图。 |
删除用户
从帐户中删除用户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
用户 ID
|
user_id | True | string |
用户标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Data
|
data | string |
数据。 |
取消注册用户
从课程取消注册用户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
用户 ID
|
user_id | True | string |
用户标识符。 |
|
课程 ID
|
course_id | True | string |
课程标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Message
|
data.message | string |
消息。 |
取消注册类
取消注册实时类的用户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Live 类 ID
|
liveclass_id | True | string |
实时类标识符。 |
|
Email
|
string |
电子邮件。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Data
|
data | string |
数据。 |
取消注册网络研讨会
注销用户进行实时网络研讨会。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
网络研讨会 ID
|
webinar_id | True | string |
网络研讨会标识符。 |
|
Email
|
True | string |
电子邮件地址。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Data
|
data | string |
数据。 |
取消订阅漏斗图
取消订阅漏斗中的用户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
漏斗 ID
|
funnel_id | True | string |
漏斗标识符。 |
|
Email
|
string |
电子邮件。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Data
|
data | string |
数据。 |
更新用户
更新用户的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
用户 ID
|
user_id | True | string |
用户标识符。 |
|
名字
|
first_name | True | string |
名。 |
|
姓氏
|
last_name | True | string |
姓。 |
|
Email
|
True | string |
电子邮件地址。 |
|
|
密码
|
password | True | string |
密码。 |
|
佣金
|
commission | True | integer |
委员会。 |
|
角色
|
roles | True | string |
角色。 |
|
地址
|
address | string |
地址。 |
|
|
City
|
city | string |
城市。 |
|
|
State
|
state | string |
省/市/自治区。 |
|
|
电话
|
phone | string |
电话号码。 |
|
|
邮政编码
|
zip_code | integer |
邮政编码。 |
|
|
国家
|
country | string |
国家/ 地区。 |
|
|
GDPR 同意状态
|
gdpr_consent_status | integer |
GDPR 同意状态。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Message
|
data.message | string |
消息。 |
注册用户
将用户注册到课程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
用户 ID
|
user_id | True | string |
用户标识符。 |
|
课程 ID
|
course_id | True | string |
课程标识符。 |
|
计划 ID
|
plan_id | string |
计划标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Data
|
data | string |
数据。 |
注册类
为实时类注册用户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Live 类 ID
|
liveclass_id | True | string |
实时类标识符。 |
|
Name
|
name | True | string |
名称。 |
|
Email
|
True | string |
电子邮件地址。 |
|
|
姓氏
|
last_name | string |
姓。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Name
|
data.name | string |
名称。 |
|
Email
|
data.email | string |
电子邮件地址。 |
|
Live 类
|
data.live class | string |
实时课堂。 |
|
Message
|
data.message | string |
消息。 |
注册网络研讨会
注册用户进行实时网络研讨会。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
网络研讨会 ID
|
webinar_id | True | string |
网络研讨会标识符。 |
|
Name
|
name | True | string |
名称。 |
|
Email
|
True | string |
电子邮件地址。 |
|
|
姓氏
|
last_name | string |
姓。 |
|
|
地址
|
address | string |
地址。 |
|
|
City
|
city | string |
城市。 |
|
|
State
|
state | string |
省/市/自治区。 |
|
|
电话
|
phone | string |
电话号码。 |
|
|
邮政编码
|
zip_code | integer |
邮政编码。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Name
|
data.name | string |
名称。 |
|
Email
|
data.email | string |
电子邮件地址。 |
|
实时网络研讨会
|
data.live webinar | string |
实时网络研讨会。 |
|
Message
|
data.message | string |
消息。 |
添加用户
创建新用户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
名字
|
first_name | True | string |
名。 |
|
姓氏
|
last_name | True | string |
姓。 |
|
Email
|
True | string |
电子邮件地址。 |
|
|
密码
|
password | True | string |
密码。 |
|
佣金
|
commission | True | integer |
委员会。 |
|
角色
|
roles | True | string |
角色。 |
|
地址
|
address | string |
地址。 |
|
|
City
|
city | string |
城市。 |
|
|
State
|
state | string |
省/市/自治区。 |
|
|
电话
|
phone | string |
电话号码。 |
|
|
邮政编码
|
zip_code | integer |
邮政编码。 |
|
|
国家
|
country | string |
国家/ 地区。 |
|
|
GDPR 同意状态
|
gdpr_consent_status | integer |
GDPR 同意状态。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
ID
|
data.id | string |
标识符。 |
|
名字
|
data.first_name | string |
名。 |
|
姓氏
|
data.last_name | string |
姓。 |
|
Email
|
data.email | string |
电子邮件地址。 |
获取即将上课的类
检索即将上线的实时课程的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
订单依据
|
orderby | string |
按字段排序。 |
|
|
下单
|
order | string |
订单。 |
|
|
搜寻
|
search | string |
搜索词。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
标识符。 |
|
主题
|
data.items.topic | string |
主题。 |
|
计划日期
|
data.items.schedule_date | string |
计划日期。 |
|
Timezone
|
data.items.timezone | string |
时区。 |
|
持续时间
|
data.items.duration | integer |
持续时间。 |
|
注册 URL
|
data.items.register_url | string |
注册 URL 地址。 |
|
定期
|
data.items.recurring | boolean |
是否定期执行。 |
|
最近的定期计划
|
data.items.recent_recurring_schedule | string |
最近的定期计划。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取即将举行的网络研讨会
检索即将推出的实时网络研讨会列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
订单依据
|
orderby | string |
按字段排序。 |
|
|
下单
|
order | string |
订单。 |
|
|
搜寻
|
search | string |
搜索词。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
标识符。 |
|
主题
|
data.items.topic | string |
主题。 |
|
计划日期
|
data.items.schedule_date | string |
计划日期。 |
|
Timezone
|
data.items.timezone | string |
时区。 |
|
持续时间
|
data.items.duration | integer |
持续时间。 |
|
注册 URL
|
data.items.register_url | string |
注册 URL 地址。 |
|
定期
|
data.items.recurring | boolean |
是否定期执行。 |
|
最近的定期计划
|
data.items.recent_recurring_schedule | string |
最近的定期计划。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取漏斗图
检索漏斗列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
订单依据
|
orderby | string |
按字段排序。 |
|
|
下单
|
order | string |
订单。 |
|
|
搜寻
|
search | string |
搜索词。 |
|
|
状态
|
status | integer |
状态。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
标识符。 |
|
Name
|
data.items.name | string |
名称。 |
|
类型
|
data.items.type | string |
类型。 |
|
URL
|
data.items.url | string |
URL 地址。 |
|
潜在顾客总数
|
data.items.total_leads | integer |
潜在顾客总数。 |
|
缩略图
|
data.items.thumbnail | string |
缩略图。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取漏斗的注册
检索漏斗的注册列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
漏斗 ID
|
funnel_id | True | string |
漏斗标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
ID
|
data.items.id | string |
标识符。 |
|
名字
|
data.items.first_name | string |
名。 |
|
姓氏
|
data.items.last_name | string |
姓。 |
|
Email
|
data.items.email | string |
电子邮件地址。 |
|
已注册日期
|
data.items.enrolled_on | string |
注册时。 |
获取用户列表
检索用户列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
订单依据
|
orderby | string |
按字段排序。 |
|
|
下单
|
order | string |
订单。 |
|
|
搜寻
|
search | string |
搜索词。 |
|
|
角色
|
role | integer |
角色。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
ID
|
data.items.id | string |
标识符。 |
|
名字
|
data.items.first_name | string |
名。 |
|
姓氏
|
data.items.last_name | string |
姓。 |
|
Email
|
data.items.email | string |
电子邮件地址。 |
|
角色
|
data.items.roles | array of integer |
角色。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取用户详细信息
检索有关用户的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
用户 ID
|
user_id | True | string |
用户标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
ID
|
data.id | string |
标识符。 |
|
名字
|
data.first_name | string |
名。 |
|
姓氏
|
data.last_name | string |
姓。 |
|
Email
|
data.email | string |
电子邮件地址。 |
|
个人简介
|
data.bio | string |
传记。 |
|
地址
|
data.address | string |
地址。 |
|
City
|
data.city | string |
城市。 |
|
State
|
data.state | string |
状态。 |
|
邮政编码
|
data.zip_code | string |
邮政编码。 |
|
角色
|
data.roles | array of integer | |
|
电话
|
data.phone | string |
电话号码。 |
获取简短的关联报告
检索关联公司的简短报告。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
课程 ID
|
course_ids[] | string |
课程标识符。 |
|
|
关联 ID
|
affiliate_ids[] | string |
关联标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
货币
|
data.items.currency | string |
货币。 |
|
Aff ID
|
data.items.aff_id | string |
关联标识符。 |
|
Aff 名称
|
data.items.aff_name | string |
关联名称。 |
|
Aff Email
|
data.items.aff_email | string |
关联者的电子邮件地址。 |
|
总销售额计数
|
data.items.total_sales_count | integer |
总销售额计数。 |
|
佣金总数
|
data.items.total_commission | string |
总佣金。 |
|
待定佣金
|
data.items.pending_commission | string |
待决的佣金。 |
|
付费佣金
|
data.items.paid_commission | string |
付费佣金。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | string |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | string |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取简短的注册报告
检索注册的简短列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
课程 ID
|
course_id | string |
课程标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
课程 ID
|
data.items.course_id | integer |
课程标识符。 |
|
课程名称
|
data.items.course_name | string |
课程名称。 |
|
注册数
|
data.items.no_of_enrollments | integer |
注册数。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取简短的课程进度报告
检索进度的简短报告。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
课程 ID
|
course_ids[] | string |
课程标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
课程 ID
|
data.items.course_number.courseId | integer |
课程标识符。 |
|
开始日期
|
data.items.course_number.start_date | string |
开始日期。 |
|
上次日期
|
data.items.course_number.last_date | string |
最后一个日期。 |
|
课程名称
|
data.items.course_number.courseName | string |
课程名称。 |
|
学生总数
|
data.items.course_number.total_students | integer |
学生总数。 |
|
未启动
|
data.items.course_number.not_started | integer |
是否启动。 |
|
正在进行中
|
data.items.course_number.in_progress | integer |
是否正在进行。 |
|
完成
|
data.items.course_number.completed | integer |
是否已完成。 |
|
通过率
|
data.items.course_number.pass_rate | integer |
通过率。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | string |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | string |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取简短的销售报表
检索销售的简短报表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
分组
|
groupby | string |
分组依据。 |
|
|
课程 ID
|
course_ids | string |
课程标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
总销售额
|
data.items.total_sales | integer |
总销售额。 |
|
课程 ID
|
data.items.course_id | integer |
课程标识符。 |
|
收益总额
|
data.items.earnings_total | string |
收益总额。 |
|
销售总额
|
data.items.sales_total | string |
总销售额。 |
|
Aff Fee
|
data.items.aff_fee | string |
关联费用。 |
|
Name
|
data.items.name | string |
名称。 |
|
星期
|
data.items.day | string |
日。 |
|
月份
|
data.items.month | string |
月份。 |
|
货币
|
data.items.currency | string |
货币。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取详细的关联报告
检索关联公司的详细报告。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
课程 ID
|
course_ids[] | string |
课程标识符。 |
|
|
关联 ID
|
affiliate_ids[] | string |
关联标识符。 |
|
|
高级筛选器
|
af_v | string |
高级筛选器。 |
|
|
优惠券为
|
coupon_is[] | string |
优惠券是。 |
|
|
优惠券赞
|
coupon_like[] | string |
优惠券就像。 |
|
|
名称为
|
name_is[] | string |
名称为< |
|
|
名称赞
|
name_like[] | string |
名称类似于。 |
|
|
电子邮件为
|
email_is[] | string |
电子邮件是。 |
|
|
电子邮件赞
|
email_like[] | string |
电子邮件如下所示。 |
|
|
关联是
|
affiliate_is[] | string |
关联是。 |
|
|
付款类型
|
payment_type | string |
付款类型。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
课程
|
data.items.course | string |
课程。 |
|
创建时间
|
data.items.created_at | string |
创建时。 |
|
销售价格
|
data.items.sales_price | string |
销售价格。 |
|
优惠券折扣
|
data.items.coupon_discount | string |
优惠券折扣。 |
|
佣金
|
data.items.commission | string |
委员会。 |
|
付款状态
|
data.items.payout_status | string |
付款状态。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取详细的注册报告
检索注册的详细列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
课程 ID
|
course_id | string |
课程标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
课程 ID
|
data.items.course_id | integer |
课程标识符。 |
|
用户 ID
|
data.items.user_id | string |
用户标识符。 |
|
课程名称
|
data.items.course_name | string |
课程名称。 |
|
名字
|
data.items.first_name | string |
名。 |
|
姓氏
|
data.items.last_name | string |
姓。 |
|
Email
|
data.items.email | string |
电子邮件地址。 |
|
注册日期
|
data.items.enrollment_date | string |
注册日期。 |
获取详细的课程进度报告
检索进度的详细报告。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
课程 ID
|
course_ids[] | string |
课程标识符。 |
|
|
高级筛选器
|
af_v | string |
高级筛选器。 |
|
|
优惠券为
|
coupon_is[] | string |
优惠券是。 |
|
|
优惠券赞
|
coupon_like[] | string |
优惠券就像。 |
|
|
名称为
|
name_is[] | string |
名称为< |
|
|
名称赞
|
name_like[] | string |
名称类似于。 |
|
|
电子邮件为
|
email_is[] | string |
电子邮件是。 |
|
|
电子邮件赞
|
email_like[] | string |
电子邮件如下所示。 |
|
|
关联是
|
affiliate_is[] | string |
关联是。 |
|
|
付款类型
|
payment_type | integer |
付款类型。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
用户唯一标识 (UID)
|
data.items.course_number.uid | string |
唯一标识符。 |
|
课程 ID
|
data.items.course_number.courseId | string |
课程标识符。 |
|
Name
|
data.items.course_number.name | string |
名称。 |
|
Email
|
data.items.course_number.email | string |
电子邮件地址。 |
|
注册日期
|
data.items.course_number.enrollment_date | string |
注册日期。 |
|
开始日期
|
data.items.course_number.start_date | string |
开始日期。 |
|
已完成日期
|
data.items.course_number.completed_date | string |
已完成的日期。 |
|
状态
|
data.items.course_number.status | string |
状态。 |
|
上一次出席
|
data.items.course_number.last_attended | string |
上次参加的时候。 |
|
完成百分比
|
data.items.course_number.completion_percentage | integer |
完成百分比。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | string |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | string |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取详细的销售报表
检索详细的销售报表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
开始日期
|
start_date | string |
开始日期。 |
|
|
结束日期
|
end_date | string |
结束日期。 |
|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
课程 ID
|
course_ids | string |
课程标识符。 |
|
|
付款类型
|
payment_type | integer |
付款类型。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
创建时间
|
data.items.created_at | string |
创建时。 |
|
事务 ID
|
data.items.transaction_id | string |
事务标识符。 |
|
销售价格
|
data.items.sales_price | string |
销售价格。 |
|
赚取价格
|
data.items.earn_price | string |
赚取价格。 |
|
学生姓名
|
data.items.student_name | string |
学生的姓名。 |
|
学生电子邮件
|
data.items.student_email | string |
学生的电子邮件地址。 |
|
课程
|
data.items.course | string |
课程。 |
|
课程 ID
|
data.items.course_id | integer |
课程标识符。 |
|
优惠券代码
|
data.items.coupon_code | string |
优惠券代码。 |
|
支付网关
|
data.items.payment_gateway | string |
支付网关。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
获取课程
按课程标识符检索课程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
课程 ID
|
course_id | True | string |
课程标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
ID
|
data.items.id | integer |
标识符。 |
|
Name
|
data.items.name | string |
名称。 |
|
副标题
|
data.items.subtitle | string |
副标题。 |
|
缩略图
|
data.items.thumbnail | string |
缩略图。 |
|
课程类型
|
data.items.course_type | integer |
课程类型。 |
|
所有者
|
data.items.owner | string |
所有者。 |
|
学校 ID
|
data.items.school_id | integer |
学校标识符。 |
|
公众
|
data.items.public | integer |
是否公开。 |
|
特色
|
data.items.featured | integer |
是否特别推荐 。 |
|
隐藏
|
data.items.hidden | integer |
是否隐藏。 |
|
专用
|
data.items.private | integer |
是否专用。 |
获取课程列表
检索课程列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
限制。 |
|
|
页
|
page | integer |
页码。 |
|
|
订单依据
|
orderby | string |
按字段排序。 |
|
|
下单
|
order | string |
订单。 |
|
|
搜寻
|
search | string |
搜索词。 |
|
|
类型
|
type | integer |
类型。 |
|
|
状态
|
status | integer |
状态。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
物品
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
标识符。 |
|
Name
|
data.items.name | string |
名称。 |
|
副标题
|
data.items.subtitle | string |
副标题。 |
|
缩略图
|
data.items.thumbnail | string |
缩略图。 |
|
URL
|
data.items.url | string |
URL 地址。 |
|
项目总数
|
data.pagination.total_items | integer |
项总数。 |
|
每页的项目数
|
data.pagination.items_per_page | integer |
每页的项数。 |
|
页面索引
|
data.pagination.page_index | integer |
页索引。 |
|
总页数
|
data.pagination.total_pages | integer |
总页数。 |
订阅漏斗图
将用户订阅漏斗图。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
漏斗 ID
|
funnel_id | True | string |
漏斗标识符。 |
|
Name
|
name | True | string |
名称。 |
|
Email
|
True | string |
电子邮件地址。 |
|
|
姓氏
|
last_name | string |
姓。 |
|
|
地址
|
address | string |
地址。 |
|
|
City
|
city | string |
城市。 |
|
|
State
|
state | string |
省/市/自治区。 |
|
|
电话
|
phone | string |
电话号码。 |
|
|
邮政编码
|
zip_code | integer |
邮政编码。 |
|
|
国家
|
country | string |
国家/ 地区。 |
|
|
GDPR 同意状态
|
gdpr_consent_status | integer |
GDPR 同意状态。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应代码
|
response_code | integer |
响应代码。 |
|
Message
|
message | string |
响应消息。 |
|
Name
|
data.name | string |
名称。 |
|
Email
|
data.email | string |
电子邮件地址。 |
|
漏斗
|
data.funnel | string |
漏斗图。 |