Ad Store Data Analysis API Endpoint

1. All Platform Data Statistical Analysis

API Endpoint Information

• API Endpoint Name: Store Detail All Platform Data Statistical Analysis
• Request Method: POST
• API Endpoint Address: /open-api/v1/data
• API Endpoint Path: /v3/api/open/store/allPlatform/dataAnalysis
• API Endpoint Description: Get aggregated data analysis for a store across all platforms (TikTok, Facebook, Meta Ad Library)
• Pricing: Free

Request Headers:

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

Request Parameters

Request Structure

Standard Response Fields

Parameter List (params object)

Request Example

curl -X POST "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/allPlatform/dataAnalysis",
    "params": {
      "id": "store_123456",
      "start_time": 1675830644,
      "end_time": 1752202412
    }
  }'

Response Parameters

Response Body Structure

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

Data Field Descriptions

All Platform Aggregated Data

Daily Like Increment Analysis (digg_inc_analytic)

Daily Ad Increment Analysis (adIncAnalytics)

Platform Data Analysis (tiktokAnalytic / facebookAnalytic / facebookLibraryAnalytic)

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "all_play_count": 76792774635,
    "all_digg_count": 1500000000,
    "all_digg_play_rate": 0.0215,
    "all_data_count": 2500,
    "all_min_cpm": 45.5,
    "all_max_cpm": 130.3,
    "all_put_days": 360,
    "all_start_time": 1675830644,
    "all_end_time": 1752202412,
    "digg_inc_analytic": [
      {
        "statistics_time": 1752115200,
        "tiktokDiggIncCount": 1200000,
        "facebookDiggIncCount": 800000
      }
    ],
    "adIncAnalytics": [
      {
        "statistics_time": 1752115200,
        "tiktok_inc_data_count": 50,
        "facebook_inc_data_count": 30,
        "facebookLibraryIncDataCount": 20
      }
    ],
    "tiktokAnalytic": {
      "play_count": 50000000000,
      "digg_count": 1000000000,
      "digg_play_rate": 0.02,
      "data_count": 1000,
      "put_day": 150,
      "min_cpm": 18.0,
      "max_cpm": 42.5,
      "start_time": 1675830644,
      "end_time": 1752202412
    },
    "facebookAnalytic": {
      "play_count": 20000000000,
      "digg_count": 500000000,
      "digg_play_rate": 0.025,
      "data_count": 800,
      "put_day": 120,
      "min_cpm": 12.0,
      "max_cpm": 38.0,
      "start_time": 1680000000,
      "end_time": 1752000000
    },
    "facebookLibraryAnalytic": {
      "play_count": 6792774635,
      "digg_count": null,
      "digg_play_rate": null,
      "data_count": 700,
      "put_day": 90,
      "min_cpm": 15.5,
      "max_cpm": 49.8,
      "start_time": 1685000000,
      "end_time": 1752202412
    }
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

2. TikTok Platform Data Statistical Analysis

API Endpoint Information

• API Endpoint Name: TikTok Platform Data Statistical Analysis
• Request Method: POST
• API Endpoint Address: /open-api/v1/data
• API Endpoint Path: /v3/api/open/store/tiktokPlatform/dataAnalysis
• API Endpoint Description: Get ad data analysis for a store on the TikTok platform
• Pricing: Free

Request Headers:

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

Request Parameters

Request Structure

Parameter List (params object)

Request Example

curl -X POST "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/tiktokPlatform/dataAnalysis",
    "params": {
      "id": "store_123456",
      "start_time": 1675830644,
      "end_time": 1752202412
    }
  }'

Response Parameters

Response Body Structure

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

Data Field Descriptions

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "play_count": 50000000000,
    "digg_count": 1000000000,
    "digg_play_rate": 0.02,
    "data_count": 1000,
    "put_day": 150,
    "min_cpm": 18.0,
    "max_cpm": 42.5,
    "min_cpa": 60.0,
    "max_cpa": 450.0,
    "start_time": 1675830644,
    "end_time": 1752202412
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

3. Facebook Platform Data Statistical Analysis

API Endpoint Information

• API Endpoint Name: Facebook Platform Data Statistical Analysis

• Request Method: POST

• API Endpoint Address: /open-api/v1/data

• API Endpoint Path: /v3/api/open/store/facebookPlatform/dataAnalysis

• API Endpoint Description: Get ad data analysis for a store on the Facebook platform

• Pricing: Free Request Headers:

• Content-Type: application/json

• Accept: application/json

Request Parameters

Request Structure

Parameter List (params object)

Request Example

curl -X POST "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/facebookPlatform/dataAnalysis",
    "params": {
      "id": "store_123456",
      "start_time": 1675830644,
      "end_time": 1752202412
    }
  }'

Response Parameters

Response Body Structure

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

Data Field Descriptions

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "play_count": 20000000000,
    "digg_count": 500000000,
    "digg_play_rate": 0.025,
    "data_count": 800,
    "put_day": 120,
    "min_cpm": 12.0,
    "max_cpm": 38.0,
    "min_cpa": 45.0,
    "max_cpa": 400.0,
    "start_time": 1680000000,
    "end_time": 1752000000
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

4. Meta Ad Library Data Statistical Analysis

API Endpoint Information

• API Endpoint Name: Meta Ad Library Data Statistical Analysis
• Request Method: POST
• API Endpoint Address: /open-api/v1/data
• API Endpoint Path: /v3/api/open/store/facebookLibraryPlatform/dataAnalysis
• API Endpoint Description: Get data analysis for a store in the Meta Ad Library
• Pricing: Free

Request Headers:

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

Request Parameters

Request Structure

Parameter List (params object)

Request Example

curl -X POST "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/facebookLibraryPlatform/dataAnalysis",
    "params": {
      "id": "store_123456",
      "start_time": 1675830644,
      "end_time": 1752202412
    }
  }'

Response Parameters

Response Body Structure

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

Data Field Descriptions

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "data_count": 700,
    "adset_count": 150,
    "audience_reach": 15000000,
    "play_count": 6792774635,
    "min_cpm": 15.5,
    "max_cpm": 49.8,
    "put_day": 90,
    "start_time": 1685000000,
    "end_time": 1752202412
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

Error Code Descriptions