快看广告文档中心

# openAPI 接口文档

# 修订历史

历史版本 发布时间 修改内容
V1.0 2023-04-06 初版发布

# 一、简介

快看后羿 openAPI 提供给广告主报表数据查询的接口。该文档提供了如何配置 API 的详细说明，同时明确了 API 提供的数据范围。如有问题，请及时与我们联系。

# 二、申请条件和开通方法

使用快看后羿 openAPI 前，请在后羿后台‘个人中心-账号中心’页面获取获取 api_secret，用于为请求参数签名。若此参数为空，请与我们联系申请开通权限。

# 三、服务信息

# 1.请求地址

https://houyi.kkmh.com/kyle/open/api/advertiser/stat/data (opens new window)

# 2.请求方法

GET

# 四、请求方式

# 1.请求示例

https://houyi.kkmh.com/kyle/open/api/advertiser/stat/data?account_id=1090&granularity=1&start_time=1669824000000&end_time=1672502399000&timestamp=1677657161444&sign=841ca0be6ca64a0e7f7ddef377f509e4 (opens new window)

# 2.请求参数

字段 类型 是否必须 含义
account_id long 是 广告主账户ID
granularity int 是 数据维度 1-天级数据，2-小时级数据
start_date long 是 起始时间戳，精确到毫秒,距离当前日期的时间跨度小于30天
end_date long 是 结束时间，精确到毫秒,天级数据T+1拉取/小时级数据延迟一个小时拉取
timestamp long 是 发送请求的当前时间戳，精确到毫秒
sign string 是 加密签名, 加密规则见下方说明

# 3.签名方式

为防止 API 在调用过程中被恶意者拦截随意篡改，调用 API 时需要传入签名参数（sign），我们会根据请求参数对签名进行验证，判断请求参数是否合法。签名规则过程如下：

接口参数部分(除了 sign)按参数名升序排序后，将 api_secret={api_secret} 拼接到最后，做 md5 计算校验码。

示例：

1.未签名的 URL为 https://houyi.kkmh.com/kyle/open/api/advertiser/stat/data?account_id=1090&granularity=2&start_time=1669824000000&end_time=1672502399000&timestamp=1677657161444 (opens new window)

2.参数名升序排序为 account_id、end_date、granularity、start_date、timestamp，将签名密钥 api_secret={api_secret} 的值拼接到末尾后进行md5。

3.md5("account_id=1090&end_time=1672502399000&granularity=1&start_time=1669824000000&timestamp=1677657161444&api_secret=JUEwvupoXx“) => 841ca0be6ca64a0e7f7ddef377f509e4 ，其中 JUEwvupoXx 为广告主真实的api_secret

4.最终的URL: https://houyi.kkmh.com/kyle/open/api/advertiser/stat/data?account_id=1090&granularity=2&start_time=1669824000000&end_time=1672502399000&timestamp=1677657161444&sign=841ca0be6ca64a0e7f7ddef377f509e4 (opens new window)

# 五、数据返回

# 1.状态返回

状态码和返回数据支持 HTTP 标准状态码，应答数据包含三部分内容，分别为状态返回、信息返回和数据返回。

字段 类型 是否必须 含义
code int 是 等于200表示成功,不等于200表示错误,具体见返回码
msg string 是 code 不等于200时，message 为具体错误信息
data list of object 是 对象列表，具体返回内容见各接口定义

示例：

{
    "code": 200,
    "data": [
         {
            "time": 1671361200000,
            "group_id": 309,
            "group_name": "后羿广告组测试数据",
            "campaign_id": 786,
            "campaign_name": "后羿广告计划测试数据",
            "creative_id": 870,
            "creative_name": "后羿广告创意测试数据",
            "template_name": "常规信息流",
            "total_consume": 2400.00,
            "impression": 9,
            "click": 6,
            "click_rate": 0.6667,
            "cpc": 400.00,
            "cpm": 266666.67,
            "download_start_num": 0,
            "download_complete_num": 0,
            "installed_num": 0
            ...
        },
    ],
    "message": "ok"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 2.数据返回

字段 类型 是否必须 含义
group_id long 是 组名ID
group_name string 是 组名称
campaign_id long 是 计划ID
campaign_name string 是 计划名称
creative_id long 是 创意ID
creative_name string 是 创意名称
template_name string 是 创意样式
time long 是 数据时间戳
total_consume double 否 总消耗(元)
impression long 否 曝光量
click long 否 点击量
click_rate double 否 点击率
cpc double 否 cpc(元)
cpm double 否 cpm(元)
download_start_num long 否 开始下载数
download_complete_num long 否 下载完成数
installed_num long 否 安装数
active_num long 否 激活量
active_rate double 否 激活率
active_cost double 否 激活成本
register_num long 否 注册量
register_rate double 否 注册率
register_cost double 否 注册成本
arouse_num long 否 唤起量
arouse_rate double 否 唤起率
arouse_cost double 否 唤起成本
form_submit_num long 否 表单提交量
form_submit_rate double 否 表单提交率
form_submit_cost double 否 表单提交成本
app_store_num long 否 appStore跳转数
app_store_rate double 否 appStore跳转率
app_store_cost double 否 appStore跳转成本
reserve_download_num long 否 安卓预约下载数
reserve_download_rate double 否 安卓预约下载率
reserve_download_cost double 否 安卓预约下载成本
phone_consult_num long 否 电话咨询量
phone_consult_rate double 否 电话咨询率
phone_consult_cost double 否 电话咨询成本
goods_buy_num long 否 商品购买量
goods_buy_rate double 否 商品购买率
goods_buy_cost double 否 商品购买成本
download_num long 否 app下载量
download_rate double 否 app下载率
download_cost double 否 app下载成本
payment_num long 否 付费量
payment_rate double 否 付费率
payment_cost double 否 付费成本
second_retention_num long 否 次日留存量
second_retention_rate double 否 次日留存率
second_retention_cost double 否 次日留存成本
third_retention_num long 否 三日留存量
third_retention_rate double 否 三日留存率
third_retention_cost double 否 三日留存成本
seventh_retention_num long 否 七日留存量
seventh_retention_rate double 否 七日留存率
seventh_retention_cost double 否 七日留存成本
conv_num long 否 转化量
conv_rate double 否 转化率
conv_cost double 否 转化成本

###3.响应态状码

返回值 Code 含义
200 正确
10001 未知系统错误
407101 没有权限，请联系快看运营授权
407102 当前时间戳不正确
407103 没有权限，请联系快看运营授权
407104 签名错误
407105 开始时间超过一个月

# 六、注意事项

1.请求频率：单账户1天内最多请求1000次.

2.数据周期：可拉取30日内的数据.

更新于: 4/10/2023, 5:40:35 PM

← Q&A →