接口参考
监控列表 API
GET
/v1/monitor/list免费·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/list?group_id=3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95&page=1&per_page=10&order_by=sold_count_7&direction=desc' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' 请求参数
按参数标注的位置传入请求。
| 参数 | 类型 | 说明 |
|---|---|---|
| shop_name
query · 可选
| string | 店铺名称或店铺链接,模糊匹配 |
| group_id
query · 可选
| string | 分组 ID(32 位字符串),见分组列表;不传返回全部;分组不存在时返回 400 |
| page
query · 可选
| integer | 页码,最小 1,默认 1 |
| per_page
query · 可选
| integer | 每页条数,范围 1-100,默认 10 |
| order_by
query · 可选
| string | 排序字段:sold_count、sold_count_1、sold_count_7、sold_count_total、product_count、product_count_1、product_count_7、product_count_total、favorites_count、favorites_count_1、favorites_count_7、favorites_count_total、total_rating_count、total_rating_count_1、total_rating_count_7、total_rating_count_total;默认 sold_count |
| direction
query · 可选
| string | 排序方向:desc 降序(默认)、asc 升序 |
返回示例
返回示例 · JSON
{
"code": 200,
"message": "success",
"data": {
"current_page": 1,
"data": [
{
"id": 1024,
"shop_id": 27403561,
"name": "PrintPalaceStudio",
"image": "https://i.etsystatic.com/isla/8c1f2a/58213947/isla_500x500.58213947_d3k9xw1p.jpg",
"url": "https://www.etsy.com/shop/PrintPalaceStudio",
"headline": "Printable wall art & modern digital prints",
"country_code": "US",
"currency_code": "USD",
"additional_customization": 1,
"is_open": 1,
"have_sold_page": 1,
"group_id": "3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95",
"sold_count": 37,
"sold_count_1": 142,
"sold_count_7": 968,
"sold_count_total": 1385,
"product_count": 0,
"product_count_1": 3,
"product_count_7": 11,
"product_count_total": 16,
"total_rating_count": 4,
"total_rating_count_1": 19,
"total_rating_count_7": 121,
"total_rating_count_total": 176,
"favorites_count": 58,
"favorites_count_1": 233,
"favorites_count_7": 1504,
"favorites_count_total": 2187,
"ended_at": 1796113800
},
{
"id": 1025,
"shop_id": 19832746,
"name": "NordicCanvasCo",
"image": "https://i.etsystatic.com/isla/2b7d90/41728365/isla_500x500.41728365_m7q2fz8c.jpg",
"url": "https://www.etsy.com/shop/NordicCanvasCo",
"headline": "Framed canvas prints inspired by Scandinavian landscapes",
"country_code": "GB",
"currency_code": "GBP",
"additional_customization": 0,
"is_open": 1,
"have_sold_page": 0,
"group_id": "3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95",
"sold_count": 6,
"sold_count_1": 21,
"sold_count_7": 147,
"sold_count_total": 452,
"product_count": 1,
"product_count_1": 0,
"product_count_7": 4,
"product_count_total": 9,
"total_rating_count": 1,
"total_rating_count_1": 3,
"total_rating_count_7": 18,
"total_rating_count_total": 57,
"favorites_count": 12,
"favorites_count_1": 47,
"favorites_count_7": 309,
"favorites_count_total": 988,
"ended_at": 1795050000
}
],
"first_page_url": "https://api.etshop.ai/open-api/v1/monitor/list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://api.etshop.ai/open-api/v1/monitor/list?page=1",
"next_page_url": null,
"path": "https://api.etshop.ai/open-api/v1/monitor/list",
"per_page": 10,
"prev_page_url": null,
"to": 2,
"total": 2
},
"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 | 响应数据 |
| »» current_page | integer | true | none | 当前页码 |
| »» data | [object] | true | none | 监控列表 |
| »»» id | integer | true | none | 监控 ID,用于停止监控、移动监控到分组等接口 |
| »»» shop_id | integer | true | none | 店铺 ID |
| »»» name | string | true | none | 店铺名称,可用于监控详情等接口的 shop_name 参数 |
| »»» image | string | true | none | 店铺图标 |
| »»» url | string | true | none | 店铺链接 |
| »»» headline | string | true | none | 店铺简介 |
| »»» country_code | string | true | none | 店铺所在国家/地区代码 |
| »»» currency_code | string | true | none | 店铺币种 |
| »»» additional_customization | integer | true | none | 是否支持个性化定制:1 是,0 否 |
| »»» is_open | integer | true | none | 店铺是否营业:1 营业中,0 已关闭 |
| »»» have_sold_page | integer | true | none | 店铺是否公开销售记录页:1 是(可统计商品真实销量),0 否 |
| »»» group_id | string¦null | true | none | 所属分组 ID;未分组时为 null |
| »»» sold_count | integer | true | none | 今天的销量增长 |
| »»» sold_count_1 | integer | true | none | 昨天的销量增长 |
| »»» sold_count_7 | integer | true | none | 近 7 天(含今天)的销量增长 |
| »»» sold_count_total | integer | true | none | 开始监控以来的销量增长 |
| »»» product_count | integer | true | none | 今天的商品数增长 |
| »»» product_count_1 | integer | true | none | 昨天的商品数增长 |
| »»» product_count_7 | integer | true | none | 近 7 天的商品数增长 |
| »»» product_count_total | integer | true | none | 开始监控以来的商品数增长 |
| »»» total_rating_count | integer | true | none | 今天的评论数增长 |
| »»» total_rating_count_1 | integer | true | none | 昨天的评论数增长 |
| »»» total_rating_count_7 | integer | true | none | 近 7 天的评论数增长 |
| »»» total_rating_count_total | integer | true | none | 开始监控以来的评论数增长 |
| »»» favorites_count | integer | true | none | 今天的收藏数增长 |
| »»» favorites_count_1 | integer | true | none | 昨天的收藏数增长 |
| »»» favorites_count_7 | integer | true | none | 近 7 天的收藏数增长 |
| »»» favorites_count_total | integer | true | none | 开始监控以来的收藏数增长 |
| »»» ended_at | integer | true | none | 监控到期时间(Unix 时间戳,秒),到期后自动停止 |
| »» first_page_url | string | true | none | 第一页链接 |
| »» from | integer¦null | true | none | 当前页第一条的序号 |
| »» last_page | integer | true | none | 最后一页页码 |
| »» last_page_url | string | true | none | 最后一页链接 |
| »» next_page_url | string¦null | true | none | 下一页链接 |
| »» path | string | true | none | 接口地址 |
| »» per_page | integer | true | none | 每页条数 |
| »» prev_page_url | string¦null | true | none | 上一页链接 |
| »» to | integer¦null | true | none | 当前页最后一条的序号 |
| »» total | 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 总数量 |
