店铺竞争分析接口文档

本文档包含两个关联接口，用于完整实现店铺竞争分析功能：

1. 产品选项列表接口 (/v3/api/open/store/detail/competition/products): 获取店铺下所有产品列表，用于筛选特定产品进行竞争分析
2. 竞争店铺列表接口 (/v3/api/open/store/detail/competition): 获取店铺的竞争对手列表

接口1: 获取店铺产品选项列表

接口信息

• 接口名称: 获取店铺产品选项列表（用于竞争分析筛选）
• 请求方法: GET
• 接口地址: /open-api/v1/data
• 接口路径: /v3/api/open/store/detail/competition/products
• 接口描述: 获取指定店铺下所有产品的ID和图片信息。此接口返回的产品ID（id字段）可作为竞争店铺列表接口的product_id参数，用于筛选基于特定产品的竞争分析。使用建议：在调用竞争店铺列表接口前，建议先调用此接口获取产品列表，让用户选择要分析的产品，或直接传递所有产品进行全面竞争分析。
• 价格说明: 免费

请求头:

• Content-Type: application/json
• Accept: application/json

请求参数

请求结构

请求体参数 (params 对象)

请求示例

curl -X GET "https://www.pipispy.com/open-api/v1/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/open/store/detail/competition/products",
    "params": {
        "id": "cac90b02df723"
    }
  }'

响应参数

响应体结构

{
  "code": 200,
  "message": "success",
  "data": {
    "data": []
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

响应字段说明

产品信息字段 (data.data[])

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      {
        "id": "62739afc38365b2f72048ebe",
        "icon": "https://cdn-product.pipiads.com/images/product_image_001.jpg"
      },
      {
        "id": "62739b0438365b2f72048ebf",
        "icon": "https://cdn-product.pipiads.com/images/product_image_002.jpg"
      },
      {
        "id": "62739b1238365b2f72048ec0",
        "icon": "https://cdn-product.pipiads.com/images/product_image_003.jpg"
      }
    ]
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

使用说明

1. 获取产品列表: 调用此接口获取店铺下所有产品的ID和图片
2. 用户选择产品: 在前端界面展示产品图片列表，让用户选择要分析的产品
3. 传递产品ID: 将选中的产品ID传递给竞争店铺列表接口的product_id参数
4. 全店铺分析: 如果想基于店铺所有产品进行竞争分析，可以不调用此接口，直接调用竞争店铺列表接口且不传product_id参数

错误码说明

接口2: 获取店铺竞争分析列表

接口信息

• 接口名称: 获取店铺竞争分析列表
• 请求方法: GET
• 接口地址: /open-api/v1/data
• 接口路径: /v3/api/open/store/detail/competition
• 接口描述: 根据店铺ID获取该店铺的竞争对手店铺列表。系统通过AI图像识别技术分析店铺销售的产品图片，找出销售相似产品的其他店铺，按照相似度评分（score）从高到低排序返回。支持分页查询和按指定产品筛选竞争店铺。
• 价格说明: 获取一条数据结果消耗1 credit

请求头:

• Content-Type: application/json
• Accept: application/json

请求参数

请求结构

请求体参数 (params 对象)

请求示例

# 示例1: 查询店铺的所有竞争对手（基于所有产品）
curl -X GET "https://www.pipispy.com/open-api/v1/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/open/store/detail/competition",
    "params": {
        "id": "cac90b02df723",
        "current_page": 1,
        "page_size": 20
    }
  }'

# 示例2: 查询店铺指定产品的竞争对手
curl -X GET "https://www.pipispy.com/open-api/v1/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/open/store/detail/competition",
    "params": {
        "id": "cac90b02df723",
        "product_id": "62739afc38365b2f72048ebe",
        "current_page": 1,
        "page_size": 50
    }
  }'

响应参数

响应体结构

