Get Monitor Check

1 min read

get/monitor/{monitorId}/checks/{checkId}

Request example

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

Response

{
  "success": true,
  "next": "<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",
    "pages": [
      {
        "id": "<string>",
        "targetId": "<string>",
        "url": "<string>",
        "status": "same",
        "previousScrapeId": "<string>",
        "currentScrapeId": "<string>",
        "statusCode": 1,
        "error": "<string>",
        "metadata": {},
        "judgment": {
          "meaningful": true,
          "confidence": "high",
          "reason": "<string>",
          "meaningfulChanges": [
            {
              "type": "added",
              "before": "<string>",
              "after": "<string>",
              "reason": "<string>"
            }
          ]
        },
        "diff": {
          "text": "<string>",
          "json": {}
        },
        "snapshot": {
          "json": {}
        },
        "createdAt": "2026-08-10T12:00:00Z"
      }
    ],
    "next": "<string>"
  }
}

get/monitor/{monitorId}/checks/{checkId}

Authorization

Authorizationstringheaderrequired#

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

Path parameters

monitorIdstringrequired#

The monitor ID

checkIdstringrequired#

The monitor check ID

Query parameters

limitinteger#

Default: 25

Range: 1–100

skipinteger#

Number of page results to skip. Use the next URL from the previous response for pagination.

Default: 0

Range: >= 0

statusenum<string>#

Options:samenewchangedremovederror

Responses

application/json

Monitor check details

successboolean#

nextstring#

URL to fetch the next page of monitor check page results, if any.

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#

pagesobject[]#

Show child attributes

idstring#

targetIdstring#

urlstring#

statusenum<string>#

Options:samenewchangedremovederror

previousScrapeIdstring#

currentScrapeIdstring#

statusCodeinteger#

errorstring#

metadataobject#

Extra per-page metadata. For search monitors this includes searchStatus, the finer-grained search disposition behind the top-level status: alert (maps to new), already_seen, watching, ignored (all map to same), or skipped (maps to error).

judgmentobject#

Show child attributes

meaningfulboolean#

Whether the changed page is meaningful for the monitor goal.

confidenceenum<string>#

Options:highmediumlow

reasonstring#

meaningfulChangesobject[]#

Goal-relevant changes selected by the judge from the page diff.

Show child attributes

typeenum<string>#

Options:addedremovedchanged

beforestring#

afterstring#

reasonstring#

diffobject#

Inline diff artifact when the page changed. The shape depends on what the monitor's scrapeOptions.formats asked for. Markdown-only monitors populate both text (unified diff) and json (parseDiff AST). JSON-extraction monitors populate json as a per-field {previous, current} map keyed by JSON path. Mixed-mode monitors (changeTracking with both json and git-diff modes) populate both text (markdown sidecar) and json (per-field diff).

Show child attributes

textstring#

Unified markdown diff. Present on markdown-only and mixed-mode monitors.

jsonobject#

For markdown-only monitors, a parseDiff AST { files: [...] }. For JSON-extraction (and mixed-mode) monitors, a per-field { previous, current } map keyed by the JSON path into the extraction (e.g. plans[0].price).

snapshotobject#

Snapshot of the current JSON extraction at this run. Present on JSON-extraction and mixed-mode monitors; absent for markdown-only monitors.

Show child attributes

jsonobject#

The full structured JSON extracted on this run, matching the schema/prompt declared on the target's changeTracking format.

createdAtstring#

nextstring#

URL to fetch the next page of monitor check page results, if any.

List Monitor Checks Agent