接口参考
监控看板 API
GET
/v1/monitor/overview免费·api.etshop.ai/open-apiCredits 消耗规则
计费规则:店铺/商品列表与热销榜每返回 1 条扣 1 Credit,店铺详情每次扣 2 Credits;详情、趋势、每日数据、评论免费(需 3 天内在列表或详情中返回过)。关键词搜索每个词扣 1 Keyword Credit,30 天内同一个词免费。店铺监控每个店铺扣 1 Monitor Credit,监控 30 天,停止后不退还。空结果不扣费,服务器错误自动退还。
请求头
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/json请求示例
cURL
curl --location --request GET 'https://api.etshop.ai/open-api/v1/monitor/overview?start_time=1794268800&end_time=1794355199&group_id=3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' 请求参数
按参数标注的位置传入请求。
返回示例
返回示例 · JSON
{
"code": 200,
"message": "success",
"data": {
"sold_count": 163,
"product_count": 3,
"total_rating_count": 22,
"favorites_count": 280,
"sold_count_all": 1837,
"product_count_all": 25,
"total_rating_count_all": 233,
"favorites_count_all": 3175
},
"credits": {
"type": "monitor_credits",
"remaining_credits": 98,
"consumed_credits": 0,
"total_credits": 100
}
}
文档中的示例数据
返回数据结构
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | true | none | 业务状态码 |
| » message | string | true | none | 响应消息 |
| » data | object | true | none | 响应数据 |
| »» sold_count | integer | true | none | 统计时间范围内的销量增长合计 |
| »» product_count | integer | true | none | 统计时间范围内的商品数增长合计 |
| »» total_rating_count | integer | true | none | 统计时间范围内的评论数增长合计 |
| »» favorites_count | integer | true | none | 统计时间范围内的收藏数增长合计 |
| »» sold_count_all | integer | true | none | 开始监控以来的销量增长合计 |
| »» product_count_all | integer | true | none | 开始监控以来的商品数增长合计 |
| »» total_rating_count_all | integer | true | none | 开始监控以来的评论数增长合计 |
| »» favorites_count_all | integer | true | none | 开始监控以来的收藏数增长合计 |
| » credits | object | true | none | 本次请求的 Credits 信息,见计费规则 |
| »» type | string | true | none | Credits 类型,本接口为 monitor_credits |
| »» remaining_credits | integer | true | none | 本次请求后剩余的 Monitor Credits |
| »» consumed_credits | integer | true | none | 本次请求消耗的 Monitor Credits,本接口为 0 |
| »» total_credits | integer | true | none | Monitor Credits 总数量 |
