Pipispy API中文

Data usage rules: 1. Obtaining a data result consumes 1 data. Obtaining more detailed information about a data result does not consume data. 2. Ad Tracker: Each monitoring session costs $1/month. Each monitoring session is valid for one month and automatically expires after one month. Deleting a monitoring session does not restore the monitoring session, so please delete with caution. Monitoring sessions can be accessed at any time and are unlimited.

Monitor Task Overview

API Information

  • API Name: Monitor Task Overview
  • Request Method: POST
  • API URL: open-api/v1/monitor/data
  • Endpoint Path: /v3/api/ad-monitor-task/board
  • Description:
    • Get aggregated statistics for all user monitor tasks
    • Provide data overview from dimensions of ads, landing pages, products, etc.
    • Usage Note: Free

Request Headers:

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

Request Parameters

Request Structure

Parameter Type Description Example Required Default
key string User's external API request key "your_api_key_here" Yes
uri string Endpoint path "/v3/api/ad-monitor-task/board" Yes
params object Request parameters object See parameter list Yes

Request Example

curl -X POST "https://www.pipispy.com/open-api/v1/monitor/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/ad-monitor-task/board",
    "params": {}
  }'

Response Parameters

Response Structure

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

Response Field Description

Field Name Type Description
code Integer Response status code, 200 means success
message String Response message
data Object Response data
version String API version
timestamp String Response timestamp
sign String Response signature
remaining_credits Long Current remaining available credits after this request
consumed_credits Long Credits consumed by this request
success Boolean Request success status
fail Boolean Request failure status

Response Data Information Fields

Field Name Type Description
ad_total_count integer Total ad count
ad_total_active_count integer Total active ad count
ad_today_count integer Today's new ad count
ad_yesterday_count integer Yesterday's new ad count
ad_seven_day_count integer New ad count in last 7 days
landing_page_total_count integer Total landing page count
landing_page_today_count integer Today's new landing page count
landing_page_yesterday_count integer Yesterday's new landing page count
landing_page_seven_day_count integer New landing page count in last 7 days
product_total_count integer Total product count
product_today_count integer Today's new product count
product_yesterday_count integer Yesterday's new product count
product_seven_day_count integer New product count in last 7 days

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "ad_total_count": 33509,
    "ad_total_active_count": 24174,
    "ad_today_count": 0,
    "ad_yesterday_count": 0,
    "ad_seven_day_count": 0,
    "landing_page_total_count": 5637,
    "landing_page_today_count": 0,
    "landing_page_yesterday_count": 0,
    "landing_page_seven_day_count": 0,
    "product_total_count": 0,
    "product_today_count": 0,
    "product_yesterday_count": 0,
    "product_seven_day_count": 0
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

Error Codes

Error Code Description
200 Success
400 Invalid request parameters
500 Internal server error