Browse AI

Retrieve a robot's monitors

开发环境

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

GET

/robots/{robotId}/monitors

monitors

Retrieve a robot's monitors list.

请求示例

Java

Objective-C

Shell

curl --location --request GET 'http://dev-cn.your-api-server.com/robots/c3689adb-50aa-44af-b265-a7e0d4e5846e/monitors' \
--header 'authorization: Bearer YOUR_SECRET_API_KEY'

响应示例

200 - 示例 1

{
    "statusCode": 200,
    "messageCode": "success",
    "monitors": {
        "totalCount": 10,
        "items": [
            {
                "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
            }
        ]
    }
}

请求参数

Path 参数

robotId

string

必需

Unique robot ID

You can find a robot's ID by opening it on the dashboard and copying its ID in the browser address bar.

示例值:

c3689adb-50aa-44af-b265-a7e0d4e5846e

Header 参数

authorization

string

必需

You can generate a new API key on your dashboard if you do not have one.

示例值:

Bearer YOUR_SECRET_API_KEY

返回响应

🟢200A JSON including monitors list.

application/json

Body

statusCode

enum<number>

必需

枚举值:

200

messageCode

enum<string>

必需

枚举值:

success

monitors

object

必需

totalCount

number

必需

Total number of monitors this robot has

示例值:

items

array[object (Monitor) {13}]

必需

Array of all monitors

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

🟠401The request is not authorized

🟠404The resource is not found

🔴500There was an error on the server

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

Retrieve a task

Create a new monitor on a robot