Run Monitor

POST /monitor/{monitorId}/run

Run a monitor

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v2/monitor/{monitorId}/run \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "trigger": "scheduled",
    "scheduledFor": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "estimatedCredits": 123,
    "reservedCredits": 123,
    "actualCredits": 123,
    "billingStatus": "<string>",
    "summary": {
      "totalPages": 123,
      "same": 123,
      "changed": 123,
      "new": 123,
      "removed": 123,
      "error": 123
    },
    "targetResults": "<array>",
    "notificationStatus": {},
    "error": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

monitorId · string<uuid> · required

The monitor ID

Response

200

application/json

Monitor check queued

success · boolean

id · string<uuid>

data · object

Show child attributes