Create Monitor Task

This document explains how to create monitor tasks using advertiser accounts. There are four ways to create monitor tasks:

Priority Note: If multiple parameters are submitted simultaneously, the system uses them in the following priority: facebook_page_id_list > facebook_page_url_list > facebook_public_page_number_list > facebook_shop_url_list

API 1: Advertiser Search

API Information

• API Name: Advertiser Search
• Request Method: POST
• API URL: open-api/v1/monitor/data
• Endpoint Path: /v3/api/ad-monitor-task/search-fb-ads-advertiser
• Description: Search advertiser information by keyword and return a list of matching advertisers. Users can create monitor tasks using the returned facebook_page_id.
• 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/search-fb-ads-advertiser",
    "params": {
      "name": "example"
    }
  }'

Response Parameters

Response Structure

{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      {
        "facebook_page_id": "714739975064116",
        "name": "Example Advertiser",
        "avatar_url": "https://example.com/avatar.jpg",
        "category": "Digital creator",
        "country": null
      }
    ]
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

Response Field Description

Response Data Fields

API 2: Create Monitor Task

API Information

• API Name: Create Monitor Task
• Request Method: POST
• API URL: open-api/v1/monitor/data
• Endpoint Path: /v3/api/ad-monitor-task/create-monitor-task
• Description: Batch create monitor tasks for advertisers or stores/websites, supports four input methods, and returns the creation result for each task.
• Usage Note: 1 credit will be deducted for each successfully created monitor task

Request Headers:

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

Request Parameters

Request Structure

Request Body Parameters (params object)

Important Notes:

1. At least one of the four parameters above must be provided (cannot all be null or empty)
2. Maximum 50 monitor objects can be added per request
3. If multiple parameters are submitted simultaneously, the system uses them in priority order: facebook_page_id_list > facebook_page_url_list > facebook_public_page_number_list > facebook_shop_url_list

Request Examples

Method 1: Create via Advertiser ID (Recommended)

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/create-monitor-task",
    "params": {
      "facebook_page_id_list": ["614178972053891", "714739975064116"]
    }
  }'

Method 2: Create via Advertiser URL

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/create-monitor-task",
    "params": {
      "facebook_page_url_list": ["https://www.facebook.com/example"]
    }
  }'

Method 3: Create via Public Page Number

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/create-monitor-task",
    "params": {
      "facebook_public_page_number_list": ["123456789"]
    }
  }'

Method 4: Create via Store/Website URL

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/create-monitor-task",
    "params": {
      "facebook_shop_url_list": ["https://example.com"]
    }
  }'

Response Parameters

Response Structure

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "task_id": "1005",
      "facebook_page_id": "614178972053891",
      "facebook_page_url": null,
      "facebook_public_page_number": null,
      "facebook_shop_url": null,
      "error_message": null
    }
  ],
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 1,
  "fail": false,
  "success": true
}

Response Field Description

Response Data Fields

Error Codes