数据消耗规则:1. 获取一条数据结果消耗1 数据,获取数据结果的更多数据详情不消耗数据。2. 广告监控: 每次监控 $1 / 月。单个监控有效期为一个月,一个月后自动停止。删除监控不会恢复监控次数,请谨慎删除。监控调用为随时且无限次。
店铺/广告主取消监监控接口
接口信息
- 接口名称: 店铺/广告主取消监监控接口
- 请求方法: POST
- 接口地址:
open-api/v1/monitor/data
- 接口路径:
/v3/api/ad-monitor-task/cancel
- 接口描述:
- 取消指定的广告监控任务
- 通过任务ID(task_id)来取消广告监控任务
- 价格说明:
免费
- 重要说明: <span style="color:red; font-weight:bold;">取消监控任务后,已消耗的积分不会退还</span>
请求头:
- Content-Type: application/json
- Accept: application/json
请求参数
请求结构
| 参数名 |
类型 |
描述 |
示例 |
必填 |
默认值 |
| key |
string |
用户申请的外部 api 请求 key |
"your_api_key_here" |
是 |
|
| uri |
string |
接口路径 |
"/v3/api/ad-monitor-task/cancel" |
是 |
|
| params |
object |
接口入参对象 |
见参数列表 |
是 |
|
请求体参数 (params 对象)
| 参数名 |
类型 |
必填 |
描述 |
| task_id |
string |
true |
任务id |
请求示例
curl -X POST "https://www.pipispy.com/open-api/v1/monitor/data" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"key": "your_api_key_here",
"uri": "/v3/api/ad-monitor-task/cancel",
"params": {
"task_id": "68f98898850c5345a4c87e66"
}
}'
响应参数
响应体结构
{
"code": 200,
"message": "success",
"data": {
"data": true
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 0,
"fail": false,
"success": true
}
响应字段说明
| 字段名 |
类型 |
描述 |
| code |
Integer |
响应状态码,200 表示成功 |
| message |
String |
响应消息 |
| data |
Object |
响应数据 |
| version |
String |
API 版本 |
| timestamp |
String |
响应时间戳 |
| sign |
String |
响应签名 |
| remaining_credits |
Long |
当前请求后的剩余可用积分 |
| consumed_credits |
Long |
本次请求消耗的积分 |
| success |
Boolean |
请求是否成功 |
| fail |
Boolean |
请求是否失败 |
响应结果信息字段
| 字段名 |
类型 |
描述 |
| data |
boolean |
true:取消成功,false:取消失败 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"data": true
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 0,
"fail": false,
"success": true
}
错误码说明
| 错误码 |
描述 |
| 200 |
成功 |
| 400 |
请求参数错误 |
| 500 |
服务器内部错误 |