Get Monitor

GET /monitor/{monitorId}

Get a monitor

cURL

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

import requests

url = "https://api.firecrawl.dev/v2/monitor/{monitorId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.firecrawl.dev/v2/monitor/{monitorId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/monitor/{monitorId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/monitor/{monitorId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.firecrawl.dev/v2/monitor/{monitorId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/monitor/{monitorId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "schedule": {
      "cron": "<string>",
      "timezone": "<string>"
    },
    "nextRunAt": "2023-11-07T05:31:56Z",
    "lastRunAt": "2023-11-07T05:31:56Z",
    "currentCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targets": [
      {
        "type": "scrape",
        "urls": [
          "<string>"
        ],
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "scrapeOptions": {
          "formats": [
            "markdown"
          ],
          "onlyMainContent": true,
          "onlyCleanContent": false,
          "includeTags": [
            "<string>"
          ],
          "excludeTags": [
            "<string>"
          ],
          "maxAge": 172800000,
          "minAge": 123,
          "headers": {},
          "waitFor": 0,
          "mobile": false,
          "skipTlsVerification": true,
          "timeout": 60000,
          "parsers": [
            "pdf"
          ],
          "actions": [
            {
              "type": "wait",
              "milliseconds": 2
            }
          ],
          "location": {
            "country": "US",
            "languages": [
              "en-US"
            ]
          },
          "removeBase64Images": true,
          "blockAds": true,
          "proxy": "auto",
          "storeInCache": true,
          "lockdown": false,
          "redactPII": false,
          "profile": {
            "name": "<string>",
            "saveChanges": true
          },
          "threatProtection": {
            "riskScoreThreshold": 75,
            "blacklist": [
              "<string>"
            ],
            "whitelist": [
              "<string>"
            ],
            "blockedTlds": [
              "<string>"
            ]
          }
        }
      }
    ],
    "webhook": {
      "url": "<string>",
      "headers": {},
      "metadata": {},
      "events": []
    },
    "notification": {
      "email": {
        "enabled": false,
        "recipients": [
          "[e-mail]"
        ],
        "includeDiffs": false
      }
    },
    "retentionDays": 123,
    "estimatedCreditsPerMonth": 123,
    "lastCheckSummary": {
      "totalPages": 123,
      "same": 123,
      "changed": 123,
      "new": 123,
      "removed": 123,
      "error": 123
    },
    "goal": "<string>",
    "judgeEnabled": true,
    "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 details

success · boolean

data · object

Show child attributes