接口参考
销量监控任务列表 API
GET
/open-api/v1/sales-monitor-task免费·api.ppspy.com数据与监控消耗规则
数据消耗规则:1. 获取一条shopify数据结果消耗 1 数据 或者 获取一条广告库数据结果消耗 2 数据,获取数据结果的更多数据详情不消耗数据。 2. 广告监控 & 销量监控,每次监控 $1 / 月。单个监控有效期为一个月,一个月后自动停止。删除监控不会恢复监控次数,请谨慎删除。监控调用为随时且无限次。
请求头
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/json请求示例
cURL
curl --location --request GET 'https://api.ppspy.com/open-api/v1/sales-monitor-task' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' 请求参数
按参数标注的位置传入请求。
| 参数 | 类型 | 说明 |
|---|---|---|
| keyword
query · 可选
| string | 搜索关键词 | |
| monitor_task_status
query · 可选
| integer | 监控状态,可选值:0-已停止,1-监控中。 | |
| note
query · 可选
| string | 备注 | |
| order_by
query · 可选
| string | 排序字段,可选值:monitor_task_created_at-监控任务创建时间,monitor_task_sales_today-今日销量,monitor_task_sales_yesterday-昨日销量,monitor_task_sales_7days-7日销量,monitor_task_sales-总销量,monitor_task_product_quantity-店铺商品数。 | |
| direction
query · 可选
| string | 排序方式,可选值:desc-降序,asc-升序。 | |
| page
query · 可选
| integer | 页码,最小值等于1。 | |
| per_page
query · 可选
| integer | 分页大小,取值范围1-100。 | |
| group_id
query · 可选
| string | 分组ID | |
返回示例
返回示例 · JSON
{
"code": 200,
"message": "success",
"data": {
"current_page": 1,
"data": [
{
"site_domain": "wheelsup.cz",
"site_name": "WheelsUp",
"site_icon": "https://wheelsup.cz/cdn/shop/files/apple-touch-icon.png?crop=center&height=96&v=1675197115&width=96",
"currency": "CZK",
"monitor_task_status": 1,
"note": null,
"monitor_task_income_today": 15319670.73,
"monitor_task_income_usd_today": 698163.9,
"monitor_task_sales_today": 1393,
"monitor_task_income_yesterday": 32750882.58,
"monitor_task_income_usd_yesterday": 1492557.13,
"monitor_task_sales_yesterday": 2978,
"monitor_task_income": 447661168.28,
"monitor_task_income_usd": 20163747.33,
"monitor_task_sales": 42291,
"monitor_task_created_at": 1747100358,
"monitor_task_product_quantity": 28041,
"group_id": "6b602563ca8e3aeb59dd23904332113a",
"monitor_task_income_7days": 191622814.92,
"monitor_task_income_usd_7days": 8684724.09,
"monitor_task_sales_7days": 17543,
"group": {
"id": "6b602563ca8e3aeb59dd23904332113a",
"name": "测试分组-1762422493"
}
}
],
"last_page": 1,
"per_page": 10,
"total": 1
},
"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 |
| »» current_page | integer | true | none | 当前页码 | none |
| »» data | [object] | true | none | 数据列表 | none |
| »»» site_domain | string | true | none | 店铺域名 | none |
| »»» site_name | string | true | none | 店铺名称 | none |
| »»» site_icon | string | true | none | 店铺图标 | none |
| »»» currency | string | true | none | 货币 | none |
| »»» monitor_task_status | integer | true | none | 监控任务状态 | 可选值:0-已停止,1-监控中。 |
| »»» note | string¦null | true | none | 备注 | none |
| »»» monitor_task_income_today | number¦null | true | none | 今日预估销售额 | none |
| »»» monitor_task_sales_today | integer¦null | true | none | 今日销量 | none |
| »»» monitor_task_income_yesterday | number¦null | true | none | 昨日预估销售额 | none |
| »»» monitor_task_sales_yesterday | integer¦null | true | none | 昨日销量 | none |
| »»» monitor_task_income | number¦null | true | none | 预估总销售额 | none |
| »»» monitor_task_sales | integer¦null | true | none | 总销量 | none |
| »»» monitor_task_created_at | integer | true | none | 监控任务创建时间 | none |
| »»» monitor_task_product_quantity | integer¦null | true | none | 店铺商品数 | none |
| »»» monitor_task_income_usd | number¦null | true | none | 预估总销售额(美元) | none |
| »»» monitor_task_income_usd_today | number¦null | true | none | 今日预估销售额(美元) | none |
| »»» monitor_task_income_usd_yesterday | number¦null | true | none | 昨日预估销售额(美元) | none |
| »»» group_id | string¦null | true | none | 分组ID | none |
| »»» group | object¦null | true | none | 分组信息 | none |
| »»»» id | string | true | none | 分组ID | none |
| »»»» name | string | true | none | 分组名称 | none |
| »»» monitor_task_income_7days | number¦null | true | none | 7日预估销售额 | none |
| »»» monitor_task_income_usd_7days | number¦null | true | none | 7日预估销售额(美元) | none |
| »»» monitor_task_sales_7days | integer¦null | true | none | 7日销量 | none |
| »» last_page | integer | true | none | 最后一页的页码 | none |
| »» per_page | integer | true | none | 分页大小 | none |
| »» total | integer | true | 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 类型的总数量 |
