Content Parsing Live

{
  "$defs": {
    "OnPageContentParsingLiveRequestInfo": {
      "properties": {
        "accept_language": {
          "anyOf": [
            {
              "description": "language header for accessing the websiteoptional fieldall locale formats are supported (xx, xx-XX, xxx-XX, etc.)Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\":\"broken in the response array",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "browser_preset": {
          "anyOf": [
            {
              "description": "preset for browser screen parametersoptional fieldif you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values:desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390browser_screen_height: 844br",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "browser_screen_height": {
          "anyOf": [
            {
              "description": "browser screen heightoptional fieldyou can set a custom browser screen height to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240maximum value, in pixels: 9999",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "browser_screen_scale_factor": {
          "anyOf": [
            {
              "description": "browser screen scale factoroptional fieldyou can set a custom browser screen resolution ratio to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value: 0.5maximum value: 3",
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "browser_screen_width": {
          "anyOf": [
            {
              "description": "browser screen widthoptional fieldyou can set a custom browser screen width to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240maximum value, in pixels: 9999",
              "format": "int64",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "custom_user_agent": {
          "anyOf": [
            {
              "description": "custom user agentoptional fieldcustom user agent for crawling a websiteexample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36default value: Mozilla/5.0 (compatible; RSiteAuditor)",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "disable_cookie_popup": {
          "anyOf": [
            {
              "description": "disable the cookie popup optional fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "enable_browser_rendering": {
          "anyOf": [
            {
              "description": "emulate browser rendering to measure Core Web Vitalsoptional fieldby using this parameter you will be able to emulate a browser when loading a web page;enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;default value: falseset to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;if you use this field, enable_javascript, and load_resources parameters must be set to trueNote: if you use this parameter, additional charges wil",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "enable_javascript": {
          "anyOf": [
            {
              "description": "load javascript on a pageoptional fieldset to true if you want to load the scripts available on a pagedefault value: falseNote: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "enable_xhr": {
          "anyOf": [
            {
              "description": "enable XMLHttpRequest on a pageoptional fieldset to true if you want our crawler to request data from a web server using the XMLHttpRequest objectdefault value:false if you use this field, enable_javascript must be set to true;",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "ip_pool_for_scan": {
          "anyOf": [
            {
              "description": "proxy pooloptional fieldyou can choose a location of the proxy pool that will be used to obtain the requested data;the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errorspossible values: us, de",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "markdown_view": {
          "anyOf": [
            {
              "description": "return page content as markdownoptional fieldif set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response;default value: false",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "store_raw_html": {
          "anyOf": [
            {
              "description": "store HTML of a crawled pageoptional fieldset to true if you want to get the HTML of the page using the OnPage Raw HTML endpointdefault value: false",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "switch_pool": {
          "anyOf": [
            {
              "description": "switch proxy pooloptional fieldif true, additional proxy pools will be used to obtain the requested data;the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "url": {
          "description": "URL of the content to parserequired fieldURL of the page to parseexample:`https://www.fujielectric.com/`",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/OnPageContentParsingLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}