Pular para o conteúdo principal
POST
/
monitor
curl --request POST \
  --url https://api.firecrawl.dev/v2/monitor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "goal": "Notify me when docs pages add, remove, or materially change API behavior",
  "name": "Docs monitor",
  "schedule": {
    "cron": "7-59/15 * * * *",
    "timezone": "UTC"
  },
  "targets": [
    {
      "crawlOptions": {
        "limit": 100
      },
      "type": "crawl",
      "url": "https://example.com/docs"
    }
  ],
  "webhook": {
    "events": [
      "monitor.page",
      "monitor.check.completed"
    ],
    "url": "https://example.com/webhooks/firecrawl"
  }
}
'
{
  "data": {
    "createdAt": "2023-11-07T05:31:56Z",
    "currentCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "estimatedCreditsPerMonth": 123,
    "goal": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "judgeEnabled": true,
    "lastCheckSummary": {
      "changed": 123,
      "error": 123,
      "new": 123,
      "removed": 123,
      "same": 123,
      "totalPages": 123
    },
    "lastRunAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "nextRunAt": "2023-11-07T05:31:56Z",
    "notification": {
      "email": {
        "enabled": false,
        "includeDiffs": false,
        "recipients": [
          "jsmith@example.com"
        ]
      }
    },
    "retentionDays": 123,
    "schedule": {
      "cron": "<string>",
      "timezone": "<string>"
    },
    "targets": [
      {
        "type": "scrape",
        "urls": [
          "<string>"
        ],
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "scrapeOptions": {
          "actions": [
            {
              "milliseconds": 2,
              "type": "wait"
            }
          ],
          "blockAds": true,
          "excludeTags": [
            "<string>"
          ],
          "formats": [
            "markdown"
          ],
          "headers": {},
          "includeTags": [
            "<string>"
          ],
          "location": {
            "country": "US",
            "languages": [
              "en-US"
            ]
          },
          "lockdown": false,
          "maxAge": 172800000,
          "minAge": 123,
          "mobile": false,
          "onlyCleanContent": false,
          "onlyMainContent": true,
          "parsers": [
            "pdf"
          ],
          "profile": {
            "name": "<string>",
            "saveChanges": true
          },
          "proxy": "auto",
          "redactPII": false,
          "removeBase64Images": true,
          "skipTlsVerification": true,
          "storeInCache": true,
          "threatProtection": {
            "blacklist": [
              "<string>"
            ],
            "blockedTlds": [
              "<string>"
            ],
            "riskScoreThreshold": 75,
            "whitelist": [
              "<string>"
            ]
          },
          "timeout": 60000,
          "waitFor": 0
        }
      }
    ],
    "updatedAt": "2023-11-07T05:31:56Z",
    "webhook": {
      "url": "<string>",
      "events": [],
      "headers": {},
      "metadata": {}
    }
  },
  "success": true
}

Autorizações

​
Authorization
string
header
obrigatório

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

Corpo

application/json
​
name
string
obrigatório
Maximum string length: 256
​
schedule
object
obrigatório

Programação das verificações de monitor. Forneça cron ou text.

​
targets
(Scrape target · object | Crawl target · object | Search target · object)[]
obrigatório
Required array length: 1 - 50 elements
​
goal
string | null

Objetivo em linguagem natural usado para avaliar se as páginas alteradas são relevantes. Se fornecido e judgeEnabled for omitido, a avaliação será ativada automaticamente. Obrigatório (não vazio) quando qualquer destino for do tipo search, a menos que judgeEnabled seja false.

Maximum string length: 2000
​
judgeEnabled
boolean

Define se as páginas alteradas devem ser avaliadas com base em goal. Requer um goal não vazio para ser executado.

​
notification
object
​
retentionDays
integer
padrão:30
Intervalo obrigatório: 1 <= x <= 365
​
webhook
object

Destino do webhook para eventos de página do monitor e de conclusão da verificação.

Resposta

Monitor criado

​
data
object
​
success
boolean