Run Monitor

1 min read

post/monitor/{monitorId}/run

Request example

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

Response

{
  "success": true,
  "id": "<string>",
  "data": {
    "id": "<string>",
    "monitorId": "<string>",
    "status": "queued",
    "trigger": "scheduled",
    "scheduledFor": "2026-08-10T12:00:00Z",
    "startedAt": "2026-08-10T12:00:00Z",
    "finishedAt": "2026-08-10T12:00:00Z",
    "estimatedCredits": 1,
    "reservedCredits": 1,
    "actualCredits": 1,
    "billingStatus": "<string>",
    "summary": {
      "totalPages": 1,
      "same": 1,
      "changed": 1,
      "new": 1,
      "removed": 1,
      "error": 1
    },
    "targetResults": [
      null
    ],
    "notificationStatus": {},
    "error": "<string>",
    "createdAt": "2026-08-10T12:00:00Z",
    "updatedAt": "2026-08-10T12:00:00Z"
  }
}

post/monitor/{monitorId}/run

Authorization

Authorizationstringheaderrequired#

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

Path parameters

monitorIdstringrequired#

The monitor ID

Responses

application/json

Monitor check queued

successboolean#

idstring#

dataobject#

Show child attributes

idstring#

monitorIdstring#

statusenum<string>#

Options:queuedrunningcompletedfailedpartialskipped_overlap

triggerenum<string>#

Options:scheduledmanual

scheduledForstring#

startedAtstring#

finishedAtstring#

estimatedCreditsinteger#

Upper-bound credits reserved for this check before Firecrawl knows how many pages changed and require judging.

reservedCreditsinteger#

actualCreditsinteger#

Final credits charged for this check after scrapes, crawls, and any changed-page judge calls complete.

billingStatusstring#

summaryobject#

Show child attributes

totalPagesinteger#

sameinteger#

changedinteger#

newinteger#

removedinteger#

errorinteger#

targetResultsany[]#

notificationStatusobject#

errorstring#

createdAtstring#

updatedAtstring#

Delete Monitor List Monitor Checks