Create a new monitor on a robot

开发环境

http://dev-cn.your-api-server.com

POST

/robots/{robotId}/monitors

Create a new monitor on a robot.

请求参数

Path 参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200A JSON object containing the newly created monitor.

application/json

Body

🟠400A JSON containing error attributes. This will happen if any of the parameters are not valid.

🟠401The request is not authorized

🟠403A JSON containing error attributes.

🟠404The resource is not found

🔴500There was an error on the server

请求示例

Shell

JavaScript

Java

Swift

curl --request POST \
  --url https://api.browse.ai/v2/robots/{robotId}/monitors \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --data '{"name":"Monitor products","inputParameters":{"originUrl":"https://www.espressozone.com/espresso-machines/semi-automatic-espresso-machines"},"schedule":"FREQ=HOURLY;INTERVAL=1;BYWEEKDAY=MO,TU,WE,TH,FR","notifyOnCapturedScreenshotChange":true,"notifyOnCapturedTextChange":true,"capturedScreenshotNotificationThreshold":15}'

响应示例

200 - 示例 1

{
    "statusCode": 200,
    "messageCode": "success",
    "monitor": {
        "id": "f6fb62b6-f06a-4bf7-a623-c6a35c2e70b0",
        "name": "Monitor Products",
        "status": "active",
        "pausedReason": "lowCredits",
        "inputParameters": {
            "originUrl": "https://www.ycombinator.com/companies/airbnb",
            "companies_skip": 0,
            "companies_limit": 10
        },
        "schedules": [
            {
                "type": "FIXED_INTERVAL",
                "everyMinutes": 60
            }
        ],
        "schedule": "FREQ=HOURLY;INTERVAL=1;BYWEEKDAY=MO,TU,WE,TH,FR",
        "notifyOnCapturedScreenshotChange": true,
        "notifyOnCapturedTextChange": true,
        "capturedScreenshotNotificationThreshold": 15,
        "createdAt": 1678795867879,
        "pausedAt": 1678795867879,
        "updatedAt": 1678795867879
    }
}

修改于 2024-02-20 02:11:12

Retrieve a robot's monitors

Retrieve a robot's monitor