Pipispy API中文

Get Monitor Task Details

API Information

  • API Name: Get Monitor Task Details
  • Request Method: POST
  • API URL: open-api/v1/monitor/data
  • Endpoint Path: /v3/api/ad-monitor-task/monitor-task-details
  • Description:
    • Get complete details information of monitor task by task ID
    • Return task detailed monitoring data and 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/monitor-task-details"
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

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/monitor-task-details",
    "params": {
      "task_id": "68fa2e36789edb5700215e03"
    }
  }'

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
task_id
string
Monitor task ID
monitor_task_type
integer
Monitor task type, 1:Facebook advertiser, 2:Store/Website
facebook_page_id
string
FB advertiser ID
facebook_page_url
string
FB advertiser URL
facebook_shop_url
string
FB store URL
facebook_shop_search_url
string
FB store search URL
name
string
Monitor object name
avatar_url
string
Monitor object avatar
category
string
Advertiser category displayed on FB ad library, not available for store/website
country
string
Advertiser country (some have), store country
ad_total_count
integer
Total ad count
ad_total_active_count
integer
Total active count
ad_today_count
integer
Today's new ad count
ad_yesterday_count
integer
Yesterday's new ad count
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
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
latest_ad_data
array [object]
Latest ad data
latest_ad_data[].id
string
Ad ID
latest_ad_data[].cover_url
string
Cover
latest_ad_data[].ad_started_at
integer
Publish time timestamp, unit: seconds
latest_ad_data[].video_url
string
Ad video URL
latest_ad_data[].duration
integer
Ad duration, unit: seconds
latest_ad_data[].type
integer
Ad type
monitored_days
integer
Monitored days
started_at
integer
Monitor start time, timestamp, unit: seconds
stoped_at
integer
Monitor stop time, timestamp, unit: seconds
status
integer
Monitor status 1: Monitoring, 2: Cancelled
monitor_expire_time
integer
Monitor expiration time, timestamp, unit: seconds
updated_at
integer
Update time, timestamp, unit: seconds
ad_seven_day_count
integer
New ad count in last 7 days
landing_page_seven_day_count
integer
New landing page count in last 7 days
product_seven_day_count
integer
New product count in last 7 days
videos_ad_total_count
integer
Total video ad count
cards_ad_total_count
integer
Total card ad count
images_ad_total_count
integer
Total image ad count

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "country": "NL",
    "latest_ad_data": [
      {
        "duration": 13,
        "cover_url": "https://cdn.pipidata.com/images/439074ded5f202adb25735dd6fe314746e915da78ad5943c74f654b371c3805e.png",
        "video_url": "https://cdn.pipidata.com/videos/817e5577729a49b4209146b7d861c34666614027da845e7a8a506531b7174572.mp4",
        "id": "1502412787841300",
        "ad_started_at": 1758092400,
        "type": 1
      },
      {
        "duration": 15,
        "cover_url": "https://cdn.pipidata.com/images/628ccca0f5a5c970ba0d10e883f7056d0e3c4127e228a90ba9757a8a178d2de4.png",
        "video_url": "https://cdn.pipidata.com/videos/e40e5c23b76ebf4032fb62ca94e427ceba056d4d53d2b57366555daec8ae40ef.mp4",
        "id": "1113997597539089",
        "ad_started_at": 1758092400,
        "type": 1
      },
      {
        "duration": 15,
        "cover_url": "https://cdn.pipidata.com/images/257cdc076722895d58a40ba8ab31038e7033956180ad6ceb21a86bcd9b62358b.png",
        "video_url": "https://cdn.pipidata.com/videos/26b6953b738b4d1698495c3ec6a7cf7bcb1040f4aeeecbcf59909e06a82bbbba.mp4",
        "id": "1958643064678656",
        "ad_started_at": 1758092400,
        "type": 1
      },
      {
        "duration": 15,
        "cover_url": "https://cdn.pipidata.com/images/f913d72811a64528338eedd8062f908ff1324059db412536e077851b386ccd62.png",
        "video_url": "https://cdn.pipidata.com/videos/91193fc731d22c8cfd3206aad35a4e4c902a4bd955449c8ee39a47892cb565f0.mp4",
        "id": "1545429736453611",
        "ad_started_at": 1758092400,
        "type": 1
      },
      {
        "duration": 15,
        "cover_url": "https://cdn.pipidata.com/images/7fad186aba7636ae10c51debf09247e0f2bb372468fd36daa1e06364c0d6dd94.png",
        "video_url": "https://cdn.pipidata.com/videos/0dc52f548ebca789e3ee2d0d982a524ae7be2edbd2ada28e58119b6792c5f4cc.mp4",
        "id": "1421665719390535",
        "ad_started_at": 1758092400,
        "type": 1
      },
      {
        "duration": 13,
        "cover_url": "https://cdn.pipidata.com/images/192a8d2f8ccfecd7a68bd99c00589024a649e196e88cead34cb24fcd54528aaa.png",
        "video_url": "https://cdn.pipidata.com/videos/5a38836f6260e70900973cc3b84e8417f2721936cc7cff7685e35498b8ff1eba.mp4",
        "id": "2223893774765270",
        "ad_started_at": 1758092400,
        "type": 1
      },
      {
        "duration": 15,
        "cover_url": "https://cdn.pipidata.com/images/9ac2e9f2046d112bd8e01cba9f2a29d137d93b895e88c48daf6b575c008c16b2.png",
        "video_url": "https://cdn.pipidata.com/videos/707d0c738b84c5bc9ce1d74043bd214445826c35b9edc29e98d3753a3f1dd01b.mp4",
        "id": "1455369045677992",
        "ad_started_at": 1758092400,
        "type": 1
      },
      {
        "duration": 13,
        "cover_url": "https://cdn.pipidata.com/images/9b0a36757a739ff863e76ecad274d3616df96864dd94434394ada290c709e0bb.png",
        "video_url": "https://cdn.pipidata.com/videos/a8af033b5617edc148b86b88b98c3bf02c3e48640e010f72e6b5bd507cd3b42f.mp4",
        "id": "1321866939415735",
        "ad_started_at": 1758092400,
        "type": 1
      }
    ],
    "product_seven_day_count": 0,
    "landing_page_yesterday_count": 0,
    "task_id": "68fa2e36789edb5700215e03",
    "product_yesterday_count": 0,
    "videos_ad_total_count": 13479,
    "ad_yesterday_count": 0,
    "updated_at": 1761235805,
    "monitor_task_type": 1,
    "product_today_count": 0,
    "ad_total_active_count": 7143,
    "monitored_days": 1,
    "facebook_page_url": "https://www.facebook.com/ads/library/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=422603325536",
    "ad_seven_day_count": 0,
    "landing_page_seven_day_count": 0,
    "product_total_count": 0,
    "cards_ad_total_count": 852,
    "images_ad_total_count": 52,
    "facebook_page_id": "422603325536",
    "ad_total_count": 14383,
    "landing_page_today_count": 0,
    "landing_page_total_count": 1294,
    "avatar_url": "https://cdn.pipidata.com/images/b467aa4e0f396674a14f1ffaa99a1d76.png",
    "ad_today_count": 0,
    "name": "Coolblue",
    "started_at": 1761228363,
    "stoped_at":null,
    "status": 1,
    "monitor_expire_time": 1763821563,
    "category": "Retail Company"
  },
  "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