监控中任务的概况
接口信息
- 接口名称: 监控中任务的概况
- 请求方法: POST
- 接口地址:
open-api/v1/monitor/data
- 接口路径:
/v3/api/ad-monitor-task/board
- 接口描述:
- 获取用户所有监控任务的汇总统计信息
- 提供广告、落地页、产品等维度的数据概览
- 价格说明:
免费
请求头:
- Content-Type: application/json
- Accept: application/json
请求参数
请求结构
| 参数名 |
类型 |
描述 |
示例 |
必填 |
默认值 |
| key |
string |
用户申请的外部 api 请求 key |
"your_api_key_here" |
是 |
|
| uri |
string |
接口路径 |
"/v3/api/ad-monitor-task/board" |
是 |
|
| params |
object |
接口入参对象 |
见参数列表 |
是 |
|
请求示例
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/board",
"params": {}
}'
响应参数
响应体结构
{
"code": 200,
"message": "success",
"data": {},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 0,
"success": true,
"fail": false
}
响应字段说明
| 字段名 |
类型 |
描述 |
| code |
Integer |
响应状态码,200 表示成功 |
| message |
String |
响应消息 |
| data |
Object |
响应数据 |
| version |
String |
API 版本 |
| timestamp |
String |
响应时间戳 |
| sign |
String |
响应签名 |
| remaining_credits |
Long |
当前请求后的剩余可用积分 |
| consumed_credits |
Long |
本次请求消耗的积分 |
| success |
Boolean |
请求是否成功 |
| fail |
Boolean |
请求是否失败 |
响应结果信息字段
| 字段名 |
类型 |
描述 |
| ad_total_count |
integer |
总广告数 |
| ad_total_active_count |
integer |
总活跃广告数 |
| ad_today_count |
integer |
今日新增广告数 |
| ad_yesterday_count |
integer |
昨日新增广告数 |
| ad_seven_day_count |
integer |
近7日新增广告数 |
| landing_page_total_count |
integer |
落地页总数 |
| landing_page_today_count |
integer |
落地页今日新增数 |
| landing_page_yesterday_count |
integer |
落地页昨日新增数 |
| landing_page_seven_day_count |
integer |
落地页近7日新增数 |
| product_total_count |
integer |
总产品数 |
| product_today_count |
integer |
产品今日新增数 |
| product_yesterday_count |
integer |
产品昨日新增数 |
| product_seven_day_count |
integer |
产品近7日新增数 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"ad_total_count": 33509,
"ad_total_active_count": 24174,
"ad_today_count": 0,
"ad_yesterday_count": 0,
"ad_seven_day_count": 0,
"landing_page_total_count": 5637,
"landing_page_today_count": 0,
"landing_page_yesterday_count": 0,
"landing_page_seven_day_count": 0,
"product_total_count": 0,
"product_today_count": 0,
"product_yesterday_count": 0,
"product_seven_day_count": 0
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 0,
"success": true,
"fail": false
}
错误码说明
| 错误码 |
描述 |
| 200 |
成功 |
| 400 |
请求参数错误 |
| 500 |
服务器内部错误 |