广告店铺数据分析接口
1. 全平台数据统计分析
接口信息
- 接口名称: 店铺详情全平台数据统计分析
- 请求方法: POST
- 接口地址:
/open-api/v1/data
- 接口路径:
/v3/api/open/store/allPlatform/dataAnalysis
- 接口描述: 获取店铺在所有平台(TikTok、Facebook、Meta广告资料库)的汇总数据分析
- 价格:
免费
请求头:
- Content-Type: application/json
- Accept: application/json
请求参数
请求结构
| 参数名 |
类型 |
描述 |
示例 |
必填 |
默认值 |
| key |
string |
用户申请的外部 api 请求 key |
"your_api_key_here" |
是 |
|
| uri |
string |
接口路径 |
"/v3/api/open/store/allPlatform/dataAnalysis" |
是 |
|
| params |
object |
接口入参对象 |
见参数列表 |
是 |
|
标准响应字段
| 字段名 |
类型 |
描述 |
| remaining_credits |
Long |
当前请求后的剩余可用积分 |
| consumed_credits |
Long |
本次请求消耗的积分 |
参数列表 (params 对象)
| 参数名 |
类型 |
必填 |
描述 |
| id |
String |
是 |
店铺 ID 为 13 位字符串(例如:c2d5b2547218a),对应店铺榜单列表接口返回结果中的 store_id 字段 |
| start_time |
Long |
否 |
开始时间,时间戳,单位秒 |
| end_time |
Long |
否 |
结束时间,时间戳,单位秒 |
请求示例
curl -X POST "https://www.pipispy.com/open-api/v1/data" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"key": "your_api_key_here",
"uri": "/v3/api/open/store/allPlatform/dataAnalysis",
"params": {
"id": "store_123456",
"start_time": 1675830644,
"end_time": 1752202412
}
}'
响应参数
响应体结构
{
"code": 200,
"message": "success",
"data": {},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 20,
"success": true,
"fail": false
}
数据字段说明
全平台汇总数据
| 字段名 |
类型 |
描述 |
| all_play_count |
Long |
全平台汇总广告视频播放量(TikTok + Facebook + Meta广告资料库) |
| all_digg_count |
Long |
TikTok + Facebook 点赞数(不包含Meta广告资料库) |
| all_digg_play_rate |
BigDecimal |
点赞率,即 (TikTok + Facebook点赞数) / (TikTok + Facebook播放量),未乘以100% |
| all_data_count |
Long |
全平台汇总广告总量 |
| all_min_cpm |
BigDecimal |
全平台最小广告花费(美元),即各平台min_cpm之和 |
| all_max_cpm |
BigDecimal |
全平台最大广告花费(美元),即各平台max_cpm之和 |
| all_put_days |
Long |
全平台投放天数,即各平台投放天数之和(不受时间控件影响) |
| all_start_time |
Long |
全平台首次广告时间,取各平台最早时间(时间戳,秒) |
| all_end_time |
Long |
全平台最后广告时间,取各平台最晚时间(时间戳,秒) |
点赞日增量分析 (digg_inc_analytic)
| 字段名 |
类型 |
描述 |
| statistics_time |
Long |
统计时间(时间戳,秒) |
| tiktokDiggIncCount |
Long |
TikTok 在该天的点赞增量 |
| facebookDiggIncCount |
Long |
Facebook 在该天的点赞增量 |
广告日增量分析 (adIncAnalytics)
| 字段名 |
类型 |
描述 |
| statistics_time |
Long |
统计时间(时间戳,秒) |
| tiktok_inc_data_count |
Long |
TikTok 在该天的广告数增量 |
| facebook_inc_data_count |
Long |
Facebook 在该天的广告数增量 |
| facebookLibraryIncDataCount |
Long |
Meta广告资料库在该天的广告数增量 |
平台数据分析 (tiktokAnalytic / facebookAnalytic / facebookLibraryAnalytic)
| 字段名 |
类型 |
描述 |
| play_count |
Long |
平台广告视频播放量 |
| digg_count |
Long |
平台点赞数(Meta广告资料库无此字段) |
| digg_play_rate |
BigDecimal |
平台点赞率,即 digg_count / play_count(Meta广告资料库无此字段) |
| data_count |
Long |
平台广告数量 |
| put_day |
Long |
平台广告投放天数 |
| min_cpm |
BigDecimal |
平台最小广告花费(美元) |
| max_cpm |
BigDecimal |
平台最大广告花费(美元) |
| start_time |
Long |
平台首次广告时间(时间戳,秒) |
| end_time |
Long |
平台最后广告时间(时间戳,秒) |
响应示例
{
"code": 200,
"message": "success",
"data": {
"all_play_count": 76792774635,
"all_digg_count": 1500000000,
"all_digg_play_rate": 0.0215,
"all_data_count": 2500,
"all_min_cpm": 45.5,
"all_max_cpm": 130.3,
"all_put_days": 360,
"all_start_time": 1675830644,
"all_end_time": 1752202412,
"digg_inc_analytic": [
{
"statistics_time": 1752115200,
"tiktokDiggIncCount": 1200000,
"facebookDiggIncCount": 800000
}
],
"adIncAnalytics": [
{
"statistics_time": 1752115200,
"tiktok_inc_data_count": 50,
"facebook_inc_data_count": 30,
"facebookLibraryIncDataCount": 20
}
],
"tiktokAnalytic": {
"play_count": 50000000000,
"digg_count": 1000000000,
"digg_play_rate": 0.02,
"data_count": 1000,
"put_day": 150,
"min_cpm": 18.0,
"max_cpm": 42.5,
"start_time": 1675830644,
"end_time": 1752202412
},
"facebookAnalytic": {
"play_count": 20000000000,
"digg_count": 500000000,
"digg_play_rate": 0.025,
"data_count": 800,
"put_day": 120,
"min_cpm": 12.0,
"max_cpm": 38.0,
"start_time": 1680000000,
"end_time": 1752000000
},
"facebookLibraryAnalytic": {
"play_count": 6792774635,
"digg_count": null,
"digg_play_rate": null,
"data_count": 700,
"put_day": 90,
"min_cpm": 15.5,
"max_cpm": 49.8,
"start_time": 1685000000,
"end_time": 1752202412
}
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 20,
"success": true,
"fail": false
}
2. TikTok平台数据统计分析
接口信息
- 接口名称: TikTok平台数据统计分析
- 请求方法: POST
- 接口地址:
/open-api/v1/data
- 接口路径:
/v3/api/open/store/tiktokPlatform/dataAnalysis
- 接口描述: 获取店铺在TikTok平台的广告数据分析
- 价格:
免费
请求头:
- Content-Type: application/json
- Accept: application/json
请求参数
请求结构
| 参数名 |
类型 |
描述 |
示例 |
必填 |
默认值 |
| key |
string |
用户申请的外部 api 请求 key |
"your_api_key_here" |
是 |
|
| uri |
string |
接口路径 |
"/v3/api/open/store/tiktokPlatform/dataAnalysis" |
是 |
|
| params |
object |
接口入参对象 |
见参数列表 |
是 |
|
参数列表 (params 对象)
| 参数名 |
类型 |
必填 |
描述 |
| id |
String |
是 |
店铺 ID 为 13 位字符串(例如:c2d5b2547218a),对应店铺榜单列表接口返回结果中的 store_id 字段id |
| start_time |
Long |
否 |
开始时间,时间戳,单位秒 |
| end_time |
Long |
否 |
结束时间,时间戳,单位秒 |
请求示例
curl -X POST "https://www.pipispy.com/open-api/v1/data" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"key": "your_api_key_here",
"uri": "/v3/api/open/store/tiktokPlatform/dataAnalysis",
"params": {
"id": "store_123456",
"start_time": 1675830644,
"end_time": 1752202412
}
}'
响应参数
响应体结构
{
"code": 200,
"message": "success",
"data": {},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 20,
"success": true,
"fail": false
}
数据字段说明
| 字段名 |
类型 |
描述 |
| play_count |
Long |
TikTok平台广告视频播放量 |
| digg_count |
Long |
TikTok平台点赞数 |
| digg_play_rate |
BigDecimal |
TikTok平台点赞率 |
| data_count |
Long |
TikTok平台广告数量 |
| put_day |
Long |
TikTok平台广告投放天数 |
| min_cpm |
BigDecimal |
TikTok平台最小广告花费(美元) |
| max_cpm |
BigDecimal |
TikTok平台最大广告花费(美元) |
| min_cpa |
BigDecimal |
TikTok平台最小转化数 |
| max_cpa |
BigDecimal |
TikTok平台最大转化数 |
| start_time |
Long |
TikTok平台首次广告时间(时间戳,秒) |
| end_time |
Long |
TikTok平台最后广告时间(时间戳,秒) |
响应示例
{
"code": 200,
"message": "success",
"data": {
"play_count": 50000000000,
"digg_count": 1000000000,
"digg_play_rate": 0.02,
"data_count": 1000,
"put_day": 150,
"min_cpm": 18.0,
"max_cpm": 42.5,
"min_cpa": 60.0,
"max_cpa": 450.0,
"start_time": 1675830644,
"end_time": 1752202412
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 20,
"success": true,
"fail": false
}
3. Facebook平台数据统计分析
接口信息
-
接口名称: Facebook平台数据统计分析
-
请求方法: POST
-
接口地址: /open-api/v1/data
-
接口路径: /v3/api/open/store/facebookPlatform/dataAnalysis
-
接口描述: 获取店铺在Facebook平台的广告数据分析
-
价格: 免费
请求头:
-
Content-Type: application/json
-
Accept: application/json
请求参数
请求结构
| 参数名 |
类型 |
描述 |
示例 |
必填 |
默认值 |
| key |
string |
用户申请的外部 api 请求 key |
"your_api_key_here" |
是 |
|
| uri |
string |
接口路径 |
"/v3/api/open/store/facebookPlatform/dataAnalysis" |
是 |
|
| params |
object |
接口入参对象 |
见参数列表 |
是 |
|
参数列表 (params 对象)
| 参数名 |
类型 |
必填 |
描述 |
| id |
String |
是 |
店铺 ID 为 13 位字符串(例如:c2d5b2547218a),对应店铺榜单列表接口返回结果中的 store_id 字段 |
| start_time |
Long |
否 |
开始时间,时间戳,单位秒 |
| end_time |
Long |
否 |
结束时间,时间戳,单位秒 |
请求示例
curl -X POST "https://www.pipispy.com/open-api/v1/data" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"key": "your_api_key_here",
"uri": "/v3/api/open/store/facebookPlatform/dataAnalysis",
"params": {
"id": "store_123456",
"start_time": 1675830644,
"end_time": 1752202412
}
}'
响应参数
响应体结构
{
"code": 200,
"message": "success",
"data": {},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 20,
"success": true,
"fail": false
}
数据字段说明
| 字段名 |
类型 |
描述 |
| play_count |
Long |
Facebook平台广告视频播放量 |
| digg_count |
Long |
Facebook平台点赞数 |
| digg_play_rate |
BigDecimal |
Facebook平台点赞率 |
| data_count |
Long |
Facebook平台广告数量 |
| put_day |
Long |
Facebook平台广告投放天数 |
| min_cpm |
BigDecimal |
Facebook平台最小广告花费(美元) |
| max_cpm |
BigDecimal |
Facebook平台最大广告花费(美元) |
| min_cpa |
BigDecimal |
Facebook平台最小转化数 |
| max_cpa |
BigDecimal |
Facebook平台最大转化数 |
| start_time |
Long |
Facebook平台首次广告时间(时间戳,秒) |
| end_time |
Long |
Facebook平台最后广告时间(时间戳,秒) |
响应示例
{
"code": 200,
"message": "success",
"data": {
"play_count": 20000000000,
"digg_count": 500000000,
"digg_play_rate": 0.025,
"data_count": 800,
"put_day": 120,
"min_cpm": 12.0,
"max_cpm": 38.0,
"min_cpa": 45.0,
"max_cpa": 400.0,
"start_time": 1680000000,
"end_time": 1752000000
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 20,
"success": true,
"fail": false
}
接口信息
- 接口名称: Meta广告资料库数据统计分析
- 请求方法: POST
- 接口地址:
/open-api/v1/data
- 接口路径:
/v3/api/open/store/facebookLibraryPlatform/dataAnalysis
- 接口描述: 获取店铺在Meta广告资料库的数据分析
- 价格说明:
免费
请求头:
- Content-Type: application/json
- Accept: application/json
请求参数
请求结构
| 参数名 |
类型 |
描述 |
示例 |
必填 |
默认值 |
| key |
string |
用户申请的外部 api 请求 key |
"your_api_key_here" |
是 |
|
| uri |
string |
接口路径 |
"/v3/api/open/store/facebookLibraryPlatform/dataAnalysis" |
是 |
|
| params |
object |
接口入参对象 |
见参数列表 |
是 |
|
参数列表 (params 对象)
| 参数名 |
类型 |
必填 |
描述 |
| id |
String |
是 |
店铺唯一标识 ID |
| start_time |
Long |
否 |
开始时间,时间戳,单位秒 |
| end_time |
Long |
否 |
结束时间,时间戳,单位秒 |
请求示例
curl -X POST "https://www.pipispy.com/open-api/v1/data" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"key": "your_api_key_here",
"uri": "/v3/api/open/store/facebookLibraryPlatform/dataAnalysis",
"params": {
"id": "store_123456",
"start_time": 1675830644,
"end_time": 1752202412
}
}'
响应参数
响应体结构
{
"code": 200,
"message": "success",
"data": {},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 0,
"success": true,
"fail": false
}
数据字段说明
| 字段名 |
类型 |
描述 |
| data_count |
Long |
Meta广告资料库广告数 |
| adset_count |
Long |
Meta广告资料库广告组数 |
| audience_reach |
Long |
覆盖人数(仅EU & UK数据) |
| play_count |
Long |
广告播放量(仅EU & UK数据) |
| min_cpm |
BigDecimal |
最小广告花费(美元,仅EU & UK数据) |
| max_cpm |
BigDecimal |
最大广告花费(美元,仅EU & UK数据) |
| put_day |
Long |
投放天数 |
| start_time |
Long |
广告开始时间(时间戳,秒) |
| end_time |
Long |
广告结束时间(时间戳,秒) |
响应示例
{
"code": 200,
"message": "success",
"data": {
"data_count": 700,
"adset_count": 150,
"audience_reach": 15000000,
"play_count": 6792774635,
"min_cpm": 15.5,
"max_cpm": 49.8,
"put_day": 90,
"start_time": 1685000000,
"end_time": 1752202412
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 0,
"success": true,
"fail": false
}
错误码说明
| 错误码 |
描述 |
| 200 |
成功 |
| 400 |
请求参数错误,如缺少店铺 ID |
| 404 |
店铺不存在 |
| 500 |
服务器内部错误 |