{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "DataForSEO Domain Analytics API Schemas", "definitions": { "DomainAnalyticsWhoisAvailableFiltersResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsWhoisAvailableFiltersTaskInfo" } ], "nullable": true }, "nullable": true } } } ] }, "DomainAnalyticsWhoisAvailableFiltersTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsWhoisAvailableFiltersResultInfo" } ], "nullable": true }, "nullable": true } } } ] }, "DomainAnalyticsWhoisAvailableFiltersResultInfo": { "type": "object", "properties": { "overview": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "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 } } }, "DomainAnalyticsTechnologiesDomainsByTechnologyLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainsByTechnologyLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesDomainsByTechnologyLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainsByTechnologyLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesDomainsByTechnologyLiveResultInfo": { "type": "object", "properties": { "total_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 }, "offset": { "type": "integer", "description": "specified offset value", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\nby specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainsByLiveItem" } ], "nullable": true }, "description": "items array", "nullable": true } } }, "DomainAnalyticsTechnologiesDomainsByLiveItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "domain": { "type": "string", "description": "specified domain name", "nullable": true }, "title": { "type": "string", "description": "domain meta title", "nullable": true }, "description": { "type": "string", "description": "domain meta description", "nullable": true }, "meta_keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "domain meta keywords", "nullable": true }, "domain_rank": { "type": "integer", "description": "backlink rank of the target domain\nlearn more about the metric and how it is calculated in this help center article", "nullable": true }, "last_visited": { "type": "string", "description": "most recent date when our crawler visited the domain\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2022-10-10 12:57:46 +00:00", "nullable": true }, "country_iso_code": { "type": "string", "description": "domain ISO code\nISO code of the country that target domain is determined to belong to", "nullable": true }, "language_code": { "type": "string", "description": "domain language\ncode of the language that target domain is determined to be associated with", "nullable": true }, "content_language_code": { "type": "string", "description": "content language\ncode of the language that content on the target domain is written with", "nullable": true }, "phone_numbers": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "phone numbers of the target\ncontact phone numbers indicated on the target website", "nullable": true }, "emails": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "emails of the target\nemails indicated on the target website", "nullable": true }, "social_graph_urls": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "social media links and handles\nsocial media URLs detected in the social graphs of the target website", "nullable": true }, "technologies": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TechnologiesInfo" } ], "description": "technologies used by target domain\ncontains objects with the names of technologies used on the website;\nto get a full list of technologies and their structure, refer to the technologies endpoint", "nullable": true } }, "description": "items array" }, "TechnologiesInfo": { "type": "object", "properties": { "add_ons": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "analytics": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "web_development": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "security": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "business_tools": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "sales": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "other": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "user_generated_content": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "booking": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "privacy": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "servers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "location": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "content": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "media": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "marketing": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "communication": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true }, "utilities": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "nullable": true } } }, "DomainAnalyticsTechnologiesTechnologiesSummaryLiveRequestInfo": { "type": "object", "properties": { "technology_paths": { "type": "array", "items": { "type": "string" }, "description": "target technology paths\nrequired field if you don\u2019t specify groups, technologies and categories\neach technology path should be specified as a separate object containing \u201cpath\u201d and \u201cname\u201d, where \u201cpath\u201d is specified as \u201c$group_id.$category_id\u201d and \u201cname\u201d \u2013 as the name of the target technology;\neach object with a technology path should be separated with a comma\nyou can find the full list of technology group ids, category ids and technology names on this page\nnote: you can specify up to 10 technology paths in this array\nexample:\n[{\"path\": \"content.cms\",\"name\": \"wordpress\"}, {\"path\": \"marketing.crm\",\"name\": \"salesforce\"}]", "nullable": true }, "groups": { "type": "array", "items": { "type": "string" }, "description": "ids of the target technology groups\nrequired field if you don\u2019t specify technologies, technology_paths, categories, or keywords\nyou can find the full list of technology group ids on this page\nnote: you can specify up to 10 technology groups in this array\nexample:\n[\"sales\", \"marketing\"]", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "description": "ids of the target technology categories\nrequired field if you don\u2019t specify groups, technology_paths, technologies, or keywords\nyou can find the full list of technology category ids on this page\nnote: you can specify up to 10 technology categories in this array\nexample:\n[\"payment_processors\",\"crm\"]", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "target technologies\nrequired field if you don\u2019t specify groups, technology_paths, categories, or keywords\nyou can find the full list of technologies you can specify here on this page\nnote: you can specify up to 10 technologies in this array\nexample:\n[\"Google Pay\",\"Salesforce\"]", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "target keywords in the domain\u2019s title, description or meta keywords\nrequired field if you don\u2019t specify groups, technology_paths, categories, or technologies\nyou can specify the maximum of 10 keywords;\nUTF-8 encoding;\nexample:\n[\"seo\",\"software\"]\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", "nullable": true }, "mode": { "type": "string", "description": "search mode\noptional field\npossible search mode types:\nas_is \u2013 search for results exactly matching the specified group ids, category ids, or technology names\nentry \u2013 search for results matching a part of the specified group ids, category ids, or technology names\ndefault value: as_is", "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:\n<, <=, >, >=, =, <>, 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\nyou can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code\nexample:\n[[\"country_iso_code\",\"=\",\"US\"],\n\"and\",\n[\"domain_rank\",\">\",800]]\nfor more information about filters, please refer to Domain Analytics Technologies API \u2013 Filters", "nullable": true }, "internal_list_limit": { "type": "integer", "description": "maximum number of elements within internal arrays\noptional field\nyou can use this field to limit the number of elements within the following arrays:\ncountries, languages, content_languages, keywords\ndefault value: 10\nminimum value: 1\nmaximum value: 10000", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "mode": "entry", "technologies": [ "Ngi" ], "keywords": [ "WordPress" ], "filters": [ [ "country_iso_code", "=", "US" ], "and", [ "domain_rank", ">", 800 ] ] } ] }, "DomainAnalyticsTechnologiesTechnologiesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesTechnologiesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesTechnologiesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesTechnologiesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesTechnologiesResultInfo": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Groups" } ], "nullable": true }, "description": "array of technology groups", "nullable": true } } }, "Groups": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the technology group\nexample:\nmarketing, sales", "nullable": true }, "title": { "type": "string", "description": "title of the technology group", "nullable": true }, "categories": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TechnologyCategoryInfo" } ], "nullable": true }, "description": "technology categories in this group", "nullable": true } } }, "TechnologyCategoryInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the technology category\nexample:\ncrm, cart_abandonment", "nullable": true }, "path": { "type": "string", "description": "path to the technology category\nexample:\nuser_generated_content.content_curation", "nullable": true }, "title": { "type": "string", "description": "title of the technology category", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "list of technologies in this category\nexample:\n\"Salesforce\", \"CareCart\"", "nullable": true } } }, "DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResultInfo": { "type": "object", "properties": { "total_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 }, "offset": { "type": "integer", "description": "specified offset value", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\nby specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainsByLiveItem" } ], "nullable": true }, "description": "items array", "nullable": true } } }, "DomainAnalyticsTechnologiesTechnologiesSummaryLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesTechnologiesSummaryLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesTechnologiesSummaryLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesTechnologiesSummaryLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesTechnologiesSummaryLiveResultInfo": { "type": "object", "properties": { "countries": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "distribution of websites by country\ncontains country codes and number of websites per country", "nullable": true }, "languages": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "distribution of websites by language\ncontains language codes and number of websites per language", "nullable": true }, "content_languages": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "distribution of websites by content language\ncontains content language codes and number of websites per language", "nullable": true }, "keywords": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "distribution of websites by keywords\ncontains keywords found in the websites\u2019 titles, descriptions or meta keywords, and number of websites using each keyword", "nullable": true } } }, "DomainAnalyticsTechnologiesLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesLocationsResultInfo": { "type": "object", "properties": { "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true } } }, "DomainAnalyticsErrorsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsErrorsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsErrorsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsErrorsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsErrorsResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the task", "nullable": true }, "datetime": { "type": "string", "description": "date and time when an error occurred\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "function": { "type": "string", "description": "corresponding API function", "nullable": true }, "error_code": { "type": "integer", "description": "error code", "nullable": true }, "error_message": { "type": "string", "description": "error message or error URL\nerror message (see full list) or URL that caused an error", "nullable": true }, "http_url": { "type": "string", "description": "URL that caused an error\nURL you used for making an API call or pingback/postback URL", "nullable": true }, "http_method": { "type": "string", "description": "HTTP method", "nullable": true }, "http_code": { "type": "integer", "description": "HTTP status code", "nullable": true }, "http_time": { "type": "number", "description": "time taken by HTTP request\nfor tasks set with a pingback/postback, this field will show the time it took your server to respond", "nullable": true }, "http_response": { "type": "string", "description": "HTTP response\nserver response", "nullable": true } } }, "DomainAnalyticsTechnologiesDomainTechnologiesLiveRequestInfo": { "type": "object", "properties": { "target": { "type": "string", "description": "target domain\nrequired field\ndomain name of the website to analyze\nNote: results will be returned for the specified domain only" } }, "example": [ { "target": "dataforseo.com" } ] }, "DomainAnalyticsTechnologiesDomainTechnologiesLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainTechnologiesLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesDomainTechnologiesLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesDomainTechnologiesLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesDomainTechnologiesLiveResultInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "domain": { "type": "string", "description": "specified domain name", "nullable": true }, "title": { "type": "string", "description": "domain meta title", "nullable": true }, "description": { "type": "string", "description": "domain meta description", "nullable": true }, "meta_keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "domain meta keywords", "nullable": true }, "domain_rank": { "type": "integer", "description": "backlink rank of the target domain\nlearn more about the metric and how it is calculated in this help center article", "nullable": true }, "last_visited": { "type": "string", "description": "most recent date when our crawler visited the domain\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2022-10-10 12:57:46 +00:00", "nullable": true }, "country_iso_code": { "type": "string", "description": "domain ISO code\nISO code of the country that the target domain is determined to belong to", "nullable": true }, "language_code": { "type": "string", "description": "domain language\ncode of the language that the target domain is determined to be associated with", "nullable": true }, "content_language_code": { "type": "string", "description": "content language\ncode of the language that content on the target domain is written in", "nullable": true }, "phone_numbers": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "phone numbers of the target\ncontact phone numbers indicated on the target website", "nullable": true }, "emails": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "emails of the target\nemails indicated on the target website", "nullable": true }, "social_graph_urls": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "social media links and handles\nsocial media URLs detected in the social graphs of the target website", "nullable": true }, "technologies": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TechnologiesInfo" } ], "description": "technologies used by target domain\ncontains objects with the names of technologies used on the website\nsee the full list of available technologies structured by groups and categories", "nullable": true } } }, "DomainAnalyticsIdListRequestInfo": { "type": "object", "properties": { "datetime_from": { "type": "string", "description": "start time for filtering results\nrequired field\nif include_metadata is set to true, maximum value: a month from current datetime;\nif include_metadata is set to false, maximum value: six months from current datetime;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00" }, "datetime_to": { "type": "string", "description": "finish time for filtering results\nrequired field\nmaximum value: current datetime;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-31 13:57:46 +00:00" }, "limit": { "type": "integer", "description": "the maximum number of returned task IDs\noptional field\ndefault value: 1000\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned task IDs\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten tasks in the results array will be omitted", "nullable": true }, "sort": { "type": "string", "description": "sorting by task execution time\noptional field\npossible values: \"asc\", \"desc\"\ndefault value: \"asc\"", "nullable": true }, "include_metadata": { "type": "boolean", "description": "include task metadata in the respond\noptional field\ndefault value: false", "nullable": true } }, "example": [ { "datetime_from": "2026-04-12 04:39:39 +00:00", "datetime_to": "2026-04-14 04:39:39 +00:00", "limit": 100, "offset": 0, "sort": "desc", "include_metadata": true } ] }, "DomainAnalyticsTechnologiesAvailableFiltersResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesAvailableFiltersTaskInfo" } ], "nullable": true }, "nullable": true } } } ] }, "DomainAnalyticsTechnologiesAvailableFiltersTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesAvailableFiltersResultInfo" } ], "nullable": true }, "nullable": true } } } ] }, "DomainAnalyticsTechnologiesAvailableFiltersResultInfo": { "type": "object", "properties": { "domains_by_technology": { "type": "object", "additionalProperties": { "type": "string", "description": "backlink rank of the domain\nthe following operators are supported: <, <=, >, >=, =, <>, in, not_in\nexample:\n\"filters\": [\"domain_rank\",\"in\",[100,500]]", "nullable": true }, "nullable": true }, "aggregation_technologies": { "type": "object", "additionalProperties": { "type": "string", "description": "backlink rank of the domain\nthe following operators are supported: <, <=, >, >=, =, <>, in, not_in\nexample:\n\"filters\": [\"domain_rank\",\"in\",[100,500]]", "nullable": true }, "nullable": true }, "technologies_summary": { "type": "object", "additionalProperties": { "type": "string", "description": "backlink rank of the domain\nthe following operators are supported: <, <=, >, >=, =, <>, in, not_in\nexample:\n\"filters\": [\"domain_rank\",\"in\",[100,500]]", "nullable": true }, "nullable": true }, "domains_by_html_terms": { "type": "object", "additionalProperties": { "type": "string", "description": "backlink rank of the domain\nthe following operators are supported: <, <=, >, >=, =, <>, in, not_in\nexample:\n\"filters\": [\"domain_rank\",\"in\",[100,500]]", "nullable": true }, "nullable": true } } }, "DomainAnalyticsTechnologiesTechnologyStatsLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesTechnologyStatsLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesTechnologyStatsLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesTechnologyStatsLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesTechnologyStatsLiveResultInfo": { "type": "object", "properties": { "technology": { "type": "string", "description": "target technology", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range", "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/DomainAnalyticsTechnologiesTechnologyStatsLiveItem" } ], "nullable": true }, "description": "items array", "nullable": true } } }, "DomainAnalyticsTechnologiesTechnologyStatsLiveItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "date": { "type": "string", "description": "date for which the data is provided", "nullable": true }, "domains_count": { "type": "integer", "description": "number of domains that use the specified technology", "format": "int64", "nullable": true }, "countries": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "distribution of websites by country\ncontains country codes and number of websites per country", "nullable": true }, "languages": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "distribution of websites by language\ncontains language codes and number of websites per language", "nullable": true }, "domains_rank": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "distribution of websites by backlink rank\ncontains domain rank ranges and number of websites per range\nlearn more about rank and how it is calculated in this help center article", "nullable": true } }, "description": "items array" }, "DomainAnalyticsErrorsRequestInfo": { "type": "object", "properties": { "limit": { "type": "integer", "description": "the maximum number of returned tasks that responded with an error\noptional field\ndefault value: 1000\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned tasks\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks", "nullable": true }, "filtered_function": { "type": "string", "description": "return tasks with a certain function\nuse this field to obtain a list of tasks that returned an error filtered by a certain function\nyou can filter the results by the values you receive in the function fields of the API response\ni.e., once you receive unfiltered results, you can call this API again to filter them by function\nexample: domain_analytics/task_get, postback_url, pingback_url", "nullable": true }, "datetime_from": { "type": "string", "description": "start time for filtering results\noptional field\nallows filtering results by the datetime parameter within the range of the last 7 days;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2021-11-15 12:57:46 +00:00", "nullable": true }, "datetime_to": { "type": "string", "description": "finish time for filtering results\noptional field\nallows filtering results by the datetime parameter within the range of the last 7 days;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2021-11-15 13:57:46 +00:00", "nullable": true } }, "example": [ { "limit": 10, "offset": 0, "filtered_function": "pingback_url" } ] }, "DomainAnalyticsTechnologiesDomainsByTechnologyLiveRequestInfo": { "type": "object", "properties": { "technology_paths": { "type": "array", "items": { "type": "string" }, "description": "target technology paths\nrequired field if you don\u2019t specify groups, technologies, keywords or categories\nat least one field (technology_paths, groups, technologies, keywords or categories) must be set;\neach technology path should be specified as a separate object containing \u201cpath\u201d and \u201cname\u201d, where \u201cpath\u201d is specified as \u201c$group_id.$category_id\u201d and \u201cname\u201d \u2013 as the name of the target technology;\neach object with a technology path should be separated with a comma\nyou can find the full list of technology group ids, category ids and technology names on this page\nnote: you can specify up to 10 technology paths in this array\nexample:\n[{\"path\": \"content.cms\",\"name\": \"wordpress\"}, {\"path\": \"marketing.crm\",\"name\": \"salesforce\"}]", "nullable": true }, "groups": { "type": "array", "items": { "type": "string" }, "description": "ids of the target technology groups\nrequired field if you don\u2019t specify technologies, technology_paths, keywords or categories\nyou can find the full list of technology group ids on this page\nnote: you can specify up to 10 technology groups in this array\nexample:\n[\"sales\", \"marketing\"]", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "description": "ids of the target technology categories\nrequired field if you don\u2019t specify groups, technology_paths, keywords or technologies\nyou can find the full list of technology category ids on this page\nnote: you can specify up to 10 technology categories in this array\nexample:\n[\"payment_processors\",\"crm\"]", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "target technologies\nrequired field if you don\u2019t specify groups, technology_paths, keywords or categories\nyou can find the full list of technologies you can specify here on this page\nnote: you can specify up to 10 technologies in this array\nexample:\n[\"Google Pay\",\"Salesforce\"]", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "target keywords in the domain\u2019s title, description or meta keywords\nrequired field if you don\u2019t specify groups, technology_paths, technologies or categories\noptional field\nyou can specify the maximum of 10 keywords;\nUTF-8 encoding;\nexample:\n[\"seo\",\"software\"]\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", "nullable": true }, "mode": { "type": "string", "description": "search mode\noptional field\npossible search mode types:\nas_is \u2013 search for results exactly matching the specified group ids, category ids, or technology names\nentry \u2013 search for results matching a part of the specified group ids, category ids, or technology names\ndefault value: as_is", "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:\n<, <=, >, >=, =, <>, 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[\"country_iso_code\",\"=\",\"US\"]\n[[\"country_iso_code\",\"=\",\"US\"],\n\"and\",\n[\"domain_rank\",\">\",100]]\n[[\"domain_rank\",\">\",100],\n\"and\",\n[[\"country_iso_code\",\"=\",\"US\"],\"or\",[\"country_iso_code\",\"=\",\"CA\"]]]\nfor more information about filters, please refer to Domain Analytics Technologies API \u2013 Filters", "nullable": true }, "order_by": { "type": "array", "items": { "type": "string" }, "description": "results sorting rules\noptional field\navailable fields:\ndomain_rank, domain, last_visited, country_iso_code, language_code, content_language_code\npossible sorting types:\nasc \u2013 results will be sorted in the ascending order\ndesc \u2013 results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"last_visited,desc\"]\ndefault rule:\n[\"domain_rank,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"last_visited,desc\",\"domain_rank,desc\"]", "nullable": true }, "limit": { "type": "integer", "description": "the maximum number of returned domains\noptional field\ndefault value: 100\nmaximum value: 10000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned domains\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains;\nNote: the maximum value is 9999, the sum of limit and offset must not exceed 10000;\nuse the offset_token if you would like to offset more results", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\noptional field\nprovided in the identical filed of the response to each request;\nuse this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;\nby specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task\nNote: if the offset_token is specified in the request, all other parameters should be identical to the previous request\nlearn more about this parameter on our Help Center", "nullable": true } }, "example": [ { "technologies": [ "Nginx" ], "filters": [ [ "country_iso_code", "=", "US" ], "and", [ "domain_rank", ">", 800 ] ], "order_by": [ "last_visited,desc" ], "limit": 10 } ] }, "DomainAnalyticsWhoisOverviewLiveRequestInfo": { "type": "object", "properties": { "limit": { "type": "integer", "description": "the maximum number of returned domainsoptional fielddefault value: 100maximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned itemsoptional fielddefault value: 0if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items;Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters should be identical to the previous requestlearn more about this parameter on our Help Center", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "nullable": true }, "description": "array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, <, <=, >, >=, =, <>, in, not_in, like, not_likeyou can use the % operator with like and not_like to match any string of zero or more characters", "nullable": true }, "order_by": { "type": "array", "items": { "type": "string" }, "description": "results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderthe comma is used as a separatorexample:[\"metrics.organic.pos_1,desc\"]default rule:[\"metrics.organic.count,desc\"]note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:[\"expiration_datetime,asc\",\"metrics.organic.etv,desc\",\"metrics.organic.pos_1,desc\"]", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "limit": 2, "filters": [ [ "epp_status_codes", "in", [ "client_transfer_prohibited", "client_update_prohibited" ] ] ] } ] }, "DomainAnalyticsTechnologiesAggregationTechnologiesLiveRequestInfo": { "type": "object", "properties": { "group": { "type": "string", "description": "id of the target technology group\nrequired field if you don\u2019t specify technology, category or keyword\nat least one field (group, category, keyword, technology) must be set\nyou can find the full list of technology group ids on this page\nexample:\n\"marketing\"", "nullable": true }, "category": { "type": "string", "description": "id of the target technology category\nrequired field if you don\u2019t specify group, keyword or technology\nat least one field (group, category, keyword, technology) must be set\nyou can find the full list of technology category ids on this page\nexample:\n\"crm\"", "nullable": true }, "technology": { "type": "string", "description": "target technology\nrequired field if you don\u2019t specify group, keyword or category\nat least one field (group, category, keyword, technology) must be set\nyou can find the full list of technologies on this page\nexample:\n\"Salesforce\"", "nullable": true }, "keyword": { "type": "string", "description": "target keyword in the domain\u2019s meta keywords\nrequired field if you don\u2019t specify group, category or technology\nat least one field (group, category, keyword, technology) must be set\nUTF-8 encoding\nexample:\n\"seo\"learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", "nullable": true }, "mode": { "type": "string", "description": "search mode\noptional field\npossible search mode types:\nas_is \u2013 search for results exactly matching the specified group ids, category ids, or technology names\nentry \u2013 search for results matching a part of the specified group ids, category ids, or technology names\ndefault value: as_is", "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:\n<, <=, >, >=, =, <>, 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\nyou can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code\nNote: all filtering parameters are taken from the domain_technology_item of the domain_technologies endpoint;\nexample:\n[[\"country_iso_code\",\"=\",\"US\"],\n\"and\",\n[\"domain_rank\",\">\",800]]for more information about filters, please refer to Domain Analytics Technologies API \u2013 Filters", "nullable": true }, "order_by": { "type": "array", "items": { "type": "string" }, "description": "results sorting rules\noptional field\nyou can use the following values to sort the results: groups_count, categories_count, technologies_count\npossible sorting types:\nasc \u2013 results will be sorted in the ascending order\ndesc \u2013 results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"groups_count,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"groups_count,desc\",\"technologies_count,desc\"]\ndefault value:\n[\"groups_count,desc\",\"categories_count,desc\",\"technologies_count,desc\"]", "nullable": true }, "internal_groups_list_limit": { "type": "integer", "description": "maximum number of returned technology groups\noptional field\nyou can use this field to limit the number of items with identical \"group\" in the results\ndefault value: 5\nminimum value: 1\nmaximum value: 10000", "nullable": true }, "internal_categories_list_limit": { "type": "integer", "description": "maximum number of returned technology categories within the same group\noptional field\nyou can use this field to limit the number of items with identical \"category\" in the results\ndefault value: 5\nminimum value: 1\nmaximum value: 10000", "nullable": true }, "internal_technologies_list_limit": { "type": "integer", "description": "maximum number of returned technologies within the same category\noptional field\nyou can use this field to limit the number of items with identical \"technology\" in the results\ndefault value: 10\nminimum value: 1\nmaximum value: 10000", "nullable": true }, "internal_list_limit": { "type": "integer", "description": "maximum number of items with identical \"category\", \"group\", and \"technology\"\noptional field\nif you use this field, the values specified in internal_groups_list_limit, internal_categories_list_limit and internal_technologies_list_limit will be ignored;\nyou can use this field to limit the number of items with identical \"category\", \"group\", or \"technology\"\ndefault value: 10\nminimum value: 1\nmaximum value: 10000", "nullable": true }, "limit": { "type": "integer", "description": "the maximum number of returned technologies\noptional field\ndefault value: 100\nmaximum value: 10000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned domains\noptional field\ndefault value: 0\nmaximum value: 9999\nif you specify the 10 value, the first ten technologies in the results array will be omitted and the data will be provided for the successive technologies", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "mode": "entry", "technology": "Nginx", "keyword": "WordPress", "filters": [ [ "country_iso_code", "=", "US" ], "and", [ "domain_rank", ">", 800 ] ], "order_by": [ "groups_count,desc" ], "limit": 10 } ] }, "DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveRequestInfo": { "type": "object", "properties": { "search_terms": { "type": "array", "items": { "type": "string" }, "description": "target search terms\nrequired field\nspecify target HTML elements, tags, attributes, their content or all of the above\nif you specify more than one search term, you will receive only the domains containing all of the specified terms in the HTML code of their homepage\nmaximum number of search terms you can specify: 10\nexample:\n[\"data-attrid\"]" }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "target keywords in the domain\u2019s title, description or meta keywords\noptional field\nUTF-8 encoding\nmaximum number of keywords you can specify: 10\nexample:\n[\"seo\",\"software\"]\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", "nullable": true }, "mode": { "type": "string", "description": "search mode\noptional field\npossible search mode types:\nstrict_entry \u2013 search for results exactly matching the order, intervals and separators in the specified search terms\nentry \u2013 search for results ignoring the order, intervals and separators in the specified search terms\ndefault value: entry", "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:\n<, <=, >, >=, =, <>, 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[\"domain\",\"like\",\"%seo%\"]\n[[\"country_iso_code\",\"=\",\"US\"],\n\"and\",\n[\"domain_rank\",\">\",100]]\n[[\"domain_rank\",\">\",100],\n\"and\",\n[[\"country_iso_code\",\"=\",\"US\"],\"or\",[\"country_iso_code\",\"=\",\"CA\"]]]\nfor more information about filters, please refer to Domain Analytics Technologies API \u2013 Filters", "nullable": true }, "order_by": { "type": "array", "items": { "type": "string" }, "description": "results sorting rules\noptional field\navailable fields:\ndomain_rank, domain, last_visited, country_iso_code, language_code, content_language_code\npossible sorting types:\nasc \u2013 results will be sorted in the ascending order\ndesc \u2013 results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"last_visited,desc\"]\ndefault rule:\n[\"domain_rank,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"last_visited,desc\",\"domain_rank,desc\"]", "nullable": true }, "limit": { "type": "integer", "description": "the maximum number of returned domains\noptional field\ndefault value: 100\nmaximum value: 10000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned domains\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains;\nNote: the maximum value is 9999, the sum of limit and offset must not exceed 10000;\nuse the offset_token if you would like to offset more results", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\noptional field\nprovided in the identical filed of the response to each request;\nuse this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;\nby specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task\nNote: if the offset_token is specified in the request, all other parameters should be identical to the previous request\nlearn more about this parameter on our Help Center", "nullable": true } }, "example": [ { "search_terms": [ "data-attrid" ], "order_by": [ "last_visited,desc" ], "limit": 10, "offset": 0 } ] }, "DomainAnalyticsIdListResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsIdListTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsIdListTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsIdListResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsIdListResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the task", "nullable": true }, "url": { "type": "string", "description": "URL of the task\nURL you used for making an API call", "nullable": true }, "datetime_posted": { "type": "string", "description": "date and time when the task was made\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00", "nullable": true }, "datetime_done": { "type": "string", "description": "date and time when the task was completed\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00", "nullable": true }, "status": { "type": "string", "description": "informational message of the task\nyou can find the full list of general informational messages here", "nullable": true }, "cost": { "type": "number", "description": "cost of the task, USD", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "object", "nullable": true }, "description": "contains parameters you specified in the POST request", "nullable": true } } }, "DomainAnalyticsTechnologiesAggregationTechnologiesLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesAggregationTechnologiesLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesAggregationTechnologiesLiveResultInfo": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "total amount of results in our database relevant to your request", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of results returned in the items array", "format": "int64", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned domains", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem" } ], "nullable": true }, "description": "items array", "nullable": true } } }, "DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "group": { "type": "string", "description": "technology group id", "nullable": true }, "category": { "type": "string", "description": "technology category id", "nullable": true }, "technology": { "type": "string", "description": "technology name", "nullable": true }, "groups_count": { "type": "integer", "description": "technology groups count\nnumber of domains that match the parameters you specified and are using technologies from the indicated group", "format": "int64", "nullable": true }, "categories_count": { "type": "integer", "description": "technology categories count\nnumber of domains that match the parameters you specified and are using technologies from the indicated category", "format": "int64", "nullable": true }, "technologies_count": { "type": "integer", "description": "technologies count\nnumber of domains that match the parameters you specified and are using the indicated technology", "format": "int64", "nullable": true } }, "description": "items array" }, "DomainAnalyticsWhoisOverviewLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsWhoisOverviewLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsWhoisOverviewLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsWhoisOverviewLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsWhoisOverviewLiveResultInfo": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "total amount of results in our database relevant to your request", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of results returned in the items array", "format": "int64", "nullable": true }, "offset": { "type": "integer", "description": "results offset value specified in POST request", "nullable": true }, "offset_token": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsWhoisOverviewLiveItem" } ], "nullable": true }, "description": "contains ranking and traffic data", "nullable": true } } }, "DomainAnalyticsWhoisOverviewLiveItem": { "type": "object", "properties": { "domain": { "type": "string", "description": "domain name", "nullable": true }, "created_datetime": { "type": "string", "description": "date and time of registrationdate and time (in the ISO 8601 format) when the domain was first registered example: \"1997-03-29 03:00:00 +00:00\"", "nullable": true }, "changed_datetime": { "type": "string", "description": "date and time when the domain entry was changeddate and time (in the ISO 8601 format) when the domain entry was last modifiedexample: \"2021-01-14 08:36:28 +00:00\"", "nullable": true }, "expiration_datetime": { "type": "string", "description": "date and time when the domain will expiredate and time (in the ISO 8601 format) when the domain is due to expire example: \"2022-11-26 17:21:23 +00:00\"", "nullable": true }, "updated_datetime": { "type": "string", "description": "date and time when the domain was updateddate and time (in the ISO 8601 format) when the domain was last updated example: \"2021-01-29 13:59:38 +00:00\"", "nullable": true }, "first_seen": { "type": "string", "description": "date and time when our crawler found the domain for the first timein the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201dexample: \"2019-11-15 12:57:46 +00:00\"", "nullable": true }, "epp_status_codes": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "extensive provisioning protocol status codesthe status of a domain name registration as defined by ICANN", "nullable": true }, "tld": { "type": "string", "description": "top-level domaintop-level domain in the DNS root zone", "nullable": true }, "registered": { "type": "boolean", "description": "domain registration statusif false, the domain name registration has expiredNote: expired domains will remain in the database for only a short period of time", "nullable": true }, "registrar": { "type": "string", "description": "domain registrarif null, the domain registrar is unknownexample:NameCheap, Inc.", "nullable": true }, "metrics": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MetricsBundleInfo" } ], "description": "ranking data relevant to the specified domain", "nullable": true }, "backlinks_info": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BacklinksInfo" } ], "description": "backlink data for the returned domain", "nullable": true } }, "description": "items array" }, "BacklinksInfo": { "type": "object", "properties": { "referring_domains": { "type": "integer", "description": "number of referring domains\nreferring domains include subdomains that are counted as separate domains for this metric", "format": "int64", "nullable": true }, "referring_main_domains": { "type": "integer", "description": "number of referring main domains", "format": "int64", "nullable": true }, "referring_pages": { "type": "integer", "description": "number of pages pointing to the target website", "format": "int64", "nullable": true }, "dofollow": { "type": "integer", "description": "number of dofollow links", "format": "int64", "nullable": true }, "backlinks": { "type": "integer", "description": "total number of backlinks\nthe total number of backlinks, including dofollow and nofollow links", "format": "int64", "nullable": true }, "time_update": { "type": "string", "description": "date and time when backlink data was updated\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true } } }, "MetricsBundleInfo": { "type": "object", "properties": { "organic": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MetricsInfo" } ], "properties": { "is_new": { "type": "integer", "description": "number of new ranked elements\nindicates how many new ranked elements were found for this domain", "format": "int64", "nullable": true }, "is_up": { "type": "integer", "description": "rank went up\nindicates how many ranked elements of this domain went up in Google Search", "format": "int64", "nullable": true }, "is_down": { "type": "integer", "description": "rank went down\nindicates how many ranked elements of this domain went down in Google Search", "format": "int64", "nullable": true }, "is_lost": { "type": "integer", "description": "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren\u2019t found during the last check", "format": "int64", "nullable": true } }, "description": "ranking and traffic data from organic search", "nullable": true }, "paid": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MetricsInfo" } ], "description": "ranking and traffic data from paid search", "nullable": true } } }, "MetricsInfo": { "type": "object", "properties": { "pos_1": { "type": "integer", "description": "number of organic SERPs where the domain ranks #1", "nullable": true }, "pos_2_3": { "type": "integer", "description": "number of organic SERPs where the domain ranks #2-3", "nullable": true }, "pos_4_10": { "type": "integer", "description": "number of organic SERPs where the domain ranks #4-10", "nullable": true }, "pos_11_20": { "type": "integer", "description": "number of organic SERPs where the domain ranks #11-20", "nullable": true }, "pos_21_30": { "type": "integer", "description": "number of organic SERPs where the domain ranks #21-30", "nullable": true }, "pos_31_40": { "type": "integer", "description": "number of organic SERPs where the domain ranks #31-40", "nullable": true }, "pos_41_50": { "type": "integer", "description": "number of organic SERPs where the domain ranks #41-50", "nullable": true }, "pos_51_60": { "type": "integer", "description": "number of organic SERPs where the domain ranks #51-60", "nullable": true }, "pos_61_70": { "type": "integer", "description": "number of organic SERPs where the domain ranks #61-70", "nullable": true }, "pos_71_80": { "type": "integer", "description": "number of organic SERPs where the domain ranks #71-80", "nullable": true }, "pos_81_90": { "type": "integer", "description": "number of organic SERPs where the domain ranks #81-90", "nullable": true }, "pos_91_100": { "type": "integer", "description": "number of organic SERPs where the domain ranks #91-100", "nullable": true }, "etv": { "type": "number", "description": "estimated traffic volumeestimated organic monthly traffic to the domaincalculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks forlearn more about how the metric is calculated in this help center article", "nullable": true }, "count": { "type": "integer", "description": "total count of organic SERPs that contain the domain", "format": "int64", "nullable": true }, "estimated_paid_traffic_cost": { "type": "number", "description": "estimated cost of converting organic search traffic into paidrepresents the estimated monthly cost of running ads (USD) for all keywords a domain ranks forthe metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Searchlearn more about how the metric is calculated in this help center article", "nullable": true }, "is_new": { "type": "integer", "description": "number of new ranked elements\nindicates how many new ranked elements were found for this domain", "format": "int64", "nullable": true }, "is_up": { "type": "integer", "description": "rank went up\nindicates how many ranked elements of this domain went up in Google Search", "format": "int64", "nullable": true }, "is_down": { "type": "integer", "description": "rank went down\nindicates how many ranked elements of this domain went down in Google Search", "format": "int64", "nullable": true }, "is_lost": { "type": "integer", "description": "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren\u2019t found during the last check", "format": "int64", "nullable": true } } }, "DomainAnalyticsTechnologiesTechnologyStatsLiveRequestInfo": { "type": "object", "properties": { "technology": { "type": "string", "description": "target technology\nrequired field\nyou can find the full list of technologies you can specify here on this page\nexample:\n\"Salesforce\"" }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimum value: 2022-10-31\nif you don\u2019t specify this field, the minimum value will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2023-06-01\"", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, the today\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2023-01-15\"", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "technology": "jQuery", "date_from": "2026-01-15", "date_to": "2026-03-15" } ] }, "DomainAnalyticsTechnologiesLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DomainAnalyticsTechnologiesLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "DomainAnalyticsTechnologiesLanguagesResultInfo": { "type": "object", "properties": { "language_name": { "type": "string", "description": "language name", "nullable": true }, "language_code": { "type": "string", "description": "language code according to ISO 639-1", "nullable": true } } } } }