Live OnPage API Content Parsing
This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content.
This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
<?php // You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforseo.com/'; // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard $client = new RestClient($api_url, null, 'login', 'password'); $post_array = array(); // simple way to get a result $post_array[] = array( "url" => "https://www.fujielectric.com/" ); try { // POST /v3/on_page/content_parsing/live // the full list of possible parameters is available in documentation $result = $client->post('/v3/on_page/content_parsing/live', $post_array); print_r($result); // do something with post result } catch (RestClientException $e) { echo "n"; print "HTTP code: {$e->getHttpCode()}n"; print "Error code: {$e->getCode()}n"; print "Message: {$e->getMessage()}n"; print $e->getTraceAsString(); echo "n"; } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20220819", "status_code": 20000, "status_message": "Ok.", "time": "0.9403 sec.", "cost": 0.000125, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "10311658-1535-0495-0000-95f4edcdf985", "status_code": 20000, "status_message": "Ok.", "time": "0.5905 sec.", "cost": 0.000125, "result_count": 1, "path": [ "v3", "on_page", "content_parsing", "live" ], "data": { "api": "on_page", "function": "content_parsing", "url": "https://www.fujielectric.com/" }, "result": [ { "crawl_progress": "finished", "crawl_status": null, "items_count": 1, "items": [ { "type": "content_parsing_element", "fetch_time": "2022-10-31 12:58:26 +00:00", "status_code": 200, "page_content": { "header": { "primary_content": [ { "text": "Fuji Electric businesses are focused on", "url": null } ], "secondary_content": [ { "text": "Hong Kong", "url": "https://www.hk.fujielectric.com/en/" }, { "text": "About Us", "url": null }, { "text": "Corporate Data", "url": "https://www.fujielectric.com/company/data.html" }, { "text": "Management Strategy", "url": "https://www.fujielectric.com/company/" }, { "text": "Our Businesses", "url": "https://www.fujielectric.com/company/business/?ui_medium=gl_glnavi" }, { "text": "Contribution to SDGs", "url": "https://www.fujielectric.com/company/csr/sdgs/?ui_medium=gl_glnavi" }, { "text": "Global Network", "url": "https://www.fujielectric.com/company/" }, { "text": "Drives & Inverters", "url": "https://www.fujielectric.com/products/drives_inverters.html?ui_medium=gl_glnavi" }, { "text": "Power Supply", "url": "https://www.fujielectric.com/products/power_supply.html?ui_medium=gl_glnavi" }, { "text": "Sensors & Measurements", "url": "https://www.fujielectric.com/products/sensors_measurements.html?ui_medium=gl_glnavi" }, { "text": "Factory Automation", "url": "https://www.fujielectric.com/products/factory_automation.html?ui_medium=gl_glnavi" }, { "text": "Distributions & Controls", "url": "https://www.fujielectric.com/products/distributions_controls.html?ui_medium=gl_glnavi" }, { "text": "Transmission & Distribution", "url": "https://www.fujielectric.com/products/transmission_distribution.html?ui_medium=gl_glnavi" }, { "text": "Social Infrastructure", "url": "https://www.fujielectric.com/products/social_infrastructure.html?ui_medium=gl_glnavi" }, { "text": "Energy Management", "url": "https://www.fujielectric.com/products/energy_management.html?ui_medium=gl_glnavi" }, { "text": "Food and Beverage Distribution", "url": "https://www.fujielectric.com/products/food.html?ui_medium=gl_glnavi" }, { "text": "Equipment Upgrades", "url": "https://www.fujielectric.com/products/renewal.html?ui_medium=gl_glnavi" }, { "text": "Technical Document", "url": "https://felib.fujielectric.co.jp/download/search2.htm?dosearch=1&site=global&lang=en&documentGroup=technical" }, { "text": "CAD data & Outline drawing", "url": "https://felib.fujielectric.co.jp/download/searchcad3.htm?dosearch=1&documentGroup=cad&site=global&lang=en" }, { "text": "Management Information", "url": "https://www.fujielectric.com/ir/management/?ui_medium=gl_glnavi" }, { "text": "IR Library", "url": "https://www.fujielectric.com/ir/library/?ui_medium=gl_glnavi" }, { "text": "Financial Information", "url": "https://www.fujielectric.com/ir/financial_data/?ui_medium=gl_glnavi" }, { "text": "Stock and Bond Information", "url": "https://www.fujielectric.com/ir/stock_bond/?ui_medium=gl_glnavi" }, { "text": "ESG Material Issues", "url": "https://www.fujielectric.com/company/csr/material-issues.html?ui_medium=gl_glnavi" }, { "text": "Environmental Vision 2050", "url": "https://www.fujielectric.com/company/csr/global_environment/management_02_02.html?ui_medium=gl_glnavi" }, { "text": "Contact Us", "url": "https://www.fujielectric.com/contact/?ui_medium=gl_glnavi" }, { "text": "About Us", "url": "https://www.fujielectric.com/company/" }, { "text": "Corporate Data", "url": "https://www.fujielectric.com/company/data.html" }, { "text": "Management Strategy", "url": "https://www.fujielectric.com/company/" }, { "text": "Our Businesses", "url": "https://www.fujielectric.com/company/business/?ui_medium=gl_glnavi" }, { "text": "Contribution to SDGs", "url": "https://www.fujielectric.com/company/csr/sdgs/?ui_medium=gl_glnavi" }, { "text": "Global Network", "url": "https://www.fujielectric.com/company/" }, { "text": "Products & Solutions", "url": "https://www.fujielectric.com/products/?ui_medium=gl_glnavi" }, { "text": "Drives & Inverters", "url": "https://www.fujielectric.com/products/drives_inverters.html?ui_medium=gl_glnavi" }, { "text": "Power Supply", "url": "https://www.fujielectric.com/products/power_supply.html?ui_medium=gl_glnavi" }, { "text": "Sensors & Measurements", "url": "https://www.fujielectric.com/products/sensors_measurements.html?ui_medium=gl_glnavi" }, { "text": "Factory Automation", "url": "https://www.fujielectric.com/products/factory_automation.html?ui_medium=gl_glnavi" }, { "text": "Distributions & Controls", "url": "https://www.fujielectric.com/products/distributions_controls.html?ui_medium=gl_glnavi" }, { "text": "Transmission & Distribution", "url": "https://www.fujielectric.com/products/transmission_distribution.html?ui_medium=gl_glnavi" }, { "text": "Social Infrastructure", "url": "https://www.fujielectric.com/products/social_infrastructure.html?ui_medium=gl_glnavi" }, { "text": "Energy Management", "url": "https://www.fujielectric.com/products/energy_management.html?ui_medium=gl_glnavi" }, { "text": "Food and Beverage Distribution", "url": "https://www.fujielectric.com/products/food.html?ui_medium=gl_glnavi" }, { "text": "Equipment Upgrades", "url": "https://www.fujielectric.com/products/renewal.html?ui_medium=gl_glnavi" }, { "text": "Technical Document", "url": "https://felib.fujielectric.co.jp/download/search2.htm?dosearch=1&site=global&lang=en&documentGroup=technical" }, { "text": "CAD data & Outline drawing", "url": "https://felib.fujielectric.co.jp/download/searchcad3.htm?dosearch=1&documentGroup=cad&site=global&lang=en" }, { "text": "Investor Relations", "url": "https://www.fujielectric.com/ir/?ui_medium=gl_glnavi" }, { "text": "Management Information", "url": "https://www.fujielectric.com/ir/management/?ui_medium=gl_glnavi" }, { "text": "IR Library", "url": "https://www.fujielectric.com/ir/library/?ui_medium=gl_glnavi" }, { "text": "Financial Information", "url": "https://www.fujielectric.com/ir/financial_data/?ui_medium=gl_glnavi" }, { "text": "Stock and Bond Information", "url": "https://www.fujielectric.com/ir/stock_bond/?ui_medium=gl_glnavi" }, { "text": "ESG Material Issues", "url": "https://www.fujielectric.com/company/csr/material-issues.html?ui_medium=gl_glnavi" }, { "text": "Environmental Vision 2050", "url": "https://www.fujielectric.com/company/csr/global_environment/management_02_02.html?ui_medium=gl_glnavi" }, { "text": "Contact Us", "url": "https://www.fujielectric.com/contact/?ui_medium=gl_glnavi" }, { "text": "Fe Library", "url": "https://felib.fujielectric.co.jp/download/index.htm?site=global&lang=en" }, { "text": "\"Energy and Environment\"", "url": null }, { "text": "Fuji Electric", "url": null }, { "text": "Solution Movie", "url": null } ] }, "footer": { "primary_content": [ { "text": "© Fuji Electric Co., Ltd. All rights reserved.", "url": null } ], "secondary_content": [ { "text": "Corporate Data", "url": "https://www.fujielectric.com/company/data.html" }, { "text": "Management Strategy", "url": "https://www.fujielectric.com/company/" }, { "text": "Our Businesses", "url": "https://www.fujielectric.com/company/business/" }, { "text": "Contribution to SDGs", "url": "https://www.fujielectric.com/company/csr/sdgs/" }, { "text": "Global Network", "url": "https://www.fujielectric.com/company/" }, { "text": "Drives & Inverters", "url": "https://www.fujielectric.com/products/drives_inverters.html" }, { "text": "Power Supply", "url": "https://www.fujielectric.com/products/power_supply.html" }, { "text": "Sensors & Measurements", "url": "https://www.fujielectric.com/products/sensors_measurements.html" }, { "text": "Factory Automation", "url": "https://www.fujielectric.com/products/factory_automation.html" }, { "text": "Distributions & Controls", "url": "https://www.fujielectric.com/products/distributions_controls.html" }, { "text": "Transmission & Distribution", "url": "https://www.fujielectric.com/products/transmission_distribution.html" }, { "text": "Social Infrastructure", "url": "https://www.fujielectric.com/products/social_infrastructure.html" }, { "text": "Energy Management", "url": "https://www.fujielectric.com/products/energy_management.html" }, { "text": "Food and Beverage Distribution", "url": "https://www.fujielectric.com/products/food.html" }, { "text": "Equipment Upgrades", "url": "https://www.fujielectric.com/products/renewal.html" }, { "text": "Technical Document", "url": "https://felib.fujielectric.co.jp/download/search2.htm?dosearch=1&site=global&lang=en&documentGroup=technical" }, { "text": "CAD data & Outline drawing", "url": "https://felib.fujielectric.co.jp/download/searchcad3.htm?dosearch=1&documentGroup=cad&site=global&lang=en" }, { "text": "Management Information", "url": "https://www.fujielectric.com/ir/management/" }, { "text": "IR Library", "url": "https://www.fujielectric.com/ir/library/" }, { "text": "Financial Information", "url": "https://www.fujielectric.com/ir/financial_data/" }, { "text": "Stock and Bond Information", "url": "https://www.fujielectric.com/ir/stock_bond/" }, { "text": "ESG Material Issues", "url": "https://www.fujielectric.com/company/csr/material-issues.html" }, { "text": "Environmental Vision 2050", "url": "https://www.fujielectric.com/company/csr/global_environment/management_02_02.html" }, { "text": "Product Inquiries", "url": "https://www.fujielectric.com/contact/" }, { "text": "Corporate Inquiries", "url": "https://www.fujielectric.com/contact/contact.php?kind=Investor%20Relations" }, { "text": "Privacy policy", "url": "https://www.fujielectric.com/privacy/index.html" }, { "text": "Terms of Services", "url": "https://www.fujielectric.com/copyright/" }, { "text": "Site Map", "url": "https://www.fujielectric.com/sitemap/" }, { "text": "Cookie Settings", "url": null }, { "text": "Social Media", "url": "https://www.fujielectric.com/socialmedia/" }, { "text": "Social Media", "url": "https://www.fujielectric.com/socialmedia/" } ] }, "main_topic": null, "secondary_topic": [ { "h_title": "Topics", "main_title": "Topics", "author": null, "language": "en", "level": 2, "primary_content": null, "secondary_content": null }, { "h_title": "Interview about research and development to achieve carbon neutrality through open innovation", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": null }, { "h_title": "Announcement Regarding Changes to the Management of Subsidiary as of October 1, 2022", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": null }, { "h_title": "Work on virtual power plant, a key to the spread of renewable energy", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": null }, { "h_title": "Interview about how we contributing to customers seeking to achieve carbon neutrality", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": null }, { "h_title": "Revision of FY2030 Goals in Environmental Vision 2050", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": null }, { "h_title": "Global Network", "main_title": "Topics", "author": null, "language": "en", "level": 2, "primary_content": null, "secondary_content": [ { "text": "Asia/Middle East", "url": "https://www.fujielectric.com/company/asia.php" }, { "text": "Regional Websites", "url": null } ] }, { "h_title": "Regional Websites", "main_title": "Topics", "author": null, "language": "en", "level": 2, "primary_content": null, "secondary_content": [ { "text": "Hong Kong", "url": "https://www.hk.fujielectric.com/en/" } ] }, { "h_title": "Products & Solutions", "main_title": "Topics", "author": null, "language": "en", "level": 2, "primary_content": [ { "text": "Food and Beverage Distribution", "url": null } ], "secondary_content": [ { "text": "Drives & Inverters", "url": null }, { "text": "Power Supply", "url": null }, { "text": "Sensors & Measurements", "url": null }, { "text": "Factory Automation Systems", "url": null }, { "text": "Distribution & Controls", "url": null }, { "text": "Transmission & Distribution", "url": null }, { "text": "Social Infrastructure", "url": null }, { "text": "Energy Management", "url": null }, { "text": "Food and Beverage", "url": null }, { "text": "Equipment Upgrades", "url": null }, { "text": "Drives & Inverters", "url": null }, { "text": "Power Supply", "url": null }, { "text": "Sensors & Measurements", "url": null }, { "text": "Factory Automation Systems", "url": null }, { "text": "Distribution & Controls", "url": null }, { "text": "Transmission & Distribution", "url": null }, { "text": "Social Infrastructure", "url": null }, { "text": "Energy Management", "url": null }, { "text": "Equipment Upgrades", "url": null }, { "text": "AC Drives (Low voltage)", "url": "https://www.fujielectric.com/products/ac_drives_lv/" }, { "text": "AC Drives (Medium voltage)", "url": "https://www.fujielectric.com/products/adjustable_speed_drive/" }, { "text": "Servo Systems", "url": "https://www.fujielectric.com/products/servo/" }, { "text": "UPS, Uninterruptible Power System", "url": "https://www.fujielectric.com/products/power_supply/" }, { "text": "Solar Inverters", "url": "https://www.fujielectric.com/products/power_supply/power_conditioner/megasolar.html" }, { "text": "Data Center", "url": "https://www.fujielectric.com/products/solution/case-studies/datacenter.html" }, { "text": "Large-Capacity Rectifier, S-Former", "url": "https://www.fujielectric.com/products/s_former/" }, { "text": "Radiation Monitoring", "url": "https://www.fujielectric.com/products/radiation/" }, { "text": "PLC, Programmable logic controller", "url": "https://www.fujielectric.com/products/plc/" }, { "text": "HMI, Human machine interface", "url": "http://monitouch.fujielectric.com/" }, { "text": "Process Control System, MICREX-NX", "url": "https://www.fujielectric.com/products/process_control_automation_system/" }, { "text": "Monitoring and Control System, MICREX-VieW XX", "url": "https://www.fujielectric.com/products/micrex_view/" }, { "text": "Process Data Acquisition and analysis, f(s)NISDAS", "url": "https://www.fujielectric.com/products/fsnisdas_x/" }, { "text": "Steel EMS Solution", "url": "https://www.fujielectric.com/products/steel_ems_solution/" }, { "text": "Steel EMS Package LITE", "url": "https://www.fujielectric.com/products/steel_ems_solution/lite/" }, { "text": "Boiler Combustion solution", "url": "https://www.fujielectric.com/products/boiler_combustion_solution/" }, { "text": "LV Distribution", "url": "https://www.fujielectric.com/products/lv.html" }, { "text": "Motor Control", "url": "https://www.fujielectric.com/products/mc.html" }, { "text": "Energy Control Equipment", "url": "https://www.fujielectric.com/products/pm.html" }, { "text": "MV Distribution", "url": "https://www.fujielectric.com/products/mv.html" }, { "text": "Oil-immersed Transformer, Shunt Reactor", "url": "https://www.fujielectric.com/products/oil-immersed_transformer/" }, { "text": "Cast Resin Transformer, MOLTRA", "url": "https://www.fujielectric.com/products/cast_resin_transformer/" }, { "text": "GIS, Gas Insulated Switchgear", "url": "https://www.fujielectric.com/products/gas_insulated_switchgear/" }, { "text": "MV & LV Switchgear and Control Center", "url": "https://www.fujielectric.com/products/switchgear_and_control_center/" }, { "text": "DC High-speed Vacuum Circuit Breaker", "url": "https://www.fujielectric.com/products/vacuum_circuit_breaker/" }, { "text": "Pure Water Vaporization Cooling Silicon Rectifier", "url": "https://www.fujielectric.com/products/silicon_rectifier/" }, { "text": "Tunnel Ventilation System", "url": "https://www.fujielectric.com/products/ventilations/" }, { "text": "Marine Environment Protection", "url": "https://www.fujielectric.com/products/saveblue/" }, { "text": "Electrical Equipment for Railcars", "url": "https://www.fujielectric.com/products/electric_railways/" }, { "text": "Thermal Power Generation", "url": "https://www.fujielectric.com/products/thermal_power_generation/" }, { "text": "Geothermal Power Generation", "url": "https://www.fujielectric.com/products/geothermal_power_generation/" }, { "text": "Nuclear Power", "url": "https://www.fujielectric.com/products/nuclear/" }, { "text": "Fuel Cell", "url": "https://www.fujielectric.com/products/fuelcell/" }, { "text": "Power System Simulator", "url": "https://www.fujielectric.com/products/energy_ctrl_mng/b02.html" }, { "text": "Multipurpose Vending Machine", "url": "https://www.fujielectric.com/products/can_pet_vending_machine/" }, { "text": "Can & PET Bottle Beverage Vending Machine", "url": "https://www.fujielectric.com/products/hot_cold_vending_machine/" }, { "text": "Coin Mechanism", "url": "https://www.fujielectric.com/products/coin_mechanism/" }, { "text": "Bill Validator", "url": "https://www.fujielectric.com/products/bill_validator/" }, { "text": "Fuji Electric Solution", "url": "https://www.fujielectric.com/products/solution/" }, { "text": "IoT System Solution", "url": "https://www.fujielectric.com/products/solution/system_solution/" }, { "text": "Service Solution", "url": "https://www.fujielectric.com/products/service_solution/" }, { "text": "After Sales Services", "url": "https://www.fujielectric.com/products/renewal/ac_drives_lv/" }, { "text": "Medium-Voltage Devices in the Panel", "url": "https://www.fujielectric.com/products/renewal/hv_distribution/" }, { "text": "Low-Voltage Electric Distribution Devices", "url": "https://www.fujielectric.com/products/renewal/lv_distribution/" }, { "text": "AC Drives (Medium voltage)", "url": "https://www.fujielectric.com/products/renewal/adjustable_speed_drive/" }, { "text": "UPS, Uninterruptible Power System", "url": "https://www.fujielectric.com/products/renewal/ups/" }, { "text": "Monitoring and Control Systems", "url": "https://www.fujielectric.com/products/renewal/monitoring/" }, { "text": "AC Drives (Low voltage)", "url": "https://www.fujielectric.com/products/renewal/ac_drives_lv/" } ] }, { "h_title": "News Release", "main_title": "Topics", "author": null, "language": "en", "level": 2, "primary_content": null, "secondary_content": [ { "text": "Learn More", "url": "https://www.fujielectric.com/company/news/" } ] }, { "h_title": "Notice", "main_title": "Topics", "author": null, "language": "en", "level": 2, "primary_content": null, "secondary_content": [ { "text": "Learn More", "url": "https://www.fujielectric.com/event.html" } ] }, { "h_title": "Stories", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": [ { "text": "Introducing Fuji Electric's efforts to solve social and environmental issues.", "url": "https://www.fujielectric.com/company/story/index.html" } ] }, { "h_title": "Group Companies", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": [ { "text": "Find Fuji Electric group companies nearest to you.", "url": "https://www.fujielectric.com/company/offices/index.html" } ] }, { "h_title": "Research & Development", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": [ { "text": "Discover how we innovate energy technjology.", "url": "https://www.fujielectric.com/company/research_development/" } ] }, { "h_title": "SDGs", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": [ { "text": "Find out how we are committed to contributing to the realization of a sustainable society.", "url": "https://www.fujielectric.com/company/csr/sdgs/index.html" } ] }, { "h_title": "ESG", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": [ { "text": "Find out about our ESG initiatives for sustainable growth.", "url": "https://www.fujielectric.com/company/csr/index.html" } ] }, { "h_title": "Business Overview", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": null }, { "h_title": "Important Notices", "main_title": "Topics", "author": null, "language": "en", "level": 3, "primary_content": null, "secondary_content": [ { "text": "Warning regarding suspicious solicitations using our company name", "url": "https://www.fujielectric.com/notice/2021122301.html?from_top=news_important_01" } ] } ] } } ] } ] } ] }
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.
Description of the fields for setting a task:
Field name | Type | Description |
---|---|---|
url |
string | URL of the content to parse required field URL of the page to parse example: https://www.fujielectric.com/ |
custom_user_agent |
string | custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor) |
browser_preset |
string | preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width , browser_screen_height , browser_screen_scale_factor
possible values:
Note: to use this parameter, set |
browser_screen_width |
integer | browser screen width optional field you 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 minimum value, in pixels: |
browser_screen_height |
integer | browser screen height optional field you 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 minimum value, in pixels: |
browser_screen_scale_factor |
float | browser screen scale factor optional field you 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 minimum value: |
store_raw_html |
boolean | store HTML of a crawled page optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpointdefault value: false |
disable_cookie_popup |
boolean | disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user;default value: false
|
accept_language |
string | language header for accessing the website optional field all 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 |
enable_javascript |
boolean | load javascript on a page optional field set to true if you want to load the scripts available on a pagedefault value: false Note: 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 |
enable_browser_rendering |
boolean | emulate browser rendering to measure Core Web Vitals optional field by 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: false set 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 true Note: 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 |
enable_xhr |
boolean | enable XMLHttpRequest on a page optional field set 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, |
custom_js |
string | custom javascript optional field Note that the execution time for the script you enter here should be 700 ms maximum for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a the returned value depends on what you specified in this field. For instance, if you specify the following script: Note: 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 |
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
Description of the fields in the response array:
Field name | Type | Description |
---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the same parameters that you specified in the POST request |
result |
array | array of results |
crawl_progress |
string | status of the crawling session possible values: in_progress , finished |
crawl_status |
object | details of the crawling session |
items_count |
integer | number of items in the results array |
items |
array | items array |
‘сontent_parsing_element’ | ||
type |
string | type of the returned item = ‘сontent_parsing_element’ |
fetch_time |
string | date and time when the content was fethced example: "2022-11-01 10:02:52 +00:00" |
status_code |
integer | status code of the page |
page_content |
object | parsed content of the page |
header |
object | parsed content of the header |
primary_content |
array | primary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |
secondary_content |
array | secondary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |
footer |
object | parsed content of the footer |
primary_content |
array | primary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |
secondary_content |
array | secondary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |
main_topic |
array | main topic on the page you can find more information about topic priority calculation in this help center article |
h_title |
string | meta title |
main_title |
string | main title of the block |
author |
string | content author name |
language |
string | content language |
level |
string | HTML level |
primary_content |
array | primary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |
secondary_content |
array | secondary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |
secondary_topic |
array | secondary topic on the page you can find more information about topic priority calculation in this help center article |
h_title |
string | meta title |
main_title |
string | main title of the block |
author |
string | content author name |
language |
string | content language |
level |
string | HTML level |
primary_content |
array | primary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |
secondary_content |
array | secondary content on the page you can find more information about content priority calculation in this help center article |
text |
string | content text |
url |
string | page URL displayed in case the text is a link anchor |