{
  "code": 200,
  "message": "success",
  "data": {
    "data": [],
    "page": {}
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 20,
  "success": true,
  "fail": false
}

响应字段说明

竞争店铺信息字段 (data.data[])

基础信息字段

综合平台数据字段（all_前缀）

以下字段统计了该店铺在所有广告平台（TikTok + Facebook + Meta广告资料库）的汇总数据：

TikTok平台数据字段（tiktok_前缀）

以下字段仅统计该店铺在TikTok平台的广告数据：

Facebook平台数据字段（facebook_前缀）

以下字段仅统计该店铺在Facebook广告平台的数据：

Meta广告资料库数据字段（facebook_library_前缀）

以下字段仅统计该店铺在Meta广告资料库（Facebook Ad Library）的公开数据：

其他分类字段

广告素材展示字段

网站信息字段

广告素材信息对象 (good_source[])

网站信息对象 (website_info)

分页信息对象 (page)

响应示例

{
    "code": 200,
    "message": "success",
    "data": {
        "data": [
            {
                "id": "690b25aabf0efeab51093e0c",
                "icon": "https://cdn-video.pipiads.com/avatar_d1046d3f1fac466bdba8.jpg",
                "store_id": "2e93e5996be3a",
                "root_path": "femin.lol",
                "shop_type": "shopify",
                "plat_type": [
                    "tiktok"
                ],
                "good_source": [
                    {
                        "cover": "https://cdn-video.pipiads.com/cover_d1046d3f1fac466bdba8.jpg",
                        "app_image": "https://cdn-video.pipiads.com/avatar_d1046d3f1fac466bdba8.jpg",
                        "count": 94365,
                        "video_id": "d1046d3f1fac466bdba8",
                        "platform": 0
                    },
                    {
                        "cover": "https://cdn-video.pipiads.com/cover_a497f88964b28c573128.jpg",
                        "app_image": "https://cdn-video.pipiads.com/avatar_a497f88964b28c573128.jpg",
                        "count": 1721,
                        "video_id": "a497f88964b28c573128",
                        "platform": 0
                    },
                    {
                        "cover": "https://cdn-video.pipiads.com/cover_9cb2ffef3392a20a7fde.jpg",
                        "app_image": "https://cdn-video.pipiads.com/avatar_9cb2ffef3392a20a7fde.jpg",
                        "count": 20618,
                        "video_id": "9cb2ffef3392a20a7fde",
                        "platform": 0
                    }
                ],
                "is_collection": false,
                "popular_person_count": 2,
                "website_info": {
                    "website_icon": "https://cdn-video.pipiads.com/avatar_d1046d3f1fac466bdba8.jpg",
                    "website_title": "femin.lol"
                },
                "all_data_count": 6,
                "tiktok_data_count": 6,
                "facebook_data_count": 0,
                "all_page_count": 2,
                "all_play_count": 148119,
                "tiktok_play_count": 148119,
                "facebook_play_count": 0,
                "all_min_cpm": 212.8,
                "all_max_cpm": 852.7,
                "tiktok_min_cpm": 212.87,
                "tiktok_max_cpm": 852.74,
                "facebook_min_cpm": 0.0,
                "facebook_max_cpm": 0.0,
                "all_min_cpa": 9,
                "all_max_cpa": 94,
                "tiktok_min_cpa": 9,
                "tiktok_max_cpa": 94,
                "facebook_min_cpa": 0,
                "facebook_max_cpa": 0,
                "all_put_days": 1,
                "tiktok_put_days": 1,
                "facebook_put_days": 0,
                "all_found_time": 1699580469,
                "tiktok_found_time": 1699580469,
                "facebook_found_time": 0,
                "all_latest_found_time": 1719449698,
                "tiktok_latest_found_time": 1719449698,
                "facebook_latest_found_time": 0,
                "tiktok_store_ad_state": -1,
                "facebook_store_ad_state": -1,
                "facebook_library_store_ad_state": -1,
                "all_store_ad_state": -1
            }
        ],
        "page": {
            "total_count": 257,
            "current_page": 50,
            "page_count": 257,
            "page_size": 1
        }
    },
    "version": "v1",
    "timestamp": null,
    "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 20,
    "success": true,
    "fail": false
}

错误码说明