Monitor Task Ad List

API Information

• API Name: Monitor Task Ad List
• Request Method: POST
• API URL: open-api/v1/monitor/data
• Endpoint Path: /v3/api/ad-monitor-task/ad-library-list
• Description:
  • Ad Library Query - Query all ad data under the task based on monitor task ID
  • Dimension Filtering - Support filtering ads by multiple conditions, including:
    • Keyword search
    • Ad creation time range
    • Ad forecast status (Testing/Scaling/Winning)
    • Ad set count range
    • Ad end time range
    • Ad delivery duration range
    • Coverage range
    • Ad spend range
    • Media format (Video/Image/Carousel)
    • Video duration range
    • Button text (CTA)
    • Ad platform (Facebook/Instagram, etc.)
    • Ad status (Active/Inactive/Removed)
    • Product price range
    • Product creation time range
    • Landing page URL
    • Ad copy content
    • Related product ID list
  • Sorting and Pagination - Support sorting by multiple fields and pagination query
  • Usage Note: Free

Request Headers:

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

Request Parameters

Request Structure

Request Body Parameters (params object)

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-library-list",
    "params": {
        "order_by": "ad_started_at",
        "direction": "desc",
        "page": 1,
        "ad_started_at_start": 1753574400,
        "ad_started_at_end": 1761350399,
        "per_page": 20,
        "task_id": "68fa2e36789edb5700215e03",
        "media_format_list": [
            1,
            2,
            3
        ],
        "button_text_list": [
            "Add to cart",
            "Apply now",
            "Book now",
            "Buy now"
        ]
    }
  }'

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

Response Data Information Fields

Pagination Information Fields

Ad Data Fields (objects in data array)

Video Information Fields (objects in videos array)

Advertiser Information Fields (advertiser object)

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "per_page": 20,
    "total": 1,
    "data": [
      {
        "country": [
          "NL"
        ],
        "ad_caption": "werkenbijcoolblue.nl/winkel-alkmaar",
        "button_type": "APPLY_NOW",
        "videos": [
          {
            "duration": 15,
            "cover_url": "https://cdn.pipidata.com/images/0e62b0d751f21752a0b1ab5b69f7a183949b87627d7f59a1638890cd01331b19.png",
            "width": 720,
            "url": "https://cdn.pipidata.com/videos/810468b5afa64b5f8ab521d319f02e9edc81e5de50df84b1f8a6c2966f805009.mp4",
            "height": 1280
          }
        ],
        "ad_content": "Wil je werken met de leukste collega's? Word onderdeel van ons team. #WerkenbijCoolblue #Alkmaar",
        "last_discovered_at": 1755532885,
        "ad_title": "Word onderdeel van ons team.",
        "ad_ended_at": 1755500400,
        "ad_link": "https://www.facebook.com/ads/library/?id=1779094526050412",
        "ad_forecast": 2,
        "id": "1779094526050412",
        "latest_actived_at": 1755500400,
        "landing_page_type": 3,
        "advertiser": {
          "like_count": 463298,
          "profile_picture_url": "https://cdn.pipidata.com/images/b467aa4e0f396674a14f1ffaa99a1d76.png",
          "ad_count": 14383,
          "source_advertiser_id": "422603325536",
          "name": "Coolblue",
          "id": "422603325536",
          "ad_country": [
            "NL",
            "BE",
            "DE",
            "ES",
            "HU"
          ],
          "ads_library_link": "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_cost": 1559.74,
        "first_discovered_at": 1755532885,
        "landing_pages": [
          "https://www.werkenbijcoolblue.nl/winkels/?location=alkmaar"
        ],
        "ad_audience_reach": 11192,
        "adset_count": 1,
        "ad_status": 1,
        "media_format": 1,
        "ad_platform": [
          "FACEBOOK",
          "INSTAGRAM"
        ],
        "button_text": "Apply now",
        "ad_started_at": 1755500400,
        "active_days": 1
      }
    ],
    "last_page": 1,
    "current_page": 1
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

Error Codes