Cancel Monitor Task

API Information

API Name: Cancel Monitor Task
Request Method: POST
API URL: open-api/v1/monitor/data
Endpoint Path: /v3/api/ad-monitor-task/cancel
Description:
- Cancel the specified ad monitor task
  - Cancel ad monitor task by task ID (task_id)
  - Usage Note: Free
  - Important Note: <span style="color:red; font-weight: bold;">Once a monitoring task is canceled, consumed credits will not be refunded</span>

Request Headers:

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

Request Parameters

Request Structure

Parameter	Type	Description	Example	Required
key	string	User's external API request key	"your_api_key_here"	Yes
uri	string	Endpoint path	"/v3/api/ad-monitor-task/cancel"	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/cancel",
    "params": {
      "task_id": "68f98898850c5345a4c87e66"
    }
  }'

Response Parameters

Response Structure

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

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	boolean	true: Cancel successful, false: Cancel failed

Response Example

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

Error Codes

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