Skip to main content
POST
/
api
/
v1
Crawl Page
curl --request POST \
  --url https://crawl.getmonita.io/api/v1 \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "session_id": "<string>",
  "user": {},
  "options": {
    "screenShots": false,
    "byPassConsent": true,
    "country": "<string>",
    "proxy": true,
    "webhook": false
  },
  "validationRules": [
    {
      "rule_id": "<string>",
      "vendor": "<string>",
      "key": "<string>",
      "value": "<string>",
      "condition": "OR",
      "rule_type": "Pixel"
    }
  ]
}
'
{
  "sessionId": "<string>",
  "button": {
    "button_text": "<string>",
    "consent_banner": true,
    "error_message": "recaptcha"
  },
  "success": false,
  "marketingPixels": [
    {
      "vendor": "<string>",
      "account_id": "<string>",
      "page": "<string>"
    }
  ],
  "url": "<string>",
  "cookiesBefore": 123,
  "cookiesAfter": 123,
  "timeTaken": 123,
  "error": {
    "error": true,
    "message": "<string>"
  },
  "validationResults": [
    {
      "rule_id": "<string>",
      "success": true
    }
  ],
  "screenShotUrls": {
    "screenShotBefore": "<string>",
    "screenShotAfter": "<string>"
  },
  "message": "<string>"
}

Headers

x-api-key
string | null

API key for authorization

Body

application/json
url
string
required
session_id
string<uuid4> | null
required
user
User · object
options
Options · object
validationRules
ValidationRule · object[] | null

Response

Successful Response

sessionId
string<uuid4> | null
button
ButtonAttributes · object
success
boolean
default:false
marketingPixels
MarketingPixel · object[] | null
url
string | null
cookiesBefore
integer | null
cookiesAfter
integer | null
timeTaken
integer | null
error
ErrorMessage · object
validationResults
ValidationResult · object[] | null
screenShotUrls
ScreenShotUrls · object
message
string | null