Store Competition Analysis API Documentation

This document contains two related API endpoints to fully implement the store competition analysis feature:

1. Product Options List API Endpoint (/v3/api/open/store/detail/competition/products): Get a list of all products under a store for filtering specific products for competition analysis
2. Competition Store List API Endpoint (/v3/api/open/store/detail/competition): Get a list of the store's competitors

API Endpoint 1: Get Store Product Options List

API Endpoint Information

• API Endpoint Name: Get Store Product Options List (for competition analysis filtering)
• Request Method: GET
• API Endpoint Address: /open-api/v1/data
• API Endpoint Path: /v3/api/open/store/detail/competition/products
• API Endpoint Description: Get the ID and image information of all products under the specified store. The product ID (id field) returned by this API endpoint can be used as the product_id parameter of the competition store list API endpoint to filter competition analysis based on specific products. Usage Suggestion: Before calling the competition store list API endpoint, it is recommended to first call this API endpoint to get the product list, let users choose the products to analyze, or directly pass all products for comprehensive competition analysis.
• Pricing: Free

Request Headers:

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

Request Parameters

Request Structure

Request Body Parameters (params object)

Request Example

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"
    }
  }'

Response Parameters

Response Body Structure

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

Response Field Descriptions

Product Information Fields (data.data[])

Response Example

{
  "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
}

Usage Instructions

1. Get Product List: Call this API endpoint to get the IDs and images of all products under the store
2. User Product Selection: Display the product image list in the frontend interface and let users select the products to analyze
3. Pass Product ID: Pass the selected product ID to the product_id parameter of the competition store list API endpoint
4. Full Store Analysis: If you want to perform competition analysis based on all products of the store, you can skip calling this API endpoint and directly call the competition store list API endpoint without passing the product_id parameter

Error Code Descriptions

API Endpoint 2: Get Store Competition Analysis List

API Endpoint Information

• API Endpoint Name: Get Store Competition Analysis List
• Request Method: GET
• API Endpoint Address: /open-api/v1/data
• API Endpoint Path: /v3/api/open/store/detail/competition
• API Endpoint Description: Get the list of competitor stores for a store based on store ID. The system uses AI image recognition technology to analyze product images sold by the store, find other stores selling similar products, and return them sorted by similarity score (score) from high to low. Supports pagination query and filtering competition stores by specified product.
• Pricing: Consuming 1 credit per data result retrieved

Request Headers:

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

Request Parameters

Request Structure

Request Body Parameters (params object)

Request Example

# Example 1: Query all competitors of a store (based on all products)
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
    }
  }'

# Example 2: Query competitors for a specific product of a store
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
    }
  }'

Response Parameters

Response Body Structure

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

Response Field Descriptions

Competition Store Information Fields (data.data[])

Basic Information Fields

Cross-Platform Data Fields (all_ prefix)

The following fields aggregate data from all advertising platforms (TikTok + Facebook + Meta Ad Library) for this store:

TikTok Platform Data Fields (tiktok_ prefix)

The following fields only aggregate ad data for this store on the TikTok platform:

Facebook Platform Data Fields (facebook_ prefix)

The following fields only aggregate data for this store on the Facebook advertising platform:

Meta Ad Library Data Fields (facebook_library_ prefix)

The following fields only aggregate public data for this store in the Meta Ad Library (Facebook Ad Library):

Other Classification Fields

Ad Creative Display Fields

Website Information Fields

Ad Creative Information Object (good_source[])

Website Information Object (website_info)

Pagination Information Object (page)

Response Example

{
    "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
}

Error Code Descriptions