接口参考
监控任务的投放分析 API
POST
/open-api/v1/ad-monitor-task/ad-deep-analysis免费·api.ppspy.com数据与监控消耗规则
数据消耗规则:1. 获取一条shopify数据结果消耗 1 数据 或者 获取一条广告库数据结果消耗 2 数据,获取数据结果的更多数据详情不消耗数据。 2. 广告监控 & 销量监控,每次监控 $1 / 月。单个监控有效期为一个月,一个月后自动停止。删除监控不会恢复监控次数,请谨慎删除。监控调用为随时且无限次。
请求头
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/json请求示例
cURL
curl --location --request POST 'https://api.ppspy.com/open-api/v1/ad-monitor-task/ad-deep-analysis' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
"task_id": "902175d02614903e4944dfdfe85bbb4d",
"dimension": 1
}' 请求参数
按参数标注的位置传入请求。
| 参数 | 类型 | 说明 |
|---|---|---|
| body
body · 可选
| object | | none |
| » task_id
body · 必填
| string | 监控任务ID | none |
| » dimension
body · 可选
| integer | 分析维度 | 可选值:1-按天,2-按时段。 |
返回示例
返回示例 · JSON
{
"code": 200,
"message": "success",
"data": {
"dimension": 1,
"time1": "0609",
"time1_ad_count": 51224,
"time1_proportion": 100,
"time2": "0912",
"time2_ad_count": 0,
"time2_proportion": 0,
"time3": "1215",
"time3_ad_count": 0,
"time3_proportion": 0,
"time4": "1518",
"time4_ad_count": 0,
"time4_proportion": 0,
"time5": "1821",
"time5_ad_count": 0,
"time5_proportion": 0,
"time6": "2123",
"time6_ad_count": 0,
"time6_proportion": 0,
"time7": "2306",
"time7_ad_count": 0,
"time7_proportion": 0
},
"credits": {
"remaining_credits": 745,
"consumed_credits": 0,
"total_credits": 745
}
}
文档中的示例数据
{
"code": 200,
"message": "success",
"data": {
"dimension": 2,
"time1": "Monday",
"time1_ad_count": 4535,
"time1_proportion": 8.85,
"time2": "Tuesday",
"time2_ad_count": 5875,
"time2_proportion": 11.47,
"time3": "Wednesday",
"time3_ad_count": 9512,
"time3_proportion": 18.57,
"time4": "Thursday",
"time4_ad_count": 10990,
"time4_proportion": 21.45,
"time5": "Friday",
"time5_ad_count": 9778,
"time5_proportion": 19.09,
"time6": "Saturday",
"time6_ad_count": 6334,
"time6_proportion": 12.37,
"time7": "Sunday",
"time7_ad_count": 4200,
"time7_proportion": 8.2
},
"credits": {
"remaining_credits": 745,
"consumed_credits": 0,
"total_credits": 745
}
}
返回数据结构
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » code | integer | true | none | 业务状态码 | none |
| » message | string | true | none | 响应的消息 | none |
| » data | object | true | none | 响应的数据 | none |
| »» dimension | integer | false | none | 分析维度 | 可选值:1-按天,2-按时段。 |
| »» time1 | string | false | none | 周一/6-9小时 | none |
| »» time1_ad_count | integer | false | none | 广告总数 | none |
| »» time1_proportion | integer | false | none | 广告占比(百分比) | none |
| »» time2 | string | false | none | 周二/9-12小时 | none |
| »» time2_ad_count | integer | false | none | 广告总数 | none |
| »» time2_proportion | integer | false | none | 广告占比(百分比) | none |
| »» time3 | string | false | none | 周三/12-15小时 | none |
| »» time3_ad_count | integer | false | none | 广告总数 | none |
| »» time3_proportion | integer | false | none | 广告占比(百分比) | none |
| »» time4 | string | false | none | 周四/15-18小时 | none |
| »» time4_ad_count | integer | false | none | 广告总数 | none |
| »» time4_proportion | integer | false | none | 广告占比(百分比) | none |
| »» time5 | string | false | none | 周五/18-21小时 | none |
| »» time5_ad_count | integer | false | none | 广告总数 | none |
| »» time5_proportion | integer | false | none | 广告占比(百分比) | none |
| »» time6 | string | false | none | 周六/21-23小时 | none |
| »» time6_ad_count | integer | false | none | 广告总数 | none |
| »» time6_proportion | integer | false | none | 广告占比(百分比) | none |
| »» time7 | string | false | none | 周日/23-6小时 | none |
| »» time7_ad_count | integer | false | none | 广告总数 | none |
| »» time7_proportion | integer | false | none | 广告占比(百分比) | none |
| » credits | object | true | none | Credits 信息 | 当前 API 请求对应的 credits 信息 |
| »» remaining_credits | integer | true | none | 剩余 credits | 本次请求后剩余的 credits 数量 |
| »» consumed_credits | integer | true | none | 消耗 credits | 本次请求消耗的 credits 数量 |
| »» total_credits | integer | true | none | 总 credits | 当前 credits 类型的总数量 |
