接口参考

创建销量监控任务 API

POST/open-api/v1/sales-monitor-task

每成功创建一个监控任务，消耗1次监控额度·api.ppspy.com

数据与监控消耗规则

数据消耗规则：1. 获取一条shopify数据结果消耗 1 数据或者获取一条广告库数据结果消耗 2 数据，获取数据结果的更多数据详情不消耗数据。 2. 广告监控 & 销量监控，每次监控 $1 / 月。单个监控有效期为一个月，一个月后自动停止。删除监控不会恢复监控次数，请谨慎删除。监控调用为随时且无限次。

请求头

AUTHORIZATIONAuthorization: {API Key}

CONTENT-TYPEapplication/json

ACCEPTapplication/json

请求示例

cURL

curl --location --request POST 'https://api.ppspy.com/open-api/v1/sales-monitor-task' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
    "urls": [
        "https://www.google.com/",
        "wheelsup.cz"
    ],
    "with_fake_sales": true,
    "group_id": "6b602563ca8e3aeb59dd23904332113a"
}'

请求参数 4 项

按参数标注的位置传入请求。

参数	类型	说明
body body · 可选	object	\| none
» urls body · 必填	[string]	\| 需要监控的店铺链接或域名，支持批量提交，单次最多50个
» with_fake_sales body · 可选	boolean	是否监控虚假销量的店铺 \| 默认不监控虚假销量的店铺。如果需要监控，请设置为true。
» group_id body · 可选	integer¦null	分组ID \| none

返回示例

返回示例 · JSON

{
    "code": 200,
    "message": "success",
    "data": {
        "total": 2,
        "added_count": 1,
        "removed_count": 1,
        "details": [
            {
                "url": "https://www.google.com/",
                "domain": "www.google.com",
                "code": 400009,
                "message": "This site is not a shopify site, you can only submit shopify sites."
            },
            {
                "url": "wheelsup.cz",
                "domain": "wheelsup.cz",
                "code": 200,
                "message": "success"
            }
        ]
    },
    "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
»» total	integer	true	none		提交的店铺链接总数
»» added_count	integer	true	none		成功添加的店铺数量
»» removed_count	integer	true	none		添加失败的店铺数量
»» details	[object]	true	none		每个店铺的添加结果详情
»»» url	string(uri)	true	none		提交的店铺链接
»»» domain	string	true	none		店铺的域名
»»» code	integer	true	none		添加结果状态码：200表示添加成功，其他数值表示添加失败
»»» message	string	true	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 类型的总数量

原始接口信息与服务地址

Base URLs

生产环境: https://api.ppspy.com

接口信息

接口名称: 创建销量监控任务
请求方法: POST
接口地址: /open-api/v1/sales-monitor-task
价格说明: 每成功创建一个监控任务，消耗1次监控额度