DataForSEO · Schema
DataForSEO On Page API Schemas
SEOSERPKeywordsBacklinksDomain AnalyticsOn-Page SEOCompetitor ResearchSearch EnginesContent AnalysisE-CommerceApp StoreBusiness DataAI OptimizationSocial Media
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DataForSEO On Page API Schemas",
"definitions": {
"OnPagePagesByResourceResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPagePagesByResourceTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"OnPagePagesByResourceTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPagePagesByResourceResultInfo"
}
],
"nullable": true
},
"description": "array of results",
"nullable": true
}
}
}
]
},
"OnPagePagesByResourceResultInfo": {
"type": "object",
"properties": {
"crawl_progress": {
"type": "string",
"description": "status of the crawling session\npossible values: in_progress, finished",
"nullable": true
},
"crawl_status": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/CrawlStatusInfo"
}
],
"description": "details of the crawling session",
"nullable": true
},
"total_items_count": {
"type": "integer",
"description": "total number of relevant items in the database",
"format": "int64",
"nullable": true
},
"items_count": {
"type": "integer",
"description": "number of items in the results array",
"format": "int64",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPageHtmlResourceItem"
}
],
"nullable": true
},
"description": "items array",
"nullable": true
}
}
},
"CrawlStatusInfo": {
"type": "object",
"properties": {
"max_crawl_pages": {
"type": "integer",
"description": "maximum number of pages to crawl\n indicates the max_crawl_pages limit you specified when setting a task",
"format": "int64",
"nullable": true
},
"pages_in_queue": {
"type": "integer",
"description": "number of pages that are currently in the crawling queue",
"format": "int64",
"nullable": true
},
"pages_crawled": {
"type": "integer",
"description": "number of crawled pages",
"format": "int64",
"nullable": true
}
}
},
"OnPageHtmlResourceItem": {
"type": "object",
"allOf": [
{
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/BaseOnPageResourceItem"
}
],
"nullable": true
},
{
"type": "object",
"properties": {
"meta": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/PageMetaInfo"
}
],
"properties": {
"social_media_tags": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"broken_html": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPageResourceIssueInfo"
}
],
"description": "resource errors and warnings",
"nullable": true
}
},
"description": "page properties\nthe value depends on the resource_type",
"nullable": true
},
"page_timing": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/PageTiming"
}
],
"description": "object of page load metrics",
"nullable": true
},
"onpage_score": {
"type": "number",
"description": "shows how page is optimized on a 100-point scale\nthis field shows how page is optimized considering critical on-page issues and warnings detected;\n100 is the highest possible score that means the page does not have any critical on-page issues and important warnings;\nlearn more about how the metric is calculated in this help center article",
"nullable": true
},
"total_dom_size": {
"type": "integer",
"description": "total DOM size of a page",
"format": "int64",
"nullable": true
},
"custom_js_response": {
"type": "object",
"description": "the result of executing a specified JS script\nnote that you should specify a custom_js field when setting a task to receive this data and the field type and its value will totally depend on the script you specified;\nyou can also filter the results by this value specifying filters in the following way:\n[\"custom_js_response.url\", \"like\", \"pixel\"]",
"nullable": true
},
"custom_js_client_exception": {
"type": "string",
"description": "error when executing a custom js\nif the error occurred when executing the script you specified in the custom_js field, the error message would be displayed here",
"nullable": true
},
"broken_resources": {
"type": "boolean",
"description": "indicates whether a page contains broken resources",
"nullable": true
},
"broken_links": {
"type": "boolean",
"description": "indicates whether a page contains broken links",
"nullable": true
},
"duplicate_title": {
"type": "boolean",
"description": "indicates whether a page has duplicate title tags",
"nullable": true
},
"duplicate_description": {
"type": "boolean",
"description": "indicates whether a page has a duplicate description",
"nullable": true
},
"duplicate_content": {
"type": "boolean",
"description": "indicates whether a page has duplicate content",
"nullable": true
},
"click_depth": {
"type": "integer",
"description": "number of clicks it takes to get to the page\nindicates the number of clicks from the homepage needed before landing at the target page",
"nullable": true
},
"is_resource": {
"type": "boolean",
"description": "indicates whether a page is a single resource",
"nullable": true
},
"url_length": {
"type": "integer",
"description": "page URL length in characters",
"nullable": true
},
"relative_url_length": {
"type": "integer",
"description": "relative URL length in characters",
"nullable": true
}
}
}
]
},
"BaseOnPageResourceItem": {
"type": "object",
"properties": {
"resource_type": {
"type": "string",
"description": "type of the returned resource = \u2018html\u2019",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "status code of the page",
"nullable": true
},
"location": {
"type": "string",
"description": "location header\nindicates the URL to redirect a page to",
"nullable": true
},
"url": {
"type": "string",
"description": "page URL",
"nullable": true
},
"resource_errors": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPageResourceIssueInfo"
}
],
"description": "resource errors and warnings",
"nullable": true
},
"size": {
"type": "integer",
"description": "resource size\nindicates the size of a given page measured in bytes",
"nullable": true
},
"encoded_size": {
"type": "integer",
"description": "page size after encoding\nindicates the size of the encoded page measured in bytes",
"nullable": true
},
"total_transfer_size": {
"type": "integer",
"description": "compressed page size\nindicates the compressed size of a given page",
"format": "int64",
"nullable": true
},
"fetch_time": {
"type": "string",
"description": "date and time when a resource was fetched\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00",
"nullable": true
},
"cache_control": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/CacheControl"
}
],
"description": "instructions for caching",
"nullable": true
},
"checks": {
"type": "object",
"additionalProperties": {
"type": "boolean",
"nullable": true
},
"description": "website checks\non-page check-ups related to the page",
"nullable": true
},
"content_encoding": {
"type": "string",
"description": "type of encoding",
"nullable": true
},
"media_type": {
"type": "string",
"description": "types of media used to display a page",
"nullable": true
},
"server": {
"type": "string",
"description": "server version",
"nullable": true
},
"last_modified": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/LastModified"
}
],
"description": "contains data on changes related to the resource\nif there is no data, the value will be null",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "resource_type",
"mapping": {
"html": "#/components/schemas/OnPageHtmlResourceItem",
"broken": "#/components/schemas/OnPageBrokenResourceItem",
"redirect": "#/components/schemas/OnPageRedirectResourceItem",
"script": "#/components/schemas/OnPageScriptResourceItem",
"image": "#/components/schemas/OnPageImageResourceItem",
"stylesheet": "#/components/schemas/OnPageStylesheetResourceItem"
}
}
},
"CacheControl": {
"type": "object",
"properties": {
"cachable": {
"type": "boolean",
"description": "indicates whether the page is cacheable",
"nullable": true
},
"ttl": {
"type": "integer",
"description": "time to live\nthe amount of time the browser caches a resource",
"nullable": true
}
}
},
"LastModified": {
"type": "object",
"properties": {
"header": {
"type": "string",
"description": "date and time when the header was last modified\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00\nif there is no data, the value will be null",
"nullable": true
},
"sitemap": {
"type": "string",
"description": "date and time when the sitemap was last modified\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00\nif there is no data, the value will be null",
"nullable": true
},
"meta_tag": {
"type": "string",
"description": "date and time when the meta tag was last modified\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00\nif there is no data, the value will be null",
"nullable": true
}
}
},
"OnPageResourceIssueInfo": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPageResourceIssueItemInfo"
}
],
"nullable": true
},
"description": "resource errors",
"nullable": true
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPageResourceIssueItemInfo"
}
],
"nullable": true
},
"description": "resource warnings",
"nullable": true
}
},
"description": "resource errors and warnings"
},
"OnPageResourceIssueItemInfo": {
"type": "object",
"properties": {
"line": {
"type": "integer",
"description": "line where the error was found",
"nullable": true
},
"column": {
"type": "integer",
"description": "column where the error was found",
"nullable": true
},
"message": {
"type": "string",
"description": "text message of the error\nthe full list of possible HTML errors can be found here",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "status code of the error\npossible values:\n0 \u2014 Unidentified Error;\n501 \u2014 Html Parse Error;\n1501 \u2014 JS Parse Error;\n2501 \u2014 CSS Parse Error;\n3501 \u2014 Image Parse Error;\n3502 \u2014 Image Scale Is Zero;\n3503 \u2014 Image Size Is Zero;\n3504 \u2014 Image Format Invalid",
"nullable": true
}
}
},
"PageTiming": {
"type": "object",
"properties": {
"time_to_interactive": {
"type": "integer",
"description": "Time To Interactive (TTI) metric\nthe time it takes until the user can interact with a page (in milliseconds)",
"nullable": true
},
"dom_complete": {
"type": "integer",
"description": "time to load resources\nthe time it takes until the page and all of its subresources are downloaded (in milliseconds)",
"nullable": true
},
"largest_contentful_paint": {
"type": "number",
"description": "Core Web Vitals metric measuring how fast the largest above-the-fold content element is displayed\nThe amount of time (in milliseconds) to render the largest content element visible in the viewport, from when the user requests the URL. Learn more.",
"nullable": true
},
"first_input_delay": {
"type": "number",
"description": "Core Web Vitals metric indicating the responsiveness of a page\nThe time (in milliseconds) from when a user first interacts with your page to the time when the browser responds to that interaction. Learn more.",
"nullable": true
},
"connection_time": {
"type": "integer",
"description": "time to connect to a server\nthe time it takes until the connection with a server is established (in milliseconds)",
"nullable": true
},
"time_to_secure_connection": {
"type": "integer",
"description": "time to establish a secure connection\nthe time it takes until the secure connection with a server is established (in milliseconds)",
"nullable": true
},
"request_sent_time": {
"type": "integer",
"description": "time to send a request to a server\nthe time it takes until the request to a server is sent (in milliseconds)",
"nullable": true
},
"waiting_time": {
"type": "integer",
"description": "time to first byte (TTFB) in milliseconds",
"nullable": true
},
"download_time": {
"type": "integer",
"description": "time it takes for a browser to receive a response (in milliseconds)",
"nullable": true
},
"duration_time": {
"type": "integer",
"description": "total time it takes until a browser receives a complete response from a server (in milliseconds)",
"nullable": true
},
"fetch_start": {
"type": "integer",
"description": "time to start downloading the HTML resource\nthe amount of time the browser needs to start downloading a page",
"nullable": true
},
"fetch_end": {
"type": "integer",
"description": "time to complete downloading the HTML resource\nthe amount of time the browser needs to complete downloading a page",
"nullable": true
}
}
},
"PageMetaInfo": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "page title",
"nullable": true
},
"charset": {
"type": "integer",
"description": "code page\nexample: 65001",
"nullable": true
},
"follow": {
"type": "boolean",
"description": "indicates whether a page\u2019s \u2018meta robots\u2019 allows crawlers to follow the links on the page\nif false, the page\u2019s \u2018meta robots\u2019 tag contains \u201cnofollow\u201d parameter instructing crawlers not to follow the links on the page",
"nullable": true
},
"generator": {
"type": "string",
"description": "meta tag generator",
"nullable": true
},
"htags": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "HTML header tags",
"nullable": true
},
"description": {
"type": "string",
"description": "content of the meta description tag",
"nullable": true
},
"favicon": {
"type": "string",
"description": "favicon of the page",
"nullable": true
},
"meta_keywords": {
"type": "string",
"description": "content of the keywords meta tag",
"nullable": true
},
"canonical": {
"type": "string",
"description": "canonical page",
"nullable": true
},
"internal_links_count": {
"type": "integer",
"description": "number of internal links on the page",
"format": "int64",
"nullable": true
},
"external_links_count": {
"type": "integer",
"description": "number of external links on the page",
"format": "int64",
"nullable": true
},
"inbound_links_count": {
"type": "integer",
"description": "number of internal links pointing at the page",
"format": "int64",
"nullable": true
},
"images_count": {
"type": "integer",
"description": "number of images on the page",
"format": "int64",
"nullable": true
},
"images_size": {
"type": "integer",
"description": "total size of images on the page measured in bytes",
"nullable": true
},
"scripts_count": {
"type": "integer",
"description": "number of scripts on the page",
"format": "int64",
"nullable": true
},
"scripts_size": {
"type": "integer",
"description": "total size of scripts on the page measured in bytes",
"nullable": true
},
"stylesheets_count": {
"type": "integer",
"description": "number of stylesheets on the page",
"format": "int64",
"nullable": true
},
"stylesheets_size": {
"type": "integer",
"description": "total size of stylesheets on the page measured in bytes",
"nullable": true
},
"title_length": {
"type": "integer",
"description": "length of the title tag in characters",
"nullable": true
},
"description_length": {
"type": "integer",
"description": "length of the description tag in characters",
"nullable": true
},
"render_blocking_scripts_count": {
"type": "integer",
"description": "number of scripts on the page that block page rendering",
"format": "int64",
"nullable": true
},
"render_blocking_stylesheets_count": {
"type": "integer",
"description": "number of CSS styles on the page that block page rendering",
"format": "int64",
"nullable": true
},
"cumulative_layout_shift": {
"type": "number",
"description": "Core Web Vitals metric measuring the layout stability of the page\nmeasures the sum total of all individual layout shift scores for every unexpected layout shift that occurs during the entire lifespan of the page. Learn more.",
"nullable": true
},
"meta_title": {
"type": "string",
"description": "meta title of the page\nmeta tag in the head section of an HTML document that defines the title of a page",
"nullable": true
},
"content": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HtmlContentInfo"
}
],
"description": "overall information about content of the page",
"nullable": true
},
"deprecated_tags": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "deprecated tags on the page",
"nullable": true
},
"duplicate_meta_tags": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "duplicate meta tags on the page",
"nullable": true
},
"spell": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HunspellInfo"
}
],
"description": "spellcheck\nhunspell spellcheck errors",
"nullable": true
},
"social_media_tags": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "object of social media tags found on the page\ncontains social media tags and their content\nsupported tags include but are not limited to Open Graph and Twitter card",
"nullable": true
},
"broken_html": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OnPageResourceIssueInfo"
}
],
"description": "resource errors and warnings",
"nullable": true
}
}
},
"HtmlContentInfo": {
"type": "object",
"properties": {
"plain_text_size": {
"type": "integer",
"description": "total size of the text on the page measured in bytes",
"nullable": true
},
"plain_text_rate": {
"type": "number",
"description": "plaintext rate value\nplain_text_size to size ratio",
"format": "double",
"nullable": true
},
"plain_text_word_count": {
"type": "integer",
"description": "number of words on the page",
"nullable": true
},
"automated_readability_index": {
"type": "number",
"description": "Automated Readability Index",
"nullable": true
},
"coleman_liau_readability_index": {
"type": "number",
"description": "Coleman\u2013Liau Index",
"nullable": true
},
"dale_chall_readability_index": {
"type": "number",
"description": "Dale\u2013Chall Readability Index",
"nullable": true
},
"flesch_kincaid_readability_index": {
"type": "number",
"description": "Flesch\u2013Kincaid Readability Index",
"nullable": true
},
"smog_readability_index": {
"type": "number",
"description": "SMOG Readability Index",
"nullable": true
},
"description_to_content_consistency": {
"type": "number",
"description": "consistency of the meta description tag with the page content\nmeasured from 0 to 1",
"nullable": true
},
"title_to_content_consistency": {
"type": "number",
"description": "consistency of the meta title tag with the page content\nmeasured from 0 to 1",
"nullable": true
},
"meta_keywords_to_content_consistency": {
"type": "number",
"description": "consistency of meta keywordstag with the page content\nmeasured from 0 to 1",
"nullable": true
}
}
},
"HunspellInfo": {
"type": "object",
"properties": {
"hunspell_language_code": {
"type": "string",
"description": "spellcheck language code",
"nullable": true
},
"misspelled": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HunspellMisspelledInfo"
}
],
"nullable": true
},
"description": "array of misspelled words",
"nullable": true
}
}
},
"HunspellMisspelledInfo": {
"type": "object",
"properties": {
"word": {
"type": "string",
"description": "misspelled word",
"nullable": true
}
}
},
"BaseResponseTaskInfo": {
"properties": {
"id": {
"type": "string",
"description": "task identifier\nunique task identifier in our system in the UUID format",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here",
"nullable": true
},
"status_message": {
"type": "string",
"description": "informational message of the task\nyou can find the full list of general informational messages here",
"nullable": true
},
"time": {
"type": "string",
"description": "execution time, seconds",
"nullable": true
},
"cost": {
"type": "number",
"description": "total tasks cost, USD",
"format": "double",
"nullable": true
},
"result_count": {
"type": "integer",
"description": "number of elements in the result array",
"format": "int64",
"nullable": true
},
"path": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "URL path",
"nullable": true
},
"data": {
"type": "object",
"additionalProperties": {
"type": "object",
"nullable": true
},
"description": "contains the same parameters that you specified in the POST request",
"nullable": true
}
}
},
"BaseResponseInfo": {
"properties": {
"version": {
"type": "string",
"description": "the current version of the API",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "general status code\nyou can find the full list of the response codes here",
"nullable": true
},
"status_message": {
"type": "string",
"description": "general informational message\nyou can find the full list of general informational messages here",
"nullable": true
},
"time": {
"type": "string",
"description": "total execution time, seconds",
"nullable": true
},
"cost": {
"type": "number",
"description": "total tasks cost, USD",
"format": "double",
"nullable": true
},
"tasks_count": {
"type": "integer",
"description": "the number of tasks in the tasks array",
"format": "int64",
"nullable": true
},
"tasks_error": {
"type": "integer",
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64",
"nullable": true
}
}
},
"OnPageNonIndexableRequestInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the task\nrequired field\nyou can get this ID in the response of the Task POST endpoint\nexample:\n\u201c07131248-1535-0216-1000-17384017ad04\u201d"
},
"limit": {
"type": "integer",
"description": "the maximum number of returned pages\noptional field\ndefault value: 100\nmaximum value: 1000",
"nullable": true
},
"offset": {
"type": "integer",
"description": "offset in the results array of returned pages\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages",
"nullable": true
},
"filters": {
"type": "array",
"items": {
"type": "object",
"nullable": true
},
"description": "array of results filtering parameters\noptional field\nyou can add several filters at once (8 filters maximum)\nyou should set a logical operator and, or between the conditions\nthe following operators are supported:\nregex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like\nyou can use the % operator with like and not_like to match any string of zero or more characters\nexample:\n[\"reason\",\"=\",\"robots_txt\"][[\"reason\",\"<>\",\"robots_txt\"],\n\"and\",\n[\"url\",\"not_like\",\"%/wp-admin/%\"]]\n[[\"url\",\"not_like\",\"%/wp-admin/%\"],\n\"and\",\n[[\"reason\",\"<>\",\"meta_tag\"],\"or\",[\"reason\",\"<>\",\"http_header\"]]]\nThe
# --- truncated at 32 KB (226 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dataforseo/refs/heads/main/json-schema/dataforseo-on-page-schema.json