Pipispy API中文

Monitor Task Active Ad Products Statistic

API Information

  • API Name: Monitor Task Active Ad Products Statistic
  • Request Method: POST
  • API URL: open-api/v1/monitor/data
  • Endpoint Path: /v3/api/ad-monitor-task/ad-products-statistics
  • Description:
    • Product Delivery Analysis - Get Active Ad Products Statistics
    • 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/ad-products-statistics"
Yes
params
object
Request parameters object
See parameter list
Yes

Request Body Parameters (params object)

Parameter Type Required Description
task_id
String
true
Task ID
date_start
integer
false
Start date (timestamp in seconds)
date_end
integer
false
End date (timestamp in seconds)

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/ad-products-statistics",
    "params": {
      "task_id": "68f98898850c5345a4c87e66",
      "date_start": 1760716800,
      "date_end": 1761321599
    }
  }'

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
data
array [object]
Data
data[].date
integer
Date
data[].ad_product_total_count
integer
Total ad product count
data[].ad_product_active_count
integer
Active ad product count

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      {
        "date": "1761177600",
        "ad_product_active_count": 5,
        "ad_product_total_count": 5
      },
      {
        "date": "1761091200",
        "ad_product_active_count": 5,
        "ad_product_total_count": 5
      },
      {
        "date": "1761004800",
        "ad_product_active_count": 5,
        "ad_product_total_count": 5
      },
      {
        "date": "1760918400",
        "ad_product_active_count": 5,
        "ad_product_total_count": 5
      },
      {
        "date": "1760832000",
        "ad_product_active_count": 5,
        "ad_product_total_count": 5
      },
      {
        "date": "1760745600",
        "ad_product_active_count": 5,
        "ad_product_total_count": 5
      }
    ]
  },
  "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