learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationChatGptLlmResponsesLiveRequestInfo": {
"properties": {
"force_web_search": {
"description": "force AI agent to use web search
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
Note #2: not supported in reasoning models",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value for reasoning models (e.g., reasoning is true in the Models endpoint): 1024;
minimum value for non-reasoning models: 16;
maximum value: 4096;
default value: 2048
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_LlmMessageChainItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gpt-4.1 is specified, the gpt-4.1-2025-04-14 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behaviour
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 2
default value: 0.94
Note: not supported in reasoning models",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: 0.92
Note: top_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search
optional field
when enabled, the AI model can access and cite current web information;
default value: false;
Note: refer to the Models endpoint for a list of models that support web_search;",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location
optional field
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model will search the web from the country you specify;
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationChatGptLlmResponsesTaskPostRequestInfo": {
"properties": {
"force_web_search": {
"description": "force AI agent to use web search
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
Note #2: not supported in reasoning models",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value for reasoning models (e.g., reasoning is true in the Models endpoint): 1024;
minimum value for non-reasoning models: 16;
maximum value: 4096;
default value: 2048",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_LlmMessageChainItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gpt-4.1 is specified, the gpt-4.1-2025-04-14 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special character in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special character in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"system_message": {
"description": "instructions for the AI behaviour
optional field
defines the AI's role, tone, or specific behavior;
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data array of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 2
default value: 0.94
Note: not supported in reasoning models",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: 0.92
Note: top_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search
optional field
when enabled, the AI model can access and cite current web information;
default value: false;
Note: refer to the Models endpoint for a list of models that support web_search;",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location
optional field
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model will search the web from the country you specify;
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationChatGptLlmScraperLiveAdvancedRequestInfo": {
"properties": {
"force_web_search": {
"description": "force AI agent to use web search
optional field
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationChatGptLlmScraperLiveHtmlRequestInfo": {
"properties": {
"expand_citations": {
"description": "return expanded citation bar in HTML results
optional field
to enable this parameter, force_web_search must also be enabled;
when enabled, the endpoint will return HTML data from the expanded citation bar;
default value: false",
"type": [
"boolean",
"null"
]
},
"force_web_search": {
"description": "force AI agent to use web search
optional field
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/locations
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/locations
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationChatGptLlmScraperTaskPostRequestInfo": {
"properties": {
"expand_citations": {
"description": "return expanded citation bar in HTML results
optional field
to enable this parameter, force_web_search must also be enabled;
when enabled, the HTML endpoint will return data from the expanded citation bar;
default value: false",
"type": [
"boolean",
"null"
]
},
"force_web_search": {
"description": "force AI agent to use web search
optional field
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languagesn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationClaudeLlmResponsesLiveRequestInfo": {
"properties": {
"force_web_search": {
"description": "force AI agent to use web search
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value: 1;
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1025",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_LlmMessageChainItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if claude-opus-4-0 is specified, the claude-opus-4-20250514 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/claude/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behaviour
optional field
defines the AI's role, tone, or specific behavior;
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 1
default value: 0.7
Note: temperature cannot be used together with top_p in the same request",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: null
Note: top_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1025
Note #2: if set to true, force_web_search must be set to false
Note #3: if set to true, the temperature and top_p cannot be used",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location used for searching the web
optional field
",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location used for searching the web
optional field
possible values: 'AR','AT','AU','BE','BR','CA','CH','CL','CN','DE','DK','ES','FI','FR','GB','HK','ID','IN','IT','JP','KR','MX','MY','NL','NO','NZ','PH','PL','PT','RU','SA','SE','TR','TW','US','ZA'",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationClaudeLlmResponsesTaskPostRequestInfo": {
"properties": {
"force_web_search": {
"description": "force AI agent to use web search
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value: 1;
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1025",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_LlmMessageChainItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if claude-opus-4-0 is specified, the claude-opus-4-20250514 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/claude/llm_responses/models",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special character in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special character in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"system_message": {
"description": "instructions for the AI behaviour
optional field
defines the AI's role, tone, or specific behavior;
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 1
default value: 0.7
Note: temperature cannot be used together with top_p in the same request",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: null
Note: top_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1025
Note #2: if set to true, force_web_search must be set to false
Note #3: if set to true, the temperature and top_p cannot be used",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location used for searching the web
optional field
",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location used for searching the web
optional field
possible values: 'AR','AT','AU','BE','BR','CA','CH','CL','CN','DE','DK','ES','FI','FR','GB','HK','ID','IN','IT','JP','KR','MX','MY','NL','NO','NZ','PH','PL','PT','RU','SA','SE','TR','TW','US','ZA'",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationGeminiLlmResponsesLiveRequestInfo": {
"properties": {
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value: 1
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1024",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_LlmMessageChainItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gemini-1.5-pro is specified, the gemini-1.5-pro-002 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behavior
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse
lower values make output more focused
minimum value: 0
maximum value: 2
default value: 1.3",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection
minimum value: 0
maximum value: 1
default value: 0.9",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1024
Note #2: for Gemini Pro models, the use_reasoning will automatically be set to true",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationGeminiLlmResponsesTaskPostRequestInfo": {
"properties": {
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value: 1;
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1024",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_LlmMessageChainItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gemini-1.5-pro is specified, the gemini-1.5-pro-002 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special character in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special character in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"system_message": {
"description": "instructions for the AI behavior
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse
lower values make output more focused
minimum value: 0
maximum value: 2
default value: 1.3",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection
minimum value: 0
maximum value: 1
default value: 0.9",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1024
Note #2: for Gemini Pro models, the use_reasoning will automatically be set to true",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationGeminiLlmScraperLiveAdvancedRequestInfo": {
"properties": {
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example: enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example: English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "
GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_code
location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199 (mm)
the maximum value for \"radius\": 199999 (mm)
example:
53.476225,-2.243572,200
location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locationsUnited States",
"type": "string"
},
"tag": {
"description": "user-defined task identifiertag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationGeminiLlmScraperLiveHtmlRequestInfo": {
"properties": {
"expand_citations": {
"description": "return expanded citation bar in HTML resultsfalse",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keywordkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "
GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_code
location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199 (mm)
the maximum value for \"radius\": 199999 (mm)
example:
53.476225,-2.243572,200
location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locationsUnited States",
"type": "string"
},
"tag": {
"description": "user-defined task identifiertag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationGeminiLlmScraperTaskPostRequestInfo": {
"properties": {
"expand_citations": {
"description": "return expanded citation bar in HTML resultsfalse",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keywordkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "
GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_code
location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199 (mm)
the maximum value for \"radius\": 199999 (mm)
example:
53.476225,-2.243572,200
location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locationsUnited States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search language code default value: default value: you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: you can add several filters at once (8 filters maximum) the full list of possible filters is available here. The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_brand_categories": {
"description": "array of brand categories to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_brand_categories": {
"description": "array of brand_categories to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_brands": {
"description": "array of brands to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_brands": {
"description": "array of brands to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_domains": {
"description": "array of domains to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_domains": {
"description": "array of domains to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_pages": {
"description": "array of page URLs to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_pages": {
"description": "array of pages to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority you can receive the list of available filters_by making a separate request to note that you can set no more than three sorting rules in a single request Your account will be billed per each SERP containing up to 25 results; learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority you can receive the list of available filters_by making a separate request to note that you can set no more than three sorting rules in a single request learn more about rules and limitations of default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the default value: default value: default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests default value: today's date -(minus) one month; date format: default value: today's date -(minus) one month; date format: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned domains you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: default value: default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier minimum value: note: for for example, if you specify: if there is no data for a certain minimum value: note: for for example, if you specify: if there is no data for a certain you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier Note: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API",
"type": "string"
},
"depth": {
"description": "parsing depth Your account will be billed per each SERP containing up to 20 results; learn more about rules and limitations of Note: if you use this field, your account will be charged three times the standard rate for tasks involving the Google Reviews API",
"type": "string"
},
"language_code": {
"description": "search engine language code learn more on our Help Center",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "identifier of the business entity in Google Maps Note: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority set the following value if you want to include one 14-years-old child: set the following value if you want to include one 14-years-old child: set the following value if you want to include one 14-years-old child: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"prices_date_range": {
"description": "predefined period for retrieving daily price data learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority this field can also be used to pass the following parameters: example: learn more about the learn more about rules and limitations of this field can also be used to pass the following parameters: example: learn more about the learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about the learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority this field can also be used to pass the following parameters: example: learn more about the learn more about rules and limitations of this field can also be used to pass the following parameters: example: learn more about the learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "identifier of the business entity in Google Maps learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority Your account will be billed per each SERP containing up to 30 results; learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority [\"content_info.text_category\",\"has\",10994]]] you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works in this Help Center article",
"type": [
"string",
"null"
]
},
"search_mode": {
"description": "results grouping type [\"content_info.text_category\",\"has\",10994]]] learn more about rules and limitations of you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works in this Help Center article",
"type": [
"string",
"null"
]
},
"search_mode": {
"description": "results grouping type [\"content_info.text_category\",\"has\",10994]]] learn more about rules and limitations of you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works in this Help Center article",
"type": [
"string",
"null"
]
},
"search_mode": {
"description": "results grouping type [\"content_info.text_category\",\"has\",10994]]] learn more about rules and limitations of you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works in this Help Center article",
"type": [
"string",
"null"
]
},
"search_mode": {
"description": "results grouping type [\"content_info.text_category\",\"has\",10994]]] learn more about rules and limitations of you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works in this Help Center article",
"type": [
"string",
"null"
]
},
"sentiments_connotation_threshold": {
"description": "sentiment connotation threshold learn more about rules and limitations of for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"intersection_mode": {
"description": "mode for finding asin intersections Note: all letters in ASIN code must be specified in uppercase format; for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords learn more about rules and limitations of for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code default rule: for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code default rule: for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code learn more about rules and limitations of Note: if the possible values: learn more about how clickstream-based metrics are calculated in this help center articlen",
"type": [
"boolean",
"null"
]
},
"include_subcategories": {
"description": "indicates if the subcategories will be included in the search Note: if the possible values: default rule: learn more about rules and limitations of example: for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords learn more about how clickstream-based metrics are calculated in this help center articlen",
"type": [
"boolean",
"null"
]
},
"intersecting_domains": {
"description": "additional domains for improving results accuracy Note: if the possible values: if you specify default rule: Note: if the possible values: note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them learn more about rules and limitations of Note: historical clickstream data is available from 2024/05 (May, 2024); [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword learn more about rules and limitations of default rule: note that you can set no more than three sorting rules in a single request learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them learn more about rules and limitations of learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_seed_keyword": {
"description": "include data for the seed keyword learn more about rules and limitations of for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword default rule: if you want to get the keywords a particular webpage ranks for, you can use a learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "display results by item type Note: if the possible values: number of the returned results depends on the value you set in this field [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] learn more about rules and limitations of example: learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "display results by item type Note: if the possible values: default rule: learn more about rules and limitations of possible values: learn more about rules and limitations of learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "display results by item type Note: if the possible values: default rule: [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword for more information about filters, please refer to Domain Analytics Technologies API - Filters",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"keywords": {
"description": "target keywords in the domain's title, description or meta keywords learn more about rules and limitations of for more information about filters, please refer to Domain Analytics Technologies API - Filters",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"groups": {
"description": "ids of the target technology groups learn more about rules and limitations of for more information about filters, please refer to Domain Analytics Technologies API - Filters",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"groups": {
"description": "ids of the target technology groups learn more about rules and limitations of if you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries example: if you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions example: if you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries example: if you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions example: learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"device": {
"description": "device type learn more about rules and limitations of Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"device": {
"description": "device type learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "Bing search partners type Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"device": {
"description": "device type Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"device": {
"description": "device type learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "Bing search partners type date format: Note 2: if if you specify the with value Note: we do not recommend using a custom time range Note 2: if if you specify the with value default value: Note: we do not recommend using a custom time range Note 2: if if you specify the with value minimum value: two years back from today’s date; Note: we do not recommend using a custom time range Note 2: if if you specify the with value learn more about rules and limitations of possible values: default value: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"device": {
"description": "device type learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "Bing search partners type learn more about rules and limitations of Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"sort_by": {
"description": "results sorting parameters learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners Note: to obtain Note: keywords cannot consist of a combination of the following characters: Note: to obtain learn more about rules and limitations of Note: to obtain Note: keywords cannot consist of a combination of the following characters: Note: to obtain learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"price_max": {
"description": "maximum product price learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"price_max": {
"description": "maximum product price learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority possible values: Note: to use this parameter, set Note: to use this parameter, set minimum value, in pixels: Note: to use this parameter, set minimum value: Note: to use this parameter, set minimum value, in pixels: if you use this field, note: you can set up to 1000 The full list of possible filters is available by this link.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the task if you ignore this field, we will return data for all audits; Note: that some audits do not belong to a specific category and are stand-alone page quality measurements; in general, there can be several use cases: 1. if you ignore 2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified you can get the full list of possible audits here",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"browser_cpu_throttling_multiplier": {
"description": "browser CPU throttling multiplier if you ignore this field, we will return data for all categories unless you specify possible values: note that some audits do not belong to a specific category and are stand-alone page quality measurements in general, there can be several use cases: 1. if you ignore 2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified you can get the full list of possible audits here",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"browser_cpu_throttling_multiplier": {
"description": "browser CPU throttling multiplier possible values: The full list of possible filters is available by this link.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the task The full list of possible filters is available by this link.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the task possible values: Note: in this endpoint, the minimum value, in pixels: minimum value: minimum value, in pixels: The full list of possible filters is available by this link.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the task the following filtering parameter is supported: examples: The full list of possible filters is available by this link.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the task learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority_urls": {
"description": "urls to be crawled bypassing the queue The full list of possible filters is available by this link.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the task learn more about rules and limitations of example: example: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: provider usage may increase for using this parameter parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: target match type required field if type of match for the possible values: target domain, subdomain, or wildcard value required field if specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: page crawl limit optional field number of search results pages to crawl default value: max value: Note: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified target domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without note that the results of you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: target match type required field if type of match for the possible values: target domain, subdomain, or wildcard value required field if specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: page crawl limit optional field number of search results pages to crawl default value: max value: Note: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: target match type required field if type of match for the possible values: target domain, subdomain, or wildcard value required field if specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: page crawl limit optional field number of search results pages to crawl default value: max value: Note: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified target domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without note that the results of you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: provider usage may increase for using this parameter parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: target match type required field if type of match for the possible values: target domain, subdomain, or wildcard value required field if specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: page crawl limit optional field number of search results pages to crawl default value: max value: Note: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"search_param": {
"description": " additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine location code optional field if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: Note: if you don't specify GPS coordinates of a location optional field if you use this field, you don't need to specify example: Note: if you don't specify full name of search engine location optional field if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: Note: if you don't specify notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the function you used for setting a task possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified advertiser identifiers required field if you can specify the maximum of 25 values in this array; starting date of the time range optional field required field if date format: minimum value: 2018-05-31 maximum value: today's date example: ending date of the time range optional field required field if date format: minimum value: 2018-05-31 maximum value: today's date example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 40 may result in additional charges if the search engine returns more than 40 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"format": {
"description": " ad format optional field possible values: search engine location code optional field if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: Note: if you don't specify GPS coordinates of a location optional field if you use this field, you don't need to specify example: Note: if you don't specify full name of search engine location optional field if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: Note: if you don't specify notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center advertising platform optional field possible values: default value: postback_url datatype required field if you specify corresponds to the function you used for setting a task possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified domain name required field if domain name associated with an advertiser account browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: if set to device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their Note: check Google Search Help for the list of countries where AI Mode is currently available GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their Note: check Google Search Help for the list of countries where AI Mode is currently available device operating system optional field if you specify default value: if you specify default value: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: if set to device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their Note: check Google Search Help for the list of countries where AI Mode is currently available GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their Note: check Google Search Help for the list of countries where AI Mode is currently available device operating system optional field if you specify default value: if you specify default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the function you used for setting a task possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified search client for autocomplete optional field autocomplete results may differ depending on the search client; possible values: search bar cursor pointer optional field the horizontal numerical position of the cursor pointer within the keyword in the search bar; by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword; minimal value: default value: the number of the last character of the specified example: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified search client for autocomplete optional field autocomplete results may differ depending on the search client; possible values: search bar cursor pointer optional field the horizontal numerical position of the cursor pointer within the keyword in the search bar; by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword; minimal value: default value: the number of the last character of the specified example: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.e., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default); 2 – high execution priority The cost can be calculated on the Pricing page",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified ID of the dataset required field you can find dataset ID in the dataset URL or example: device type optional field return results for a specific device type possible value: search engine language code optional field if you use this field, you don't need to specify possible value: full name of search engine language optional field if you use this field, you don't need to specify possible value: device operating system optional field possible values: default value: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified ID of the dataset required field you can find dataset ID in the dataset URL or example: device type optional field return results for a specific device type possible value: search engine language code optional field if you use this field, you don't need to specify possible value: full name of search engine language optional field if you use this field, you don't need to specify possible value: device operating system optional field choose from the following values: default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible value: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified parsing depth optional field number of results in SERP default value: max value: Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type possible value: file formats of the dataset optional field possible values: indicates whether displayed datasets are free optional field possible values: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code optional field if you don't specify if you use this field, you don't need to specify possible value: full name of search engine language optional field if you use this field, you don't need to specify possible value: last time the dataset was updated optional field possible values: device operating system optional field choose from the following values: default value: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified dataset topics optional field possible values: usage rights of the dataset optional field possible values: parsing depth optional field number of results in SERP default value: max value: Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type possible value: file formats of the dataset optional field possible values: indicates whether displayed datasets are free optional field possible values: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code optional field possible value: full name of search engine language optional field if you use this field, you don't need to specify possible value: last time the dataset was updated optional field possible values: device operating system optional field possible values: default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server only value: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified dataset topics optional field possible values: usage rights of the dataset optional field possible values: device type optional field return results for a specific device type possible value: search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: financial news filters optional field possible values: default value: Note: if you specify device operating system optional field possible values: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified device type optional field possible value: search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: financial news filters optional field possible values: default value: device operating system optional field possible values: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified device type optional field return results for a specific device type possible value: search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: financial news filters optional field possible values: default value: Note: if you specify device operating system optional field possible values: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values:: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default); 2 – high execution priority The cost can be calculated on the Pricing page",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified device type optional field return results for a specific device type possible value: search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: type of google finance market optional field possible values: default value: device operating system optional field possible values: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified device type optional field possible value: search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: type of google finance market optional field possible values: default value: device operating system optional field possible values: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified device type optional field return results for a specific device type possible value: search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: type of google finance market optional field possible values: default value: device operating system optional field possible values: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values:: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default); 2 – high execution priority The cost can be calculated on the Pricing page",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified device type optional field return results for a specific device type possible value: ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: device operating system optional field possible values: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified time window for optional field possible values: default value: Note: if you specify a value that is different from device type optional field return results for a specific device type possible value: ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: device operating system optional field possible values: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified time window for optional field possible values: default value: device type optional field return results for a specific device type possible value: ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: device operating system optional field possible values: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values:: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default); 2 – high execution priority The cost can be calculated on the Pricing page",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified time window for optional field possible values: default value: Note: if you specify a value that is different from category of financial instruments to search for optional field possible values: default value: company or financial instrument name required field in this field, you can enter the name of a company or financial instrument to search for relevant tickers; you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified category of financial instruments to search for optional field possible values: default value: company or financial instrument name required field in this field, you can enter the name of a company or financial instrument to search for relevant tickers; you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values:: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default); 2 – high execution priority The cost can be calculated on the Pricing page",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified parsing depth optional field number of results in SERP default value: max value: Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": " keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field note that this API provides results for desktop only choose from the following values: default value: search engine domain optional field We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field example: additional parameters of the search query optional field Get the list of available parameters and additional details here. user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": " keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field note that this API provides results for desktop only choose from the following values: default value: search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": " keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field note that this API provides results for desktop only choose from the following values: default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": " search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP; default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"employment_type": {
"description": " employment contract type optional field type of employment contract for which the search results will be returned; possible values: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your Note: the keyword you specify must indicate the job title; example: learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify you can receive the list of available locations of the search engines with their example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: location search radius optional field location search radius in kilometers; Note: for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by if value is not specified, search is executed anywhere within the specified location; maximal value: minimal value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default); 2 – high execution priority The cost can be calculated on the Pricing page",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results respectively; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: device operating system optional field if you specify default value: if you specify default value: task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: filter results by minimum rating optional field possible values for possible values for device operating system optional field if you specify default value: if you specify default value: user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified filter results by open hours optional field using this field, you can filter places in the results by the time a place is open for visitors note that Google may also provide results that do not match this filter possible values: instead of instead of example: parsing depth optional field number of results in SERP default value: max value: If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically device type optional field return results for a specific device type can take the values: default value: keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: device operating system optional field if you specify default value: if you specify default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the function you used for setting a task possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": " user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified parsing depth optional field number of results in SERP default value: max value: Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: note: for keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify if \"zoom\" is not specified, 17z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 3z the maximum value for \"zoom\": 21z example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: search places mode optional field the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York) however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request; to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to default value: Note: if the show results from the displayed area optional field can take the values: default value: if set to Note: if the user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: note: for keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify if \"zoom\" is not specified, 17z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 3z the maximum value for \"zoom\": 21z example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the function you used for setting a task possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": " search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: search places mode optional field the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York) however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request; to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to Note: if the show results from the displayed area optional field can take the values: default value: if set to Note: if the user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: if set to parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": " keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field note that this API provides results for desktop only choose from the following values: default value: search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field Get the list of available parameters and additional details here. direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": " keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field note that this API provides results for desktop only choose from the following values: default value: search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: if set to parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": " keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center device operating system optional field note that this API provides results for desktop only choose from the following values: default value: notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": " search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields; Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method; example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: expand ai overview optional field set to default value: SERP element types to check for targets optional field to enable this parameter, specifies which SERP element types should be checked for target matches if not specified, all first-level elements with possible values: Note: cannot contain the same element types as example: learn more about this parameter on our Help Center SERP element types to exclude from target search optional field to enable this parameter, specifies which SERP element types should be excluded when searching for target matches possible values: Note: cannot contain the same element types as example: learn more about this parameter on our Help Center keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5",
"type": "string"
},
"language_code": {
"description": " search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: load asynchronous ai overview optional field set to if set to default value: if the element is absent or contains search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: target match type required field if type of match for the possible values: target domain, subdomain, or wildcard value required field if specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: page crawl limit optional field number of search results pages to crawl max value: Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified target matching mode optional field to enable this parameter, defines how the crawl should stop when multiple targets are specified in possible values: default value: learn more about this parameter on our Help Center direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: SERP element types to check for targets optional field to enable this parameter, specifies which SERP element types should be checked for target matches if not specified, all first-level elements with possible values: Note: cannot contain the same element types as example: learn more about this parameter on our Help Center display related results optional field if set to if set to default value: SERP element types to exclude from target search optional field to enable this parameter, specifies which SERP element types should be excluded when searching for target matches possible values: Note: cannot contain the same element types as example: learn more about this parameter on our Help Center keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your if you need to use the “+” character for your if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:', the charge per task will be multiplied by 5",
"type": "string"
},
"language_code": {
"description": " search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: target match type required field if type of match for the possible values: target domain, subdomain, or wildcard value required field if specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: page crawl limit optional field number of search results pages to crawl max value: Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified target domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without note that the results of you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: target matching mode optional field to enable this parameter, defines how the crawl should stop when multiple targets are specified in possible values: default value: learn more about this parameter on our Help Center direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: by default, the parameter is set to: Note: to use this parameter, set calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: provider usage may increase for using this parameter parsing depth optional field number of results in SERP default value: max value: Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": " device type optional field return results for a specific device type can take the values: default value: expand ai overview optional field set to default value: Note: this parameter applies only to HTML task results SERP element types to check for targets optional field to enable this parameter, specifies which SERP element types should be checked for target matches if not specified, all first-level elements with possible values: Note: cannot contain the same element types as example: learn more about this parameter on our Help Center display related results optional field if set to if set to default value: SERP element types to exclude from target search optional field to enable this parameter, specifies which SERP element types should be excluded when searching for target matches possible values: Note: cannot contain the same element types as example: learn more about this parameter on our Help Center keyword required field you can specify up to 700 characters in the all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your if you need to use the “+” character for your if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5 learn more about rules and limitations of search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: load asynchronous ai overview optional field set to if set to default value: Note: provider usage may increase for using this parameter; if the element is absent or contains search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: target match type required field if type of match for the possible values: target domain, subdomain, or wildcard value required field if specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: page crawl limit optional field number of search results pages to crawl max value: Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the learn more at our help center device operating system optional field if you specify default value: if you specify default value: clicks on the corresponding element optional field specify the click depth on the if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balance possible values: from notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default); 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"remove_from_url": {
"description": " remove specific parameters from URLs optional field using this field, you can specify up to 10 parameters to remove from URLs in the result example: search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified target matching mode optional field to enable this parameter, defines how the crawl should stop when multiple targets are specified in possible values: default value: learn more about this parameter on our Help Center direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; by default, the parameter is set to Note: to use this parameter, set calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to Note: if set to URL of the image required field the results will be based on the image you specified in this field example: search engine language code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their full name of search engine language required field if you don't specify if you use this field, you don't need to specify you can receive the list of available languages of the search engine with their example: search engine location code required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engines with their example: GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: full name of search engine location required field if you don't specify if you use this field, you don't need to specify you can receive the list of available locations of the search engine with their example: page crawl limit optional field number of search results pages to crawl max value: Note: the learn more at our help center notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center postback_url datatype required field if you specify corresponds to the datatype that will be sent to your server possible values: URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the you can use the ‘$id’ string as a example: Note: special characters in i.a., the learn more on our Help Center task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": " search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: additional parameters of the search query optional field get the list of available parameters and additional details here user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority where possible values: you can get the full list of semantic elements here possible values: possible values: you can get the full list of semantic elements here possible values: possible values: you can get the full list of semantic elements here possible values: possible values: possible values: you can get the full list of semantic elements here possible values: you can get the full list of semantic elements here note that the number of broken pages includes pages on the possible values: you can get the full list of semantic elements here example: example: _ _ _ _ _ _ if there is no data, then the value is_ search volume is rounded to the closest decimal values if there is no data, then the value is_ search volume is rounded to the closest decimal values if there is no data the value is all fields and their descriptions are available in the official documentation by this link.",
"items": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseTaskGetJsonResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseTaskGetJsonTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseTaskGetJsonTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"items": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"items": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseTasksReadyResultInfo": {
"properties": {
"endpoint_json": {
"description": "URL for collecting the results of the OnPage Lighthouse JSON task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task possible values: you can get the full list of semantic elements here where `location_code_parent` corresponds to: `\"location_code\": 20044`, where where `location_code_parent` corresponds to: `\"location_code\": 20044`, where `location_code_parent` corresponds to: `\"location_code\": 20044`, note that this array contains all types of search results found in the returned SERP; note that this array contains all types of search results found in the returned SERP; note that this array contains all types of search results found in the returned SERP; to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the Naver Organiс Advanced SERP endpoint",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the note that this array contains all types of search results found in the returned SERP; to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the Seznam Organiс Advanced SERP endpoint",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the where `location_code_parent` corresponds to: `\"location_code\": 20044`, where `location_code_parent` corresponds to: `\"location_code\": 20044`, learn more about rules and limitations of Note: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"system_message": {
"description": "instructions for the AI behaviour Note: learn more about rules and limitations of learn more about rules and limitations of learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority Note: Note: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"system_message": {
"description": "instructions for the AI behaviour Note: Note: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results learn more on our Help Center",
"type": [
"string",
"null"
]
},
"system_message": {
"description": "instructions for the AI behavior learn more about rules and limitations of GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: learn more about rules and limitations of GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: learn more about rules and limitations of GPS coordinates of a location required field if you don't specify if you use this field, you don't need to specify the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search language code default value: default value: you can add several filters at once (8 filters maximum) the full list of possible filters is available here. you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_brand_categories": {
"description": "array of brand_categories to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_brand_categories": {
"description": "array of brand categories to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_brands": {
"description": "array of brands to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_brands": {
"description": "array of brands to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_domains": {
"description": "array of domains to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_domains": {
"description": "array of domains to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_pages": {
"description": "array of pages to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_pages": {
"description": "array of page URLs to include in the response you can add several filters at once (8 filters maximum) the full list of possible filters is available here. default value: learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority you can receive the list of available filters_by making a separate request to note that you can set no more than three sorting rules in a single request Your account will be billed per each SERP containing up to 25 results; learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority learn more about rules and limitations of learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority you can receive the list of available filters_by making a separate request to note that you can set no more than three sorting rules in a single request learn more about rules and limitations of default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the default value: default value: default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests default value: today's date -(minus) one month; date format: default value: today's date -(minus) one month; date format: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned domains you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier default value: The full list of possible filters is available here.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the default value: you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: default value: learn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"domain": {
"description": "target domain\nrequired field if you don’t specify keyword\na domain should be specified without https:// and www.",
"type": [
"string",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target domain will be included in the search\noptional field\nif set to true, the subdomains will be included in the search\ndefault value: false",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
]
},
"Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"keyword": {
"description": "target keyword\nrequired field if you don’t specify domain\nyou can specify up to 2000 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”\nlearn more about rules and limitations of keyword and keywords fields in",
"type": [
"string",
"null"
]
},
"match_type": {
"description": "target keyword match type\ndefines how the specified keyword is matched\noptional field\npossible values:\nword_match – full-text search for terms that match the specified seed keyword with additional words included before, after, or within the key phrase (e.g., search for “light” will return results with “light bulb”, “light switch”);\npartial_match – substring search that finds all instances containing the specified sequence of characters, even if it appears inside a longer word (e.g., search for “light” will return results with “lighting”, “highlight”);\ndefault value: word_match",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
]
},
"Provider0A3E90081762_AiOptimizationLLmMentionsMultiTargetMetricsRequestInfo": {
"properties": {
"key": {
"description": "key for grouping the results\nrequired field\ngroups results for comparison and serves as a label for the group;\nyou can specify up to 250 characters in the key field",
"type": [
"string",
"null"
]
},
"target": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveRequestInfo": {
"properties": {
"date_from": {
"description": "start date of the time range
optional field
minimal value 2025-08-01
date format \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "end date of the time range
optional field
Note value specified in date_from cannot exceed the value in date_to
date format \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domainsearch_results_domain
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned objects
optional field100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000, use the search_after_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsMultiTargetMetricsRequestInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned objects
optional field100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000, use the search_after_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 1000 results in a single request;
by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;
Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveRequestInfo": {
"properties": {
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiveRequestInfo": {
"properties": {
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domainsearch_results_domain
minimum value: 1
maximum value: 10
default value: 10",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveRequestInfo": {
"properties": {
"date_from": {
"description": "start date of the time range
required field
minimal value: 2025-08-01
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"date_to": {
"description": "end date of the time range
required field
Note:the value specified in date_from cannot exceed the value in date_to
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"group_range": {
"description": "timeseries delta range
required field
possible values:day, week, month, year",
"type": "string"
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveRequestInfo": {
"properties": {
"date_from": {
"description": "start date of the time range
required field
minimal value: 2025-08-01
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"date_to": {
"description": "end date of the time range
required field
Note:the value specified in date_from cannot exceed the value in date_to
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"group_range": {
"description": "timeseries range
required field
possible values:day, week, month, year",
"type": "string"
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveRequestInfo": {
"properties": {
"exclude_brand_categories": {
"description": "array of brand categories to exclude from the response
optional field
if specified, the listed brand categories will be omitted from the items array
example:[\"company\",\"insurance\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed brand categories will be returned in the items array
example:[\"company\",\"insurance\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveRequestInfo": {
"properties": {
"exclude_brand_categories": {
"description": "array of brand categories to exclude from the response
optional field
if specified, the listed brand categories will be omitted from the items array
example:\"exclude_brand_categories\": [\"business\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed brand categories will be returned in the items array
example:\"include_brand_categories\": [\"business\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestInfo": {
"properties": {
"exclude_brands": {
"description": "array of brands to exclude from the response
optional field
if specified, the listed brands will be omitted from the items array
example:[\"BMW\",\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\", 1000]
optional field
if specified, only the listed brands will be returned in the items array
example:[\"BMW\",\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo": {
"properties": {
"exclude_brands": {
"description": "array of brands to exclude from the response
optional field
if specified, the listed brands will be omitted from the items array
example:\"exclude_brands\": [\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed brands will be returned in the items array
example:\"include_brands\": [\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveRequestInfo": {
"properties": {
"exclude_domains": {
"description": "array of domains to exclude from the response
optional field
if specified, the listed domains will be omitted from the items array
example:[\"google.com\",\"bing.com\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed domains will be returned in the items array
example:[\"dataforseo.com\",\"seoinsider.com\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en onlyn",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources;
Note: if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveRequestInfo": {
"properties": {
"exclude_domains": {
"description": "array of domains to exclude from the response
optional field
if specified, the listed domains will be omitted from the items array
example:\"exclude_domains\": [\"en.wikipedia.org\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed domains will be returned in the items array
example:\"include_domains\": [\"en.wikipedia.org\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources
Note:if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveRequestInfo": {
"properties": {
"exclude_pages": {
"description": "array of page URLs to exclude from the response
optional field
if specified, the listed pages will be omitted from the items array
example:
`[\"https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api\", \"https://dataforseo.com/apis/ai-optimization-api\"]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed pages will be returned in the items array
example:
`[\"https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api\", \"https://dataforseo.com/apis/ai-optimization-api\"]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources; ;
Note: if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveRequestInfo": {
"properties": {
"exclude_pages": {
"description": "array of pages to exclude from the response
optional field
if specified, the listed pages will be omitted from the items array
example:\"exclude_pages\": [\"https://example.page/\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed pages will be returned in the items array
example:\"include_pages\": [\"https://example.page/\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources;
Note:if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AiOptimizationPerplexityLlmResponsesLiveRequestInfo": {
"properties": {
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value: 1
maximum value: 4096;
default value: 2048;
Note: if the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_LlmMessageChainItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
you can receive the list of available LLM models by making a separate request to the following endpoint: https://api.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behavior
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse
lower values make output more focused
minimum value: 0
maximum value: 1.9
default value: 0.77",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection
minimum value: 0
maximum value: 1
default value: 0.9",
"type": [
"number",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search_country_iso_code": {
"description": "country code for web search localization
optional field
specify the country ISO code to get localized web search results
Note: available only for Perplexity Sonar models
example: US",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AisaDataforseoFilterJsonValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"Provider0A3E90081762_AppDataAppleAppInfoTaskPostRequestInfo": {
"properties": {
"app_id": {
"description": "id of the app
required field
ID of the mobile application on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL `https://apps.apple.com/us/app/id835599320`
the id is `835599320`",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:
`http://your-server.com/pingscript?id=$id`
`http://your-server.com/pingscript?id=$id&tag=$tag`
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:
`http://your-server.com/postbackscript?id=$id`
`http://your-server.com/postbackscript?id=$id&tag=$tag`
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priority You will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataAppleAppListTaskPostRequestInfo": {
"properties": {
"app_category": {
"description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories",
"type": [
"string",
"null"
]
},
"app_collection": {
"description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios",
"type": "string"
},
"depth": {
"description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataAppleAppListingsSearchLiveRequestInfo": {
"properties": {
"categories": {
"description": "app categories
optional field
the categories you specify are used to search for app listings;
you can get the full list of available app listing categories by this link
you can specify up to 10 categories",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"description": {
"description": "keyword in the app's description
optional field
keywords that occur in the description of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"rating.value\",\">\",3]https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filtersn",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned apps
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned apps
optional field
default value: 0
if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"item.rating.value,desc\"]
you should use a comma to separate several sorting rules
example:[\"item.rating.value,desc\",\"item.rating.value,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"title": {
"description": "keyword in the app's title
optional field
keywords that occur in the title of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataAppleAppReviewsTaskPostRequestInfo": {
"properties": {
"app_id": {
"description": "id of the app
required field
ID of the mobile application on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL https://apps.apple.com/us/app/id835599320
the id is 835599320",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of reviews to be returned in the API response;
we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;
default value: 25;
maximum value: 500;
Setting depth above 25 may result in additional charges if the search engine returns more than 25 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results;
possible types of sorting:most_recent — sort by the most recent reviews;most_helpful — sort by the most relevant reviews;
default rule: most_helpful",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataAppleAppSearchesTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results to be returned from the App Store SERP;
we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;
default value: 100
maximum value: 700
Your account will be billed per each SERP containing up to 100 results;
Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if language_name is not specified
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if language_code is not specified
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataGoogleAppInfoTaskPostRequestInfo": {
"properties": {
"app_id": {
"description": "id of the app
required field
ID of the mobile application on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:
in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger
the id is org.telegram.messenger",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if language_name is not specified
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if language_code is not specified
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataGoogleAppListTaskPostRequestInfo": {
"properties": {
"age_rating": {
"description": "filter results by age rating
optional field
you can use this field to filter the results by age rating;
possible types of filtering:ages_up_to_5 — return apps approved for children up to 5 years old;ages_6_8 — return apps approved for children from 6 to 8 years old;ages_9_12 — return apps approved for children from 9 to 12 years old;
by default, the API returns apps for all ages;
Note: this filter works only in conjunction with the \"category\": \"family\" parameter",
"type": [
"string",
"null"
]
},
"app_category": {
"description": "application category on Google Play
optional field
you can filter the results by app category;
example:family;
you can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/google/categories
Note: app_category cannot be used if app_collection parameter is set to featured",
"type": [
"string",
"null"
]
},
"app_collection": {
"description": "app collection
required field
app collection on Google Play from which apps will be collected;
you can specify the following values:featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_shakers
Note: if featured is selected, the app_category parameter cannot be used",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of apps to be returned in the API response;
we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;
default value: 100;
maximum value: 200;
Your account will be billed per each SERP containing up to 100 results;
Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if language_name is not specified
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if language_code is not specified
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataGoogleAppListingsSearchLiveRequestInfo": {
"properties": {
"categories": {
"description": "app categories
optional field
the categories you specify are used to search for app listings;
you can get the full list of available app listing categories by this link
you can specify up to 10 categories",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"description": {
"description": "keyword in the app's description
optional field
keywords that occur in the description of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"item.rating.value\",\">\",3]https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned apps
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned apps
optional field
default value: 0
if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"item.installs_count,asc\"]
you should use a comma to separate several sorting rules
example:[\"item.rating.value,desc\",\"item.installs_count,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"title": {
"description": "keyword in the app's title
optional field
keywords that occur in the title of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataGoogleAppReviewsTaskPostRequestInfo": {
"properties": {
"app_id": {
"description": "id of the app
required field
ID of the mobile application on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:https://play.google.com/store/apps/details?id=org.telegram.messenger",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of reviews to be returned in the API response;
we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;
default value: 150;
maximum value: 100000;
Your account will be billed per each SERP containing up to 150 results;
Setting depth above 150 may result in additional charges if the search engine returns more than 150 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "filter reviews by rating
optional field
you can use this field to filter the results;
possible types of filtering:5 — return reviews with five-star rating only;4 — return reviews with four-star rating only;3 — return reviews with three-star rating only;2 — return reviews with two-star rating only;1 — return reviews with one-star rating only;
by default, the API returns all reviews regardless of the number of stars",
"type": [
"integer",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results;
possible types of sorting:newest — sort by the most recent reviews;most_relevant — sort by the most relevant reviews;
default rule: most_relevant",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_AppDataGoogleAppSearchesTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results to be returned to be returned from the Google Play SERP;
we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;
default value: 30;
maximum value: 200;
Your account will be billed per each SERP containing up to 30 results;
Setting depth above 30 may result in additional charges if the search engine returns more than 30 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksAnchorsLiveRequestInfo": {
"properties": {
"backlinks_filters": {
"description": "filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [[\"dofollow\", \"=\", true]]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"referring_links_types.anchors\",\">\",\"1\"][[\"broken_pages\",\">\",\"2\"],
\"and\",
[\"backlinks\",\">\",\"10\"]][[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"anchor\",\"like\",\"%seo%\"],\"or\",[\"referring_domains\",\">\",\"10\"]]]target will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"limit": {
"description": "the maximum number of returned anchors
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned anchors
optional field
default value: 0
if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"backlinks,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get anchors for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBacklinksLiveRequestInfo": {
"properties": {
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"custom_mode": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "detailed results grouping type
optional field
use this object to get a specific number of backlinks per field
if you use custom_mode, then mode will be ignored
example:\"custom_mode\": {\"field\": \"domain\", \"value\": 100}",
"type": [
"object",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates if internal backlinks from subdomains to the target will be excluded from the results
optional field
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
if set to false, internal links will be included in the results
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"rank\",\">\",\"80\"][[\"page_from_rank\",\">\",\"55\"],
\"and\",
[\"dofollow\",\"=\",true]][[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"anchor\",\"like\",\"%seo%\"],\"or\",[\"text_pre\",\"like\",\"%seo%\"]]]target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"limit": {
"description": "the maximum number of returned backlinks
optional field100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"mode": {
"description": "results grouping type
optional field
possible grouping types:as_is - returns all backlinksone_per_domain - returns one backlink per domainone_per_anchor - returns one backlink per anchoras_is",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned backlinks
optional field0
if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks;
Note: the maximum value is 20,000, use the search_after_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"rank,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"domain_from_rank,desc\",\"page_from_rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;
by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;
Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get backlinks for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBulkBacklinksLiveRequestInfo": {
"properties": {
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get the number of backlinks for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBulkNewLostBacklinksLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
this field indicates the date which will be used as a threshold for new and lost backlinks;
the backlinks that appeared in our index after the specified date will be considered as new;
the backlinks that weren't found after the specified date, but were present before, will be considered as lost;
e.g. if today is 2021-10-13, default date_from will be 2021-09-13.
minimum value equals today's date -(minus) one year;
e.g. if today is 2021-10-13, minimum date_from will be 2020-10-13.\"yyyy-mm-dd\"
example:\"2021-01-01\"",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get new & lost backlinks for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without `https://` and `www.` the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
this field indicates the date which will be used as a threshold for new and lost referring domains;
the referring domains that appeared in our index after the specified date will be considered as new;
the referring domains that weren't found after the specified date, but were present before, will be considered as lost;
e.g. if today is 2021-10-13, default date_from will be 2021-09-13.
minimum value equals today's date -(minus) one year;
e.g. if today is 2021-10-13, minimum date_from will be 2020-10-13.\"yyyy-mm-dd\"
example:\"2021-01-01\"",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get new & lost referring domains for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBulkPagesSummaryLiveRequestInfo": {
"properties": {
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get summary data for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)
you can specify up to 1000 pages, domains, or subdomains in each request.
note that the URLs you set in a single request cannot belong to more than 100 different domains.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBulkRanksLiveRequestInfo": {
"properties": {
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get rank for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBulkReferringDomainsLiveRequestInfo": {
"properties": {
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get the number of referring domains for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksBulkSpamScoreLiveRequestInfo": {
"properties": {
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get rank for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksCompetitorsLiveRequestInfo": {
"properties": {
"exclude_internal_backlinks": {
"description": "indicates if internal backlinks from subdomains to the target will be excluded from the results
optional field
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
if set to false, internal links will be included in the results
default value: true",
"type": [
"boolean",
"null"
]
},
"exclude_large_domains": {
"description": "indicates whether large domain will appear in results
optional field
if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"rank\",\">\",\"100\"][[\"target\",\"like\",\"%forbes%\"],
\"and\",
[[\"rank\",\">\",\"100\"],\"or\",[\"intersections\",\">\",\"5\"]]]
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"main_domain": {
"description": "indicates if only main domain of the target will be included in the search
optional field
if set to true, only the main domain will be included in search;
default value: true",
"type": [
"boolean",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
if 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 pages",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"rank,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"intersections,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get competitor domains for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksDomainIntersectionLiveRequestInfo": {
"properties": {
"backlinks_filters": {
"description": "filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [[\"dofollow\", \"=\", true]]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, the backlinks from subdomains of the target will be omitted and you won't receive the same domain in the response;
default value: true",
"type": [
"boolean",
"null"
]
},
"exclude_targets": {
"description": "domains, subdomains or webpages you want to exclude
optional field
you can specify up to 10 domains, subdomains or webpages
if you use this array, results will contain the referring domains that link to targets but don't link to exclude_targets
example:
`\"exclude_targets\": [
\"bbc.com\",
\"https://www.apple.com/iphone/*\",
\"https://dataforseo.com/apis/*\"]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"1.internal_links_count\",\">\",\"1\"][[\"2.referring_pages\",\">\",\"2\"],
\"and\",
[\"1.backlinks\",\">\",\"10\"]][[\"1.first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"2.target\",\"like\",\"%dataforseo.com%\"],\"or\",[\"1.referring_domains\",\">\",\"10\"]]]targets will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"intersection_mode": {
"description": "indicates whether to intersect backlinks
optional field
use this field to intersect or merge results for the specified domains
possible values: all, partialall - results are based on all backlinks;partial - results are based on the intersecting backlinks only;
default value: all",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned results
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the array of returned results
optional field
default value: 0
if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"backlinks,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "domains, subdomains or webpages to get links for
required field
you can set up to 20 domains, subdomains or webpages
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": {
\"1\": \"http://planet.postgresql.org/\",
\"2\": \"http://gborg.postgresql.org/\"
}`",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksDomainPagesLiveRequestInfo": {
"properties": {
"backlinks_filters": {
"description": "filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [\"dofollow\", \"=\", true]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates if internal backlinks from subdomains to the target will be excluded from the results
optional field
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
if set to false, internal links will be included in the results
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"meta.internal_links_count\",\">\",\"1\"][[\"meta.external_links_count\",\">\",\"2\"],
\"and\",
[\"backlinks\",\">\",\"10\"]][[\"first_visited\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"title\",\"like\",\"%seo%\"],\"or\",[\"referring_domains\",\">\",\"10\"]]]target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"limit": {
"description": "the maximum number of returned pages
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned pages
optional field
default value: 0
if 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",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"page_summary.backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"page_summary.backlinks,desc\",\"page_summary.rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain or subdomain
required field
a domain or a subdomain should be specified without https:// and www.
example:forbes.com",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksDomainPagesSummaryLiveRequestInfo": {
"properties": {
"backlinks_filters": {
"description": "filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [[\"dofollow\", \"=\", true]]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, backlinks from the subdomains of the target domain will be ommited and you won't receive the same domain in the response;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"referring_links_types.anchors\",\">\",\"1\"][[\"broken_pages\",\">\",\"2\"],
\"and\",
[\"backlinks\",\">\",\"10\"]][[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"anchor\",\"like\",\"%seo%\"],\"or\",[\"referring_domains\",\">\",\"10\"]]]target will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target domain will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"limit": {
"description": "the maximum number of returned anchors
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned anchors
optional field
default value: 0
if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"backlinks,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get summary data for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksHistoryLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimum value 2019-01-01
if you don't specify this field, the minimum value will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain
required field
a domain should be specified without https:// and www.",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksPageIntersectionLiveRequestInfo": {
"properties": {
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates if internal backlinks from subdomains to the target will be excluded from the results
optional field
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
if set to false, internal links will be included in the result
default value: true",
"type": [
"boolean",
"null"
]
},
"exclude_targets": {
"description": "domains, subdomains or webpages you want to exclude
optional field
you can set up to 10 domains, subdomains or webpages
if you use this array, results will contain the referring pages that link to targets but don't link to exclude_targets
example:
`\"exclude_targets\": [
\"bbc.com\",
\"https://www.apple.com/iphone/*\",
\"https://dataforseo.com/apis/*\"]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"1.rank\",\">\",\"80\"][[\"2.page_from_rank\",\">\",\"55\"],
\"and\",
[\"1.original\",\"=\",\"true\"]][[\"1.first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"1.acnhor\",\"like\",\"%seo%\"],\"or\",[\"1.text_pre\",\"not_like\",\"%seo%\"]]]targets will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the targets will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:attributesdomain_from_platform_type10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"intersection_mode": {
"description": "indicates whether to intersect backlinks
optional field
use this field to intersect or merge results for the specified URLs
possible values: all, partialall - results are based on all backlinks;partial - results are based on the intersecting backlinks only;
default value: all",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned backlinks
optional field100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned backlinks
optional field0
if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"rank,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"domain_from_rank,desc\",\"page_from_rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "domains, subdomains or webpages to get links for
required field
you can set up to 20 domains, subdomains or webpages
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": {
\"1\": \"http://planet.postgresql.org/\",
\"2\": \"http://gborg.postgresql.org/\"
}`",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksReferringDomainsLiveRequestInfo": {
"properties": {
"backlinks_filters": {
"description": "filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [\"dofollow\", \"=\", true]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"referring_pages\",\">\",\"1\"][[\"referring_pages\",\">\",\"2\"],
\"and\",
[\"backlinks\",\">\",\"10\"]][[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"domain\",\"like\",\"%dataforseo.com%\"],\"or\",[\"referring_domains\",\">\",\"10\"]]]target will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"limit": {
"description": "the maximum number of returned domains
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
if 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 pages",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"backlinks,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get referring domains for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksReferringNetworksLiveRequestInfo": {
"properties": {
"backlinks_filters": {
"description": "filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [[\"dofollow\", \"=\", true]]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"referring_pages\",\">\",\"1\"][[\"referring_pages\",\">\",\"2\"],
\"and\",
[\"backlinks\",\">\",\"10\"]][[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"network_address\",\"like\",\"194.1.%\"],\"or\",[\"referring_ips\",\">\",\"10\"]]]target will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"limit": {
"description": "the maximum number of returned networks
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"network_address_type": {
"description": "indicates the type of network to get data for
optional field
possible values: ip, subnet
default value: ip",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned networks
optional field
default value: 0
if 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 pages",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"backlinks,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get referring networks for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksSummaryLiveRequestInfo": {
"properties": {
"backlinks_filters": {
"description": "filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [\"dofollow\", \"=\", true]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates if internal backlinks from subdomains to the target will be excluded from the results
optional field
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
if set to false, internal links will be included in the results
default value: true",
"type": [
"boolean",
"null"
]
},
"include_indirect_links": {
"description": "indicates if indirect links to the target will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get data for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains;
the backlinks and referring domains that appeared in our index after the specified date will be considered as new;
the backlinks and referring domains that weren't found after the specified date, but were present before, will be considered as lost;2019-01-30
maximum value shouldn't exceed the date specified in the date_to
date format: \"yyyy-mm-dd\"
example:\"2021-01-01\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
minimum value shouldn't preceed the date specified in the date_from
maximum value: today's date
date format: \"yyyy-mm-dd\"
example:\"2021-01-15\"",
"type": [
"string",
"null"
]
},
"group_range": {
"description": "time range which will be used to group the results
optional field
default value: month
possible values: day, week, month, yearday, we will return items corresponding to all dates between and including date_from and date_to;
for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year\"group_range\": \"month\",
\"date_from\": \"2022-03-23\",
\"date_to\": \"2022-05-13\"
we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31day/week/month/year, we will return 0",
"type": [
"string",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain to get data for
required field
a domain should be specified without https:// and www.
example:\"forbes.com\"",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BacklinksTimeseriesSummaryLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
this field indicates the date which will be used as a threshold for summary data;2019-01-30
maximum value shouldn't exceed the date specified in the date_to
date format: \"yyyy-mm-dd\"
example:\"2021-01-01\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
minimum value shouldn't preceed the date specified in the date_from
maximum value: today's date
date format: \"yyyy-mm-dd\"
example:\"2021-01-15\"",
"type": [
"string",
"null"
]
},
"group_range": {
"description": "time range which will be used to group the results
optional field
default value: month
possible values: day, week, month, yearday, we will return items corresponding to all dates between and including date_from and date_to;
for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year\"group_range\": \"month\",
\"date_from\": \"2022-03-23\",
\"date_to\": \"2022-05-13\"
we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31day/week/month/year, we will return 0",
"type": [
"string",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain to get data for
required field
a domain should be specified without https:// and www.
example:\"forbes.com\"",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_BaseAiOptimizationLLmMentionsTargetElement": {
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataBusinessListingsSearchLiveRequestInfo": {
"properties": {
"categories": {
"description": "business categories
optional field
the categories you specify are used to search for business listings;
if you don't use this field, we will return business listings found in the specified location;
you can specify up to 10 categories",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the element in SERP
optional field
the description of the business entity for which the results are collected;
can contain up to 200 characters",
"type": [
"string",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"rating.value\",\">\",3]
you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters
The full list of possible filters is available here.n",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"is_claimed": {
"description": "indicates whether the business is verified by its owner on Google Maps
optional field",
"type": [
"boolean",
"null"
]
},
"limit": {
"description": "the maximum number of returned businesses
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional fieldlocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the value of \"radius\" is specified in kilometres (km)
the minimum value for \"radius\": 1
the maximum value for \"radius\": 100000
example:53.476225,-2.243572,200
learn more about how to set location parameters in this API on our Help Center",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned businesses
optional field
default value: 0
if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities
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",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"rating.value,desc\"]note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"rating.value,desc\",\"rating.votes_count,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in SERP
optional field
the name of the business entity for which the results are collected;
can contain up to 200 characters",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleExtendedReviewsTaskPostRequestInfo": {
"properties": {
"cid": {
"description": "unique, google-defined id of the business entity
required field if you don't specify keyword or place_id
example:194604053573767737
learn more about the identifier in this help center article
optional field
number of reviews in SERP
we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row
default value: 20
maximum value: 1000
Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field if you don't specify cid or place_id
the keyword you specify should indicate the name of the local establishment;
you can specify up to 700 characters in the keyword filed;
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5
Note: queries containing the ‘cache:’ parameter are not supported and will return a validation errorkeyword and keywords fields in DataForSEO APIs in this Help Center article
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you don't specify keyword or cid
example:GhIJQWDl0CIeQUARxks3icF8U8A
learn more about the identifier in this help center article
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleHotelInfoLiveAdvancedRequestInfo": {
"properties": {
"adults": {
"description": "number of adults
optional field
if you don't specify this field, two adults will be used by default
example:1",
"type": [
"integer",
"null"
]
},
"check_in": {
"description": "check-in date
optional field
if you don't specify this field, tomorrow's date will be used by default;
the value must not be earlier than today's date
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"check_out": {
"description": "check-out date
optional field
if you don't specify this field, our system will apply the date of two days from now by default;
Note: the value cannot be less than or equal to check_in;
the range between check_in and check_out values cannot exceed 30 days
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"children": {
"description": "number and age of children
optional field
if you don't specify this field, no children will be included in the search;[14]
set the following value if you want to include one 13-years-old child and one 8-years-old child:[13,8]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"currency": {
"description": "currency
optional field
example:\"USD\"",
"type": [
"string",
"null"
]
},
"hotel_identifier": {
"description": "unique hotel identifier
required field
unique identifier of a hotel entity in Google search;
you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches endpoint of Business Data API
example:ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"load_prices_by_dates": {
"description": "load hotel stay prices by dates
optional field
if you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates
if you use this parameter, you will be charged double the base price for a request",
"type": [
"boolean",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude, longitude\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;
example:53.476225,-2.243572n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"prices_date_range": {
"description": "predefined period for retrieving daily price data
optional field
to use this parameter, you must specify load_prices_by_dates with true
if the prices_start_date is not specified, the start date is set to check_in date
possible values: month, three_months, six_months, year
default value: month",
"type": [
"string",
"null"
]
},
"prices_end_date": {
"description": "end date to load prices by dates
optional field
to use this parameter, you must specify load_prices_by_dates with true
if this parameter is not specified, you will get prices by date for the month
date format: yyyy-mm-dd
example:2025-05-21",
"type": [
"string",
"null"
]
},
"prices_start_date": {
"description": "start date to load prices by dates
optional field
to use this parameter, you must specify load_prices_by_dates with true
if this parameter is not specified, the start date is set to check_in date
date format: yyyy-mm-dd
example:2025-05-20",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleHotelInfoLiveHtmlRequestInfo": {
"properties": {
"adults": {
"description": "number of adults
optional field
if you don't specify this field, two adults will be used by default
example:1",
"type": [
"integer",
"null"
]
},
"check_in": {
"description": "check-in date
optional field
if you don't specify this field, tomorrow's date will be used by default;
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"check_out": {
"description": "check-out date
optional field
if you don't specify this field, our system will apply the date of two days from now by default;
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"children": {
"description": "number and age of children
optional field
if you don't specify this field, no children will be included in the search;[14]
set the following value if you want to include one 13-years-old child and one 8-years-old child:[13,8]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"currency": {
"description": "currency
optional field
example:\"USD\"",
"type": [
"string",
"null"
]
},
"hotel_identifier": {
"description": "unique hotel identifier
required field
unique identifier of a hotel entity in Google search;
you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches endpoint of Business Data API
example:ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;
example:53.476225,-2.243572n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data array of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleHotelInfoTaskPostRequestInfo": {
"properties": {
"adults": {
"description": "number of adults
optional field
if you don't specify this field, two adults will be used by default
example:1",
"type": [
"integer",
"null"
]
},
"check_in": {
"description": "check-in date
optional field
if you don't specify this field, tomorrow's date will be used by default;
the value must not be earlier than today's date
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"check_out": {
"description": "check-out date
optional field
if you don't specify this field, our system will apply the date of two days from now by default;
Note: the value cannot be less than or equal to check_in;
the range between check_in and check_out values cannot exceed 30 days
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"children": {
"description": "number and age of children
optional field
if you don't specify this field, no children will be included in the search;[14]
set the following value if you want to include one 13-years-old child and one 8-years-old child:[13,8]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"currency": {
"description": "currency
optional field
example:\"USD\"",
"type": [
"string",
"null"
]
},
"hotel_identifier": {
"description": "unique hotel identifier
required field if you don't specify keyword
if you use this field, you don't need to specify keyword
unique identifier of a hotel entity in Google search;
you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels_pack element of the response), or the Hotel Searches endpoint of Business Data API
example:ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
"type": "string"
},
"keyword": {
"description": "keyword
required field if you don't specify hotel_identifier
if you use this field, you don't need to specify hotel_identifier
the keyword you specify should indicate the name of the hotel entity
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"load_prices_by_dates": {
"description": "load hotel stay prices by dates
optional field
if you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates
if you use this parameter, you will be charged double the base price for a request",
"type": [
"boolean",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;
example:53.476225,-2.243572n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified;
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable;
we will set the necessary values before sending the request;
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified;
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request;
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
to use this parameter, you must specify load_prices_by_dates with true
if the prices_start_date is not specified, the start date is set to check_in date
possible values: month, three_months, six_months, year
default value: month",
"type": [
"string",
"null"
]
},
"prices_end_date": {
"description": "end date to load prices by dates
optional field
to use this parameter, you must specify load_prices_by_dates with true
if this parameter is not specified, you will get prices by date for the month
date format: yyyy-mm-dd
example:2025-05-21",
"type": [
"string",
"null"
]
},
"prices_start_date": {
"description": "start date to load prices by dates
optional field
to use this parameter, you must specify load_prices_by_dates with true
if this parameter is not specified, the start date is set to check_in date
date format: yyyy-mm-dd
example:2025-05-20",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255;
you can use this parameter to identify the task and match it with the result;
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleHotelSearchesLiveRequestInfo": {
"properties": {
"adults": {
"description": "number of adults
optional field
if you don't specify this field, the default value of 2 will be applied;
note that you can specify up to 6 persons including both adults and children
example:1",
"type": [
"integer",
"null"
]
},
"amenities": {
"description": "hotel amenities
optional field
you can use this field to specify different hotel amenities
example: [
\"free_parking\",
\"pets_allowed\"
]
possible values:
`\"air_conditioning\",
\"all_inclusive_available\",
\"bar\",
\"free_breakfast\",
\"fitness_center\",
\"kid_friendly\",
\"free_parking\",
\"pets_allowed\",
\"pool\",
\"restaurant\",
\"room_service\",
\"spa\",
\"free_wifi\",
\"parking\",
\"indoor_pool\",
\"outdoor_pool\",
\"wheelchair_accessible\",
\"beach_access\"`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"check_in": {
"description": "check-in date
optional field
if you don't specify this field, tomorrow's date will be used by default;
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"
Note: the value cannot precede the today's date",
"type": [
"string",
"null"
]
},
"check_out": {
"description": "check-out date
optional field
if you don't specify this field, our system will apply the date of two days from now by default;
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"
Note: the value cannot be less than or equal to check_in;
the range between check_in and check_out values cannot exceed 30 days",
"type": [
"string",
"null"
]
},
"children": {
"description": "number and age of children
optional field
if you don't specify this field, no children will be included in the search;
age of child can be from 0 to 17;
note that you can specify up to 6 persons including both adults and children
set the following value if you want to include one 14-year-old child:[14]
set the following value if you want to include one 13-year-old child and one 8-year-old child:[13,8]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"currency": {
"description": "currency
optional field
example:\"USD\"",
"type": [
"string",
"null"
]
},
"depth": {
"description": "parsing depth
optional field
number of results in Google Hotels
default value: 18 organic results
max value: 140
Note: your account will be billed per each 18 organic results regardless of paid listings in the response;
thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results;
if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
"type": [
"integer",
"null"
]
},
"free_cancellation": {
"description": "hotels with a free cancellation
optional field
set this field to true if you want to get the list of hotels with free cancellation of reservations
default value: false",
"type": [
"boolean",
"null"
]
},
"is_vacation_rentals": {
"description": "search for vacation rentals
optional field
set this field to true if you want to get the list of vacation rentals instead of hotels
default value: false",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
optional field
the keyword you specify is used to search for the list of hotels;
if you don't use this field, we will return the list of hotels found in a specified location;
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
Note: in order to obtain accurate search results, the location name is appended to the keyword automaticallykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
Note: if the coordinates are used to set a location, the search will occur in the nearest settlement
example:53.476225,-2.243572n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom
Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword",
"type": "string"
},
"max_price": {
"description": "maximum price per night
optional field
the currency of this value depends on the currency field
example:600",
"type": [
"integer",
"null"
]
},
"min_price": {
"description": "minimum price per night
optional field
the currency of this value depends on the currency field
example:100",
"type": [
"integer",
"null"
]
},
"min_rating": {
"description": "minimum rating
optional field
you can use this field to specify guest rating higher than a certain value
example:2.5",
"type": [
"number",
"null"
]
},
"search_this_area": {
"description": "show hotels from the displayed area
optional field
can take the values: true, false
default value: true
if set to false the search_this_area mode will be turned off
Note: if the search_this_area mode is turned off, the location_name won't be appended to the keyword during search
learn more about this parameter on our Help Center",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results
possible types of sorting:relevance – sort by most relevantlowest_price – sort by the lowest pricehighest_rating – sort by highest ratingmost_reviewed – sort by most reviewed
default value: relevance",
"type": [
"string",
"null"
]
},
"stars": {
"description": "hotel stars
optional field
set this field to [5] if you want to get the list of 5-star hotels only
example:[3,4,5]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleHotelSearchesTaskPostRequestInfo": {
"properties": {
"adults": {
"description": "number of adults
optional field
if you don't specify this field, the default value of 2 will be applied;
note that you can specify up to 6 persons including both adults and children
example:1",
"type": [
"integer",
"null"
]
},
"amenities": {
"description": "hotel amenities
optional field
you can use this field to specify different hotel amenities
example: [
\"free_parking\",
\"pets_allowed\"
]
possible values:\"air_conditioning\",",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"check_in": {
"description": "check-in date
\"all_inclusive_available\",
\"bar\",
\"free_breakfast\",
\"fitness_center\",
\"kid_friendly\",
\"free_parking\",
\"pets_allowed\",
\"pool\",
\"restaurant\",
\"room_service\",
\"spa\",
\"free_wifi\",
\"parking\",
\"indoor_pool\",
\"outdoor_pool\",
\"wheelchair_accessible\",
\"beach_access\"
optional field
if you don't specify this field, tomorrow's date will be used by default;
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"
Note: the value cannot precede the today's date",
"type": [
"string",
"null"
]
},
"check_out": {
"description": "check-out date
optional field
if you don't specify this field, our system will apply the date of two days from now by default;
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"
Note: the value cannot be less than or equal to check_in;
the range between check_in and check_out values cannot exceed 30 days",
"type": [
"string",
"null"
]
},
"children": {
"description": "number and age of children
optional field
if you don't specify this field, no children will be included in the search;
age of child can be from 0 to 17;
note that you can specify up to 6 persons including both adults and children
set the following value if you want to include one 14-year-old child:[14]
set the following value if you want to include one 13-year-old child and one 8-year-old child:[13,8]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"currency": {
"description": "currency
optional field
example:\"USD\"",
"type": [
"string",
"null"
]
},
"depth": {
"description": "parsing depth
optional field
number of results in Google Hotels
default value: 18 organic results
max value: 140
Note: your account will be billed per each 18 organic results regardless of paid listings in the response;
thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results;
if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
"type": [
"integer",
"null"
]
},
"free_cancellation": {
"description": "hotels with a free cancellation
optional field
set this field to true if you want to get the list of hotels with free cancellation of reservations
default value: false",
"type": [
"boolean",
"null"
]
},
"is_vacation_rentals": {
"description": "search for vacation rentals
optional field
set this field to true if you want to get the list of vacation rentals instead of hotels
default value: false",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
optional field
the keyword you specify is used to search for the list of hotels;
if you don't use this field, we will return the list of hotels found in a specified location;
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
Note: in order to obtain accurate search results, the location name is appended to the keyword automaticallykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;
example:53.476225,-2.243572",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom
Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword",
"type": "string"
},
"max_price": {
"description": "maximum price per night
optional field
the currency of this value depends on the currency field
example:600",
"type": [
"integer",
"null"
]
},
"min_price": {
"description": "minimum price per night
optional field
the currency of this value depends on the currency field
example:100",
"type": [
"integer",
"null"
]
},
"min_rating": {
"description": "minimum rating
optional field
you can use this field to specify guest rating higher than a certain value
example:2.5",
"type": [
"number",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"search_this_area": {
"description": "show hotels from the displayed area
optional field
can take the values: true, false
default value: true
if set to false the search_this_area mode will be turned off
Note: if the search_this_area mode is turned off, the location_name won't be appended to the keyword during search
learn more about this parameter on our Help Center",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results
possible types of sorting:relevance – sort by most relevantlowest_price – sort by the lowest pricehighest_rating – sort by highest ratingmost_reviewed – sort by most reviewed
default value: relevance",
"type": [
"string",
"null"
]
},
"stars": {
"description": "hotel stars
optional field
set this field to [5] if you want to get the list of 5-star hotels only
example:[3,4,5]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleMyBusinessInfoLiveRequestInfo": {
"properties": {
"keyword": {
"description": "keyword
required field
the keyword you specify should indicate the name of the local establishment
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”; cid - a unique, google-defined id of the business entity;place_id - an identifier of the business entity in Google Maps;cid:194604053573767737place_id:GhIJQWDl0CIeQUARxks3icF8U8Acid and place_id identifiers in this help center articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskPostRequestInfo": {
"properties": {
"keyword": {
"description": "keyword
required field
the keyword you specify should indicate the name of the local establishment
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”; cid - a unique, google-defined id of the business entity;place_id - an identifier of the business entity in Google Maps;cid:194604053573767737place_id:GhIJQWDl0CIeQUARxks3icF8U8Acid and place_id identifiers in this help center articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of updates in SERP
we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row
please note that Google returns 4490 updates maximum
default value: 10",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
the keyword you specify should indicate the name of the local establishment
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;this field can also be used to pass cid (unique, google-defined id of the business entity) or place_id (identifier of the business entity in Google Maps) parameters
example:cid:194604053573767737place_id:GhIJQWDl0CIeQUARxks3icF8U8Acid and place_id identifiers in this help center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 20
max value: 100
Your account will be billed per each SERP containing up to 20 results;
Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;
If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
the keyword you specify should indicate the name of the local establishment
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”; cid - a unique, google-defined id of the business entity;place_id - an identifier of the business entity in Google Maps;cid:194604053573767737place_id:GhIJQWDl0CIeQUARxks3icF8U8Acid and place_id identifiers in this help center articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of question rows in the result
default value: 20
max value: 700
Your account will be billed per each SERP containing up to 20 results;
Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;
If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
the keyword you specify should indicate the name of the local establishment
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”; cid - a unique, google-defined id of the business entity;place_id - an identifier of the business entity in Google Maps;cid:194604053573767737place_id:GhIJQWDl0CIeQUARxks3icF8U8Acid and place_id identifiers in this help center articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataGoogleReviewsTaskPostRequestInfo": {
"properties": {
"cid": {
"description": "unique, google-defined id of the business entity
required field if you don't specify keyword or place_id
example:194604053573767737
learn more about the identifier in this help center article",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of reviews in SERP
we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row
default value: 10
maximum value: 4490
Your account will be billed per each SERP containing up to 10 results;
Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field if you don't specify cid or place_id
the keyword you specify should indicate the name of the local establishment;
you can specify up to 700 characters in the keyword filed;
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5
Note: queries containing the ‘cache:’ parameter are not supported and will return a validation errorkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you don't specify keyword or cid
example:GhIJQWDl0CIeQUARxks3icF8U8A
learn more about the identifier in this help center article",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results
possible types of sorting:newest – sort by newest firsthighest_rating – sort by highest ratinglowest_rating – sort by lowest ratingrelevant – sort by relevance
default value: relevant",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataTripadvisorReviewsTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of reviews in SERP;
we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;
default value: 10;
max value: 4490
Your account will be billed per each SERP containing up to 10 results;
Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field if you do not specify url_path
the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;
you can specify up to 700 characters in the keyword filed;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”",
"type": "string"
},
"language_code": {
"description": "search engine language code
optional field
if you use this field, your account will be charged for one extra request
you can receive the list of available languages with language_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages
example:en
You will be additionally charged for setting a language parameter in this endpoint.
The cost can be calculated on the Pricing page.",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
if you use this field, your account will be charged for one extra request
you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages
example:English
You will be additionally charged for setting a language parameter in this endpoint.
The cost can be calculated on the Pricing page.",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or url_path
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations
example:1003854",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or url_path
you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations
example:London,England,United Kingdom",
"type": "string"
},
"months": {
"description": "filter by months when a traveler made a visit
optional field
possible values: january, february, march, april, may, april, june, july, august, september, october, november, december
you can specify several values at once",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"ratings": {
"description": "Tripadvisor traveler rating for a place of interest
optional field
rating based on the written reviews by a traveler after they visited a place.
possible values: excellent, very_good, average, poor, terrible
you can specify several values at once",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results;
possible types of sorting:most_recentdetailed_reviews",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"translate_reviews": {
"description": "translate reviews according to the URL path
optional field
if set to true, returned reviews will be translated to the language matching the specified url_path;
for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;
default value: true
you can learn more about how reviews are translated in this Help Center article",
"type": [
"boolean",
"null"
]
},
"url_path": {
"description": "URL path of the business entity
required field if you do not specify keyword
URL path to the Tripadvisor page of the business entity;
examples:Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.htmlhttps://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html",
"type": "string"
},
"visit_type": {
"description": "filter by type of travelers who left a review
optional field
possible values: families, couples, solo, business, friends
you can specify several values at once",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataTripadvisorSearchTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of search results to be returned from the API response
we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;
default value: 30;
maximum value: 210
Setting depth above 30 may result in additional charges if the search engine returns more than 30 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
the keyword you specify should indicate a business category, company name, or a prominent place;
you can specify up to 700 characters in the keyword filed;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations
example:1003854",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataTrustpilotReviewsTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of reviews to be returned from the API response
we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row
default value: 20
maximum value: 200
Your account will be billed per each SERP containing up to 20 results;
Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"domain": {
"description": "domain of the local establishment
required field
domain of the local establishment on Trustpilot;
you can find the domain in the URL of every business listed on Trustpilot
example:www.thepearlsource.comhttps://www.trustpilot.com/review/www.thepearlsource.com",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"sort_by": {
"description": "results sorting parameter
optional field
you can use this field to sort the results;
possible sorting parameters:recency — most recent reviews first;relevance — most relevant reviews first;
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_BusinessDataTrustpilotSearchTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of search results to be returned from the API response
we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;
default value: 10;
maximum value: 140
Your account will be billed per each SERP containing up to 10 results;
Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
the keyword you specify should indicate a business category or company name;
you can specify up to 700 characters in the keyword filed;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_ContentAnalysisCategoryTrendsLiveRequestInfo": {
"properties": {
"category_code": {
"description": "target category code
required field
to obtain a full list of available categories, refer to the Categories endpoint",
"type": [
"integer",
"null"
]
},
"date_from": {
"description": "starting date of the time range
required field
minimum value: 2022-10-31
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": "string"
},
"date_group": {
"description": "time range which will be used to group the results
optional field
default value: month
possible values: day, week, month",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"initial_dataset_filters": {
"description": "initial dataset filtering parameters
optional field
initial filtering parameters that apply to fields in the Search endpoint;
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"domain\",\"<>\", \"logitech.com\"][[\"domain\",\"<>\",\"logitech.com\"],\"and\",[\"content_info.connotation_types.negative\",\">\",1000]][[\"domain\",\"<>\",\"logitech.com\"]],
\"and\",
[[\"content_info.connotation_types.negative\",\">\",1000],
\"or\",
for more information about filters, please refer to Content Analysis API - Filters
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:top_domainstext_categoriespage_categoriescountrieslanguages
default value: 1
maximum value: 20",
"type": [
"integer",
"null"
]
},
"page_type": {
"description": "target page types
optional field
use this parameter to filter the dataset by page types
possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
possible grouping types:as_is - returns data on all citations for the target category_codeone_per_domain - returns data on one citation of the category_code per domain
default value: as_is",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_ContentAnalysisPhraseTrendsLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
required field
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": "string"
},
"date_group": {
"description": "time range which will be used to group the results
optional field
default value: month
possible values: day, week, month",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"initial_dataset_filters": {
"description": "initial dataset filtering parameters
optional field
initial filtering parameters that apply to fields in the Search endpoint;
you can add several filters at once (8 filters maximum);
you should set a logical operator and, or between the conditions;
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters;
example:[\"domain\",\"<>\", \"logitech.com\"][[\"domain\",\"<>\",\"logitech.com\"],\"and\",[\"content_info.connotation_types.negative\",\">\",1000]][[\"domain\",\"<>\",\"logitech.com\"]],
\"and\",
[[\"content_info.connotation_types.negative\",\">\",1000],
\"or\",
for more information about filters, please refer to Content Analysis API - Filters
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:top_domainstext_categoriespage_categoriescountrieslanguages
default value: 1
maximum value: 20",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "target keyword
required field
UTF-8 encoding
the keywords will be converted to a lowercase format;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example: \"keyword\": \"\\\"tesla palo alto\\\"\"keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"keyword_fields": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "target keyword fields and target keywords
optional field
use this parameter to filter the dataset by keywords that certain fields should contain;
fields you can specify: title, main_title, previous_title, snippet
you can indicate several fields;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example:
`\"keyword_fields\": {
\"snippet\": \"\\\"logitech mouse\\\"\",
\"main_title\": \"sale\"
}`",
"type": [
"object",
"null"
]
},
"page_type": {
"description": "target page types
optional field
use this parameter to filter the dataset by page types
possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
possible grouping types:as_is - returns data on all citations for the target keywordone_per_domain - returns data on one citation of the keyword per domain
default value: as_is",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_ContentAnalysisRatingDistributionLiveRequestInfo": {
"properties": {
"initial_dataset_filters": {
"description": "initial dataset filtering parameters
optional field
initial filtering parameters that apply to fields in the Search endpoint
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"domain\",\"<>\", \"logitech.com\"][[\"domain\",\"<>\",\"logitech.com\"],\"and\",[\"content_info.connotation_types.negative\",\">\",1000]][[\"domain\",\"<>\",\"logitech.com\"]],
\"and\",
[[\"content_info.connotation_types.negative\",\">\",1000],
\"or\",
for more information about filters, please refer to Content Analysis API - Filters
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:top_domainstext_categoriespage_categoriescountrieslanguages
default value: 1
maximum value: 20",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "target keyword
required field
UTF-8 encoding
the keywords will be converted to a lowercase format;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example: \"keyword\": \"\\\"tesla palo alto\\\"\"keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"keyword_fields": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "target keyword fields and target keywords
optional field
use this parameter to filter the dataset by keywords that certain fields should contain;
fields you can specify: title, main_title, previous_title, snippet
you can indicate several fields;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example:
`\"keyword_fields\": {
\"snippet\": \"\\\"logitech mouse\\\"\",
\"main_title\": \"sale\"
}`",
"type": [
"object",
"null"
]
},
"page_type": {
"description": "target page types
optional field
use this parameter to filter the dataset by page types
possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"positive_connotation_threshold": {
"description": "positive connotation threshold
optional field
specified as the probability index threshold for positive sentiment related to the citation content
if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value
possible values: from 0 to 1
default value: 0.4",
"type": [
"number",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
possible grouping types:as_is - returns all citations for the target keywordone_per_domain - returns one citation of the keyword per domain
default value: as_is",
"type": [
"string",
"null"
]
},
"sentiments_connotation_threshold": {
"description": "sentiment connotation threshold
optional field
specified as the probability index threshold for sentiment connotations related to the citation content
if you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value
possible values: from 0 to 1
default value: 0.4",
"type": [
"number",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_ContentAnalysisSearchLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"country\",\"=\", \"US\"][[\"domain_rank\",\">\",800],\"and\",[\"content_info.connotation_types.negative\",\">\",0.9]][[\"domain_rank\",\">\",800],
\"and\",
[[\"page_types\",\"has\",\"ecommerce\"],
\"or\",
for more information about filters, please refer to Content Analysis API - Filters",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "target keyword
required field
UTF-8 encoding
the keywords will be converted to a lowercase format;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example:
`\"keyword\": \"\\\"tesla palo alto\\\"\"`keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"keyword_fields": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "target keyword fields and target keywords
optional field
use this parameter to filter the dataset by keywords that certain fields should contain;
fields you can specify: title, main_title, previous_title, snippet
you can indicate several fields;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example:
`\"keyword_fields\": {
\"snippet\": \"\\\"logitech mouse\\\"\",
\"main_title\": \"sale\"
}\"`",
"type": [
"object",
"null"
]
},
"limit": {
"description": "the maximum number of returned citations
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned citations
optional field
default value: 0
if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
optional field
provided in the identical field of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 10,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 task
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"content_info.sentiment_connotations.anger,desc\"]
default rule:[\"content_info.sentiment_connotations.anger,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"content_info.sentiment_connotations.anger,desc\",\"keyword_data.keyword_info.cpc,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"page_type": {
"description": "target page types
optional field
use this parameter to filter the dataset by page types
possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the domain_rank, and url_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
possible grouping types:as_is - returns all citations for the target keywordone_per_domain - returns one citation of the keyword per domain
default value: as_is",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_ContentAnalysisSentimentAnalysisLiveRequestInfo": {
"properties": {
"initial_dataset_filters": {
"description": "initial dataset filtering parameters\noptional field\ninitial filtering parameters that apply to fields in the Search endpoint\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, has, has_not, match, not_match\nyou can use the % operator with like and not_like to match any string of zero or more characters\nexample:\n[\"domain\",\"<>\", \"logitech.com\"]\n[[\"domain\",\"<>\",\"logitech.com\"],\"and\",[\"content_info.connotation_types.negative\",\">\",1000]]\n[[\"domain\",\"<>\",\"logitech.com\"]],\n\"and\",\n[[\"content_info.connotation_types.negative\",\">\",1000],\n\"or\",\n[\"content_info.text_category\",\"has\",10994]]]\nfor more information about filters, please refer to Content Analysis API – Filters\nlearn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"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:\ntop_domains\ntext_categories\npage_categories\ncountries\nlanguages\ndefault value: 1\nmaximum value: 20",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "target keyword\nrequired field\nUTF-8 encoding\nthe keywords will be converted to a lowercase format;\nNote: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;\nexample:\n\"keyword\": \"\\\"tesla palo alto\\\"\"\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"keyword_fields": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "target keyword fields and target keywords\noptional field\nuse this parameter to filter the dataset by keywords that certain fields should contain;\nfields you can specify: title, main_title, previous_title, snippet\nyou can indicate several fields;\nNote: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;\nexample:\n\"keyword_fields\": {\n \"snippet\": \"\\\"logitech mouse\\\"\",\n \"main_title\": \"sale\"\n}",
"type": [
"object",
"null"
]
},
"page_type": {
"description": "target page types\noptional field\nuse this parameter to filter the dataset by page types\npossible values:\n\"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"positive_connotation_threshold": {
"description": "positive connotation threshold\noptional field\nspecified as the probability index threshold for positive sentiment related to the citation content\nif you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value\npossible values: from 0 to 1\ndefault value: 0.4",
"type": [
"number",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank values\noptional field\nyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale\npossible values:\none_hundred — rank values are displayed on a 0–100 scale\none_thousand — rank values are displayed on a 0–1000 scale\ndefault value: one_thousand\nlearn more about how this parameter works in this Help Center article",
"type": [
"string",
"null"
]
},
"sentiments_connotation_threshold": {
"description": "sentiment connotation threshold\noptional field\nspecified as the probability index threshold for sentiment connotations related to the citation content\nif you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value\npossible values: from 0 to 1\ndefault value: 0.4",
"type": [
"number",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_ContentAnalysisSummaryLiveRequestInfo": {
"properties": {
"initial_dataset_filters": {
"description": "initial dataset filtering parameters
optional field
initial filtering parameters that apply to fields in the Search endpoint
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"domain\",\"<>\", \"logitech.com\"][[\"domain\",\"<>\",\"logitech.com\"],\"and\",[\"content_info.connotation_types.negative\",\">\",1000]][[\"domain\",\"<>\",\"logitech.com\"]],
\"and\",
[[\"content_info.connotation_types.negative\",\">\",1000],
\"or\",
for more information about filters, please refer to Content Analysis API - Filters
learn more about the initial dataset filters in this help center article.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:top_domainstext_categoriespage_categoriescountrieslanguages
default value: 1
maximum value: 20",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "target keyword
required field
UTF-8 encoding
the keywords will be converted to a lowercase format;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example: \"keyword\": \"\\\"tesla palo alto\\\"\"keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"keyword_fields": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "target keyword fields and target keywords
optional field
use this parameter to filter the dataset by keywords that certain fields should contain;
fields you can specify: title, main_title, previous_title, snippet
you can indicate several fields;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example:\"keyword_fields\": {",
"type": [
"object",
"null"
]
},
"page_type": {
"description": "target page types
\"snippet\": \"\\\"logitech mouse\\\"\",
\"main_title\": \"sale\"
}
optional field
use this parameter to filter the dataset by page types
possible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"positive_connotation_threshold": {
"description": "positive connotation threshold
optional field
specified as the probability index threshold for positive sentiment related to the citation content
if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value
possible values: from 0 to 1
default value: 0.4",
"type": [
"number",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
specified as the probability index threshold for sentiment connotations related to the citation content
if you specify this field, sentiment_connotations object in the response will only contain data on citations where the
probability per each sentiment is more than or equal to the specified value
possible values: from 0 to 1
default value: 0.4",
"type": [
"number",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveRequestInfo": {
"properties": {
"keywords": {
"description": "target keywords
required field
UTF-8 encoding
maximum number of keywords you can specify in this array: 1000;
the keywords will be converted to lowercase formatkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if don't specify language_name
you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
Note: this endpoint currently supports these locations and languages only;
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if don't specify language_code
you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
Note: this endpoint currently supports these locations and languages only;
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if don't specify location_name
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports these locations and languages only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if don't specify location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the following locations and languages only:Australia - 2036, enAustria - 2040, deCanada - 2124, enEgypt - 2818, arFrance - 2250, frGermany - 2276, deIndia - 2356, enItaly - 2380, itMexico - 2484, esNetherlands - 2528, nlSaudi Arabia - 2682, arSingapore - 2702, enSpain - 2724, esUnited Arab Emirates - 2784, arUnited Kingdom - 2826, enUnited States - 2840, en
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveRequestInfo": {
"properties": {
"asin": {
"description": "product ID
required field
unique product identifier (ASIN) on Amazon;
you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
"type": "string"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, ilike, not_ilike, like, not_like, match, not_match
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
example:[\"full_metrics.amazon_serp.pos_1\",\">\", 20]
required field if don't specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if don't specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of products in the results array
optional field
default value: 100;
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if don't specify location_name
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if don't specify location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned product competitors
optional field
default value: 0
if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"full_metrics.amazon_serp.pos_1,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]
default rule:[\"ranked_serp_element.serp_item.rank_group,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveRequestInfo": {
"properties": {
"asins": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "asins of target products
required field
product IDs of the products for which you need to find keyword intersections;
specify the ASINs as in the following example:\"asins\": {
\"1\": \"019005476X\",
\"2\": \"0190074442\"
}
the maximum number of ASINs you can specify in this object is 20;
learn more about the parameter on this help center page",
"type": [
"object",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, ilike, not_ilike, like, not_like, match, not_match
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
example:[\"avg_position\",\"<\", 10]
optional field
possible values: union, intersect;
default value: intersect;
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code
required field if don't specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if don't specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of products in the results array
optional field
default value: 100;
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if don't specify location_name
you can receive the list of available locations with their location_code by making a separate request tohttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if don't specify location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"sum_position,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"intersections,desc\",\"avg_position,asc\"]
default rule:[\"intersections,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveRequestInfo": {
"properties": {
"asins": {
"description": "product IDs to compare
required field
product IDs to receive ranking data for;
the maximum number of ASINs you can specify in this array is 1000;
you can receive the asin parameter by making a separate request to the Amazon Products endpoint
example:B01LW2SL7R",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if don't specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if don't specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if don't specify location_name
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if don't specify location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveRequestInfo": {
"properties": {
"asin": {
"description": "product ID
required field
unique product identifier (ASIN) on Amazon;
you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
"type": "string"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]];
optional field
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "language code
required field if don't specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if don't specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of products in the results array
optional field
default value: 100;
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if don't specify location_name
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if don't specify location_code
you can receive the list of available locations with their location_name by making a separate request tohttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"keyword_data.keyword_info.competition,desc\"]
default rule:[\"ranked_serp_element.serp_item.rank_group,asc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveRequestInfo": {
"properties": {
"depth": {
"description": "keyword search depth
optional field
default value: 1;
number of the returned results depends on the value you set in this field;
you can specify a level from 0 to 4;
estimated number of keywords for each level (maximum):
0 - the keyword set in the keyword field
1 – 6 keywords
2 – 42 keywords
3 – 258 keywords
4 – 1554 keywords",
"type": [
"integer",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to_true only core keywords will be returned, all highly similar keywords will be excluded;
default value: falsen",
"type": [
"boolean",
"null"
]
},
"include_seed_keyword": {
"description": "include data for the seed keyword
optional field
if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response
default value: false",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
UTF-8 encoding
the keywords should be specified in the lowercase formatkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAppleAppCompetitorsLiveRequestInfo": {
"properties": {
"app_id": {
"description": "id of the app
required field
ID of the mobile application on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL https://apps.apple.com/us/app/id835599320
the id is 835599320",
"type": "string"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in
example:[\"intersections\",\">\",500][[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]][[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],
\"or\",
[\"sum_position\",\">=\",\"10000\"]]
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned apps
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned apps
optional field
default value: 0
if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results;
possible sorting types:asc - results will be sorted in the ascending order;desc - results will be sorted in the descending order;
you should use a comma to specify a sorting type;
example:[\"intersections,asc\"]
Note: you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example:[\"intersections,desc\",\"sum_position,asc\"][\"intersections,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAppleAppIntersectionLiveRequestInfo": {
"properties": {
"app_ids": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "ids of the target apps
required field
IDs of the target mobile applications on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL https://apps.apple.com/us/app/id835599320
the id is 835599320;
the ids should be specified the following way:
`\"app_ids\": {
\"1\": \"686449807\",
\"2\": \"382617920\"
}`
if you specify a single ID here, the API will return results only for one application;
the maximum number of app IDs you can specify in this object is 20",
"type": [
"object",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in
example:[\"keyword_data.keyword_info.search_volume\",\">\",500][[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results;
possible sorting types:asc - results will be sorted in the ascending order;desc - results will be sorted in the descending order;
you should use a comma to specify a sorting type;
example:[\"intersection_result.382617920.rank_absolute,asc\"]
Note: you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example:[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]
default rule:[\"keyword_data.keyword_info.search_volume,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAppleBulkAppMetricsLiveRequestInfo": {
"properties": {
"app_ids": {
"description": "ids of the apps
required field
IDs of mobile applications on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL https://apps.apple.com/us/app/id835599320
the id is 835599320;
the maximum number of IDs you can specify in this field is 1000",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveRequestInfo": {
"properties": {
"app_id": {
"description": "id of the app
required field
ID of the mobile application on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL https://apps.apple.com/us/app/id835599320
the id is 835599320",
"type": "string"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in
example:[\"keyword_data.keyword_info.search_volume\",\">\",500][[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results;
possible sorting types:asc - results will be sorted in the ascending order;desc - results will be sorted in the descending order;
you should use a comma to specify a sorting type;
example:[\"ranked_serp_element.serp_item.rank_group,asc\"]
Note: you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example:[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]
default rule:[\"keyword_data.keyword_info.search_volume,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleAppCompetitorsLiveRequestInfo": {
"properties": {
"app_id": {
"description": "id of the app
required field
ID of the mobile application on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:
in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger
the id is org.telegram.messenger",
"type": "string"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in
example:[\"intersections\",\">\",500][[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]][[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],
\"or\",
[\"sum_position\",\">=\",\"10000\"]]
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned apps
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned apps
optional field
default value: 0
if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results;
possible sorting types:asc - results will be sorted in the ascending order;desc - results will be sorted in the descending order;
you should use a comma to specify a sorting type;
example:[\"intersections,asc\"]
Note: you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example:[\"intersections,desc\",\"sum_position,asc\"][\"intersections,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleAppIntersectionLiveRequestInfo": {
"properties": {
"app_ids": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "ids of the target apps
required field
IDs of the target mobile applications on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:
in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger
the id is org.telegram.messenger;;
the ids should be specified the following way:\"app_ids\": {
\"1\": \"org.telegram.messenger\",
\"2\": \"com.zhiliaoapp.musically\"
}
if you specify a single ID here, the API will return results only for one application;
the maximum number of app IDs you can specify in this object is 20",
"type": [
"object",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in
example:[\"keyword_data.keyword_info.search_volume\",\">\",500][[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results;
possible sorting types:asc - results will be sorted in the ascending order;desc - results will be sorted in the descending order;
you should use a comma to specify a sorting type;
example:[\"intersection_result.382617920.rank_absolute,asc\"]
Note: you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example:[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]
default rule:[\"keyword_data.keyword_info.search_volume,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleBulkAppMetricsLiveRequestInfo": {
"properties": {
"app_ids": {
"description": "ids of the app
required field
IDs of the mobile applications on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:
in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger
the id is org.telegram.messenger;
the maximum number of IDs you can specify in this field is 1000",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveRequestInfo": {
"properties": {
"keywords": {
"description": "target keywords
required field
UTF-8 encoding
maximum number of keywords you can specify in this array: 1000
the keywords will be converted to lowercase formatkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if don't specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if don't specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if don't specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if don't specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveRequestInfo": {
"properties": {
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to_true, only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "display results by item type
optional field
indicates the type of search results included in the responseitem_types array contains item types that are different from organic, the results will be ordered by the first item type in the array[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code
if you use this field, you don’t need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
if you use this field, you don’t need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code
if you use this field, you don't have to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location
if you use this field, you don't have to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "target domains, subdomains, and webpages
required field
you can specify domains, subdomains, and webpages in this field;
domains and subdomains should be specified without https:// and www.;
pages should be specified with absolute URL, including https:// and www.;
you can set up to 1000 domains, subdomains or webpages",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in
example:[\"metrics.organic.pos_1,\">\",0][[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],
\"or\",
[\"metrics.organic.etv\",\"in\",[10,100]]]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"historical_serp_mode": {
"description": "data collection mode
optional field
you can use this field to filter the results;
possible types of filtering:live — return metrics for SERPs in which the specified target currently has ranking results;lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn't have them during the last check;all — return metrics for both types of SERPs.
default value: live",
"type": [
"string",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
if set to false, the subcategories will be ignored
default value: false
learn more about the parameter in this help center article",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "display results by item type
optional field
indicates the type of search results included in the responseitem_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned categories
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned categories
optional field
default value: 0
if you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to specify a sorting type
example:[\"metrics.paid.etv,asc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"][\"metrics.organic.count,desc\"]
Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain or subdomain
required field
the domain or subdomain name of the target website
the domain or subdomain should be specified without https:// and www.",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo": {
"properties": {
"keywords": {
"description": "target keywords
required field
UTF-8 encoding
maximum number of keywords you can specify in this array: 1000
the keywords will be converted to lowercase formatkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if don't specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if don't specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
example:English",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo": {
"properties": {
"exclude_domains": {
"description": "exclude domains from the results
optional field
use this parameter to exclude specific domains from the results
Note: you can specify up to 1000 domains in this array\"exclude_domains\": [",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"exclude_top_domains": {
"description": "indicates whether to exclude world's largest websites
\"reddit.com\",
\"youtube.com\"
]
optional field
default value: false
set to true if you want to get highly-relevant competitors excluding the websites listed below:wikipedia.org",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
pinterest.com
amazon.com
google.com
facebook.com
wordpress.com
medium.com
quora.com
reddit.com
youtube.com
ebay.com
uol.com.br
instagram.com
olx.com
twitter.com
linkedin.com
slideshare.net
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in
example:[\"metrics.organic.count\",\">\",50][[[\"metrics.organic.count\",\">=\",50],\"and\",[\"metrics.organic.pos_1\",\"in\",[1,5]]],
\"or\",
[\"metrics.organic.etv\",\">=\",\"100\"]]
optional field
if set to_true, only core keywords will be returned, all highly similar keywords will be excluded;
default value: falsen",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
to improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs;
if you use this array, metrics in the result will be based on SERPs where both target website and intersecting_domains appear;
Note: you can specify up to 20 domains in this array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"item_types": {
"description": "display results by item type
optional field
indicates the type of search results included in the responseitem_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned domains
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"max_rank_group": {
"description": "maximum rank up to which competitors will be considered
optional field
default value: 10010 here, we will extract competitors from the top 10 Google search results only",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to specify a sorting type
example:[\"metrics.paid.etv,asc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"][\"metrics.organic.count,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain
required field
the domain name of the target website
the domain should be specified without https:// and www.
you can specify page URL, but the results will be specific to the domain in the specified URL",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]] [[\"first_domain_serp_element.etv\",\">\",0],\"and\",[\"first_domain_serp_element.description\",\"like\",\"%goat%\"]] [[\"keyword_data.keyword_info.search_volume\",\">\",100], \"and\", [[\"first_domain_serp_element.description\",\"like\",\"%goat%\"], \"or\", [\"second_domain_serp_element.type\",\"=\",\"organic\"]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false",
"type": [
"boolean",
"null"
]
},
"intersections": {
"description": "domain intersections in SERP optional field if you set intersections to true, you will get the keywords for which both target domains specified as target1 and target2 have results within the same SERP; the corresponding SERP elements for both domains will be provided in the results array Note: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million if you specify intersections: false, you will get the keywords for which the domain specified as target1 has results in SERP, and the domain specified as target2 doesn't; thus, the corresponding SERP elements and other data will be provided for the domain specified as target1only default value: true",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "search results type indicates type of search results included in the response optional field possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code required field if you don't specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language required field if you don't specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the items array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"keyword_data.keyword_info.competition,desc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target1": {
"description": "domain required field the domain name of the first target website the domain should be specified without https:// and www.",
"type": "string"
},
"target2": {
"description": "domain required field the domain name of the second target website the domain should be specified without https:// and www.",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo": {
"properties": {
"category_codes": {
"description": "product and service categories
required field
The maximum number of categories you can specify: 5
you can download the full list of possible categories",
"items": {
"type": "string"
},
"type": "array"
},
"correlate": {
"description": "correlate data with previously obtained datasets
optional field
default value: true;
if you use this parameter, our system will correlate data you obtain now with previously obtained datasets;
this parameter is intended to mitigate any inconsistencies that may result from changes to our database;
Note: we do not recommend setting correlate to false",
"type": [
"boolean",
"null"
]
},
"etv_max": {
"description": "maximum current organic ETV of the domain
optional field
if specified, the API will return only domains with organic_etv lesser than the specified value",
"type": [
"integer",
"null"
]
},
"etv_min": {
"description": "minimum current organic ETV of the domain
optional field
if specified, the API will return only domains with organic_etv greater than the specified value",
"type": [
"integer",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum);
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like;
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters;
example:[\"metrics_history.202110.organic.pos_1\", \">\", 15];
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"first_date": {
"description": "first date of comparison period
required field
first date for which domain metrics will be provided;
date format: \"yyyy-mm-dd\";
example: \"2021-06-01\";
the list available dates is available through the available history endpoint;
Note: first_date cannot be greater than today's date;
Also note: the dates specified in first_date and second_date cannot point to the same month of the same year;
you can specify the dates in any order: first_date can be greater than second_date and vice versa;
minimum date: \"2020-10-01\"",
"type": "string"
},
"include_subdomains": {
"description": "return subdomains in the API response
optional field
if false, the API response will contain main_domain only;
if true, the API will return main_domain plus its subdomains (if available);
default value: true",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "display results by item type
optional field
indicates the type of search results included in the response;item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"];
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "unique language identifier
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code;
you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code;
you can receive the list of available languages with their language_name by making a separate request tohttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of domains in the results array
optional field
default value: 100;
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code;
you can receive the list of available locations with their location_code by making a separate request tohttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code;
you can receive the list of available locations with their location_name by making a separate request tohttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0;
if 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",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results;
default rule: [\"organic_etv,desc\"];
possible sorting types:asc - results will be sorted in ascending orderdesc - results will be sorted in descending order;
you should use a comma to set up a sorting type;
example:[\"organic_count,desc\"];
note that you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example:[\"organic_etv,desc\",\"organic_count,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"second_date": {
"description": "second date of comparison period
required field
second date for which domain metrics will be provided;
date format: \"yyyy-mm-dd\";
example: \"2021-10-01\";
the list available dates is available through the available history endpoint;
Note: second_date cannot be greater than today's date;
Also note: the dates specified in first_date and second_date cannot point to the same month of the same year;
you can specify the dates in any order: second_date can be greater than first_date and vice versa;
minimum date: \"2020-10-01\"",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255;
you can use this parameter to identify the task and match it with the result;
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"top_categories_count": {
"description": "number of additional domain categories
optional field
by using this parameter, you can receive domains relevant to additional categories that are not specified in category_codes above;
to learn more about the parameter, please refer to this help center article;
by default, top_categories_count is equal to the number of categories specified in the category_codes array;
Note: top_categories_count cannot be less than the number of categories in the category_codes array;
maximum value: 5",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveRequestInfo": {
"properties": {
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms
default value: falsen",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:English",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned results for domain
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location
optional field
if you use this field, you don't need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned items
optional field
default value: 0
if 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",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain
required field
the domain name of the target website
the domain should be specified without https:// and www.",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the data will be provided for the previous 12 months
minimal possible value: 2020-10-01
date format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default;
date format: \"yyyy-mm-dd\"
example:\"2021-04-01\"",
"type": [
"string",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to_true only core keywords will be returned, all highly similar keywords will be excluded;
default value: falsen",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "display results by item type
optional field
indicates the type of search results included in the response;
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array;
possible values:[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
default value:[\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code
if you use this field, you don’t need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
if you use this field, you don’t need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code
if you use this field, you don't have to specify location_name
you can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location
if you use this field, you don't have to specify location_code
you can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "target domains and subdomains
required field
you can specify domains and subdomains in this field;
domains and subdomains should be specified without https:// and www.;
you can set up to 1000 domains or subdomains",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo": {
"properties": {
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 700
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the specified keywords will be converted to lowercase format, data will be provided in a separate array
you will not be charged for the keywords omitted in the resultskeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo": {
"properties": {
"correlate": {
"description": "correlate data with previously obtained datasets
optional field
default value: true
if you use this parameter, our system will correlate data you obtain now with previously obtained datasets
this parameter is intended to mitigate any inconsistencies that may result from changes to our database
we recommend always setting correlate to true",
"type": [
"boolean",
"null"
]
},
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the data will be provided for the previous 6 months
minimal possible value: 2020-10-01
date format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2021-04-01\"",
"type": [
"string",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response;
default value: false;
with this parameter enabled, you will be charged double the price for the request;
learn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain
required field
the domain name of the target website
the domain should be specified without https:// and www.",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveRequestInfo": {
"properties": {
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result\noptional field\nif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response\ndefault value: false\nwith this parameter enabled, you will be charged double the price for the request\nlearn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword\noptional field\nif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response\ndefault value: false",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 700\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe specified keywords will be converted to lowercase format, data will be provided in a separate array\nnote that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them\nyou will not be charged for the keywords omitted in the results\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code\nrequired field if you don’t specify language_name\nNote: it is required to specify either language_name or language_code\nyou can receive the list of available locations with their language_code by making a separate request to the\nhttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language\nrequired field if you don’t specify language_code\nNote: it is required to specify either language_name or language_code\nyou can receive the list of available locations with their language_name by making a separate request to the\nhttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code\nrequired field if you don’t specify location_name\nNote: it is required to specify either location_name or location_code\nyou can receive the list of available locations with their location_code by making a separate request to the\nhttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location\nrequired field if you don’t specify location_code\nNote: it is required to specify either location_name or location_code\nyou can receive the list of available locations with their location_name by making a separate request to the\nhttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages\nexample:\nUnited Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the API will return all SERPs collected for 365 days starting from the current datetime value;
minimal possible value: 365 days from the current datetime value;
date format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default;
date format: \"yyyy-mm-dd\";
example:\"2021-09-01\"",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”",
"type": "string"
},
"language_code": {
"description": "unique language identifier
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleKeywordIdeasLiveRequestInfo": {
"properties": {
"closely_variants": {
"description": "search mode
optional field
if set to_true the results will be based on the phrase-match search algorithm
if set to false the results will be based on the broad-match search algorithm
default value: falsen",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like
you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters
note that you can not filter the results by relevance
example:[\"keyword_info.search_volume\",\">\",0][[\"keyword_info.search_volume\",\"in\",[0,1000]],
\"and\",
[\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100],
\"and\",
[[\"keyword_info.cpc\",\"<\",0.5],
\"or\",
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to_true only core keywords will be returned, all highly similar keywords will be excluded;
default value: falsen",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords
required field
UTF-8 encoding
The maximum number of keywords you can specify: 200.
The keywords will be converted to lowercase formatkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en
Note: if omitted, results default to the language with the most keyword records in the specified location;
refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English
Note: if omitted, results default to the language with the most keyword records in the specified location;
refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of keywords in the results array
optional field
default value: 700
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 10,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 task
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter[\"relevance,desc\"]
relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.
you should use a comma to separate several sorting rules
example:[\"relevance,desc\",\"keyword_info.search_volume,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveRequestInfo": {
"properties": {
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 700
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the specified keywords will be converted to lowercase format, data will be provided in a separate array
you will not be charged for the keywords omitted in the resultskeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo": {
"properties": {
"exact_match": {
"description": "search for the exact phrase
optional field
if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase
default value: false",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
example:[\"keyword_info.search_volume\",\">\",0][[\"keyword_info.search_volume\",\"in\",[0,1000]],
\"and\",
[\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100],
\"and\",
[[\"keyword_info.cpc\",\"<\",0.5],
\"or\",
[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response
default value: false",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
UTF-8 encoding
the keywords will be converted to lowercase format;keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en
Note: if omitted, results default to the language with the most keyword records in the specified location;
refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English
Note: if omitted, results default to the language with the most keyword records in the specified location;
refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location
optional field
if you use this field, you don't need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 10,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 task
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
a comma is used as a separator
example:[\"keyword_info.competition,desc\"]
default rule:[\"keyword_info.search_volume,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveRequestInfo": {
"properties": {
"app_id": {
"description": "id of the apps
required field
ID of the mobile application on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:
in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger
the id is org.telegram.messenger",
"type": "string"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in
example:[\"keyword_data.keyword_info.search_volume\",\">\",500][[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:United States",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results;
possible sorting types:asc - results will be sorted in the ascending order;desc - results will be sorted in the descending order;
you should use a comma to specify a sorting type;
example:[\"ranked_serp_element.serp_item.rank_group,asc\"]
Note: you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example:[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]
default rule:[\"keyword_data.keyword_info.search_volume,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo": {
"properties": {
"category_codes": {
"description": "product and service categories
required field
The maximum number of categories you can specify: 20
you can download the full list of possible categories",
"items": {
"type": "string"
},
"type": "array"
},
"category_intersection": {
"description": "category intersections
optional field
if set to true, you will get keywords featured in all specified categories;
if set to false, you will keywords that are specified in any of the specified categories;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like
you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters
example:[\"keyword_info.search_volume\",\">\",0][[\"keyword_info.search_volume\",\"in\",[0,1000]],
\"and\",
[\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100],
\"and\",
[[\"keyword_info.cpc\",\"<\",0.5],
\"or\",
[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "unique language identifier
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of keywords in the results array
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 10,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 task
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"keyword_info.competition,desc\"]
default rule:[\"keyword_info.search_volume,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
note that you can not filter the results by relevance
example:[\"keyword_info.search_volume\",\">\",0]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en
Note: if omitted, results default to the language with the most keyword records in the specified location;
refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English
Note: if omitted, results default to the language with the most keyword records in the specified location;
refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of keywords in the results array
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 10,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 task
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter[\"relevance,desc\"]
relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"relevance,desc\",\"keyword_info.search_volume,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain name or page url
required field
the domain name of the target website, subdomain or URL of the target webpage;
the domain name must be specified without https:// or www.;
the subdomain must be specified without https://;
the webpage URL must be specified with https:// or www.
Note: if you specify the webpage URL without https:// or www., the result will be returned for the entire domain rather than the specific page",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGooglePageIntersectionLiveRequestInfo": {
"properties": {
"exclude_pages": {
"description": "URLs of pages you want to excludeoptional fieldyou can set up to 10 pages in this arrayif you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not;note that if you specify this field, the results will be based on the keywords any URL from pages ranks for regardless of intersections between them. However, you can set intersection_mode to intersect and results will contain the keywords all URLs from pages rank for in the same SERP and URLs from exclude_pages do not. use a wildcard ('*') character to specify the search patternexample:\"exclude_pages\":[\"https://www.apple.com/iphone/*\",\"https://dataforseo.com/apis/*\",\"https://www.microsoft.com/en-us/industry/services/\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"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, not_regex, <, <=, >, >=, =, <>, in, not_in, ilike, not_ilike, like, not_like, match, not_matchyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersnote that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding pagefor instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter:[intersection_result.1.rank_absolute,\"=\",1]if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter:[intersection_result.3.type,\"=\",\"organic\"] , etc.example:[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]][[\"intersection_result.1.etv\",\">\",0],\"and\",[\"intersection_result.1.description\",\"like\",\"%goat%\"]][[\"keyword_data.keyword_info.search_volume\",\">\",100],\"and\",[[\"intersection_result.2.description\",\"like\",\"%goat%\"],\"or\",[\"intersection_result.2.type\",\"=\",\"organic\"]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains will be included in the searchoptional fieldif set to false, the subdomains will be ignoreddefault value: true",
"type": [
"boolean",
"null"
]
},
"intersection_mode": {
"description": "indicates whether to intersect keywordsoptional fielduse this field to intersect or merge results for the specified URLspossible values: union, intersectunion - results are based on all keywords any URL from pages rank for;intersect - results are based on the keywords all URLs from pages rank for in the same SERP:by default, results are based on the intersect mode if you specify only pages array. If you specify exclude_pages as well, results are based on the union mode",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "search results typeindicates type of search results included in the responseoptional fieldpossible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language coderequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:English",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned keywordsoptional fielddefault value: 100maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location coderequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:United Kingdom",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the items array of returned keywordsoptional fielddefault value: 0if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"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 orderyou should use a comma to set up a sorting parameterexample:[\"keyword_data.keyword_info.competition,desc\"]default rule:[\"keyword_data.keyword_info.search_volume,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:[\"intersection_result.1.rank_group,asc\",\"intersection_result.2.rank_absolute,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"pages": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "target URLs of pagesrequired fieldyou can set up to 20 pages in this objectthe pages should be specified with absolute URLs (including http:// or https://)example:\"pages\": {\"1\":\"https://www.apple.com/mac/*\",\"2\":\"https://dataforseo.com/*\",\"3\":\"https://support.microsoft.com/\"}if you specify a single page here, we will return results only for this page;you can also use a wildcard ('') character to specify the search patternexample:\"example.com\"search for the exact URL\"example.com/eng/\"search for the example.com page and all its related URLs which start with '/eng/', such as \"example.com/eng/index.html\" and \"example.com/eng/help/\", etc.note: a wilcard should be placed after the slash ('/') character in the end of the URL, it is not possible to place it after the domain in the following way:https://dataforseo.comuse https://dataforseo.com/ insteadNote: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million",
"type": [
"object",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
example:[\"ranked_serp_element.serp_item.rank_group\",\"<=\",10][[\"ranked_serp_element.serp_item.rank_group\",\"<=\",10],
\"and\",
[\"ranked_serp_element.serp_item.type\",\"<>\",\"paid\"]][[\"keyword_data.keyword_info.search_volume\",\"<>\",0],
\"and\",
[[\"ranked_serp_element.serp_item.type\",\"<>\",\"paid\"],\"or\",[\"ranked_serp_element.serp_item.is_malicious\",\"=\",false]]]target field or filter by the ranked_serp_element.serp_item.relative_url parameter
example:[\"ranked_serp_element.serp_item.relative_url\", \"=\", \"/apis/rank-tracker-api\"]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"historical_serp_mode": {
"description": "data collection mode
optional field
you can use this field to filter the results;
possible types of filtering:live — return keywords for which the specified target currently has ranking results in SERP;lost — return keywords for which the specified target had previously had ranking results in SERP, but didn't have them during the last check;all — return both types of keywords.
default value: live",
"type": [
"string",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, clickstream_age_distribution, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
indicates the type of search results included in the responseitem_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\", \"ai_overview_reference\"]
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:English",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"load_rank_absolute": {
"description": "return rankings distribution by rank_absolute
optional field
default value: false
if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position among all SERP elements",
"type": [
"boolean",
"null"
]
},
"location_code": {
"description": "location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location
optional field
if you use this field, you don't need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"keyword_data.keyword_info.competition,desc\"]
default rule:[\"ranked_serp_element.serp_item.rank_group,asc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain name or page url
required field
the domain name of the target website, subdomain or URL of the target webpage;
the domain name must be specified without https:// or www.;
the subdomain must be specified without https://;
the webpage URL must be specified with https:// or www.
Note: if you specify the webpage URL without https:// or www., the result will be returned for the entire domain rather than the specific page",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveRequestInfo": {
"properties": {
"depth": {
"description": "keyword search depth
optional field
default value: 1
you can specify a level from 0 to 4
estimated number of keywords for each level (maximum):
0 - the keyword set in the keyword field
1 – 8 keywords
2 – 72 keywords
3 – 584 keywords
4 – 4680 keywords",
"type": [
"integer",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like,not_like
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
example:[\"keyword_data.keyword_info.search_volume\",\">\",0][[\"keyword_info.search_volume\",\"in\",[0,1000]],
\"and\",
[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_data.keyword_info.search_volume\",\">\",100],
\"and\",
[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],
\"or\",
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "",
"type": [
"boolean",
"null"
]
},
"include_seed_keyword": {
"description": "include data for the seed keyword
optional field
if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response
default value: false",
"type": [
"boolean",
"null"
]
},
"include_serp_info": {
"description": "include data from SERP for each keyword
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
UTF-8 encoding
the keywords will be converted to lowercase formatkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"keyword_data.keyword_info.competition,desc\"]
default rule:[\"keyword_data.keyword_info.search_volume,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace_with_core_keyword": {
"description": "return data for core keyword
optional field
if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to;
if false, serp_info and related_keywords will be returned for the specified keyword (if available);
refer to this help center article for more details;
default value: false",
"type": [
"boolean",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in[\"metrics.paid.count\",\">\",0][[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]][[\"\"metrics.organic.count\",\">\",50\"],
\"and\",
[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"historical_serp_mode": {
"description": "data collection mode
optional field
you can use this field to filter the results;
possible types of filtering:live — return metrics for SERPs in which the specified target currently has ranking results;lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn't have them during the last check;all — return metrics for both types of SERPs.
default value: live",
"type": [
"string",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to true, only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
indicates the type of search results included in the responseitem_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:English",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned pages
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location
optional field
if you use this field, you don't need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned pages
optional field
default value: 0
if 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",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to specify a sorting type
example:[\"metrics.paid.etv,asc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"][\"metrics.organic.count,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain
required field
the domain name of the target website
the domain should be specified without https:// and www.",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleSearchIntentLiveRequestInfo": {
"properties": {
"keywords": {
"description": "target keywords
required field
UTF-8 encoding
maximum number of keywords you can specify in this array: 1000;
the keywords will be converted to lowercase formatkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
example:[\"median_position\",\"in\",[1,10]][[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]][[\"domain\",\"not_like\",\"%wikipedia.org%\"],
\"and\",
[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "search results type
indicates type of search results included in the response
optional field[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"keywords": {
"description": "keywords array
required field
the results will be based on the keywords you specify in this array
UTF-8 encoding;
the keywords will be converted to lowercase format;
you can specify the maximum of 200 keywordskeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "unique language identifier
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned domains
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with location_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
if 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",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
the comma is used as a separator
example:[\"avg_position,asc\"]
default rule:[\"rating,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"avg_position,asc\",\"etv,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleSubdomainsLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in
example:[\"metrics.paid.count\",\">\",0][[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]][[\"metrics.organic.count\",\">\",\"10\"],
\"and\",
[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"historical_serp_mode": {
"description": "data collection mode
optional field
you can use this field to filter the results;
possible types of filtering:live — return metrics for SERPs in which the specified target currently has ranking results;lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn't have them during the last check;all — return metrics for both types of SERPs.
default value: live",
"type": [
"string",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to true, only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
indicates the type of search results included in the responseitem_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
default value: [\"organic\", \"paid\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:English",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location
optional field
if you use this field, you don't need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to specify a sorting type
example:[\"metrics.paid.etv,asc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"][\"metrics.organic.count,desc\"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain
required field
the domain name of the target website
the domain should be specified without https:// and www.",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DataforseoLabsGoogleTopSearchesLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like,not_like
you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters
example:[\"keyword_info.search_volume\",\">\",0][[\"keyword_info.search_volume\",\"in\",[0,1000]],
\"and\",
[\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100],
\"and\",
[[\"keyword_info.cpc\",\"<\",0.5],
\"or\",
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"ignore_synonyms": {
"description": "ignore highly similar keywords
optional field
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_clickstream_data": {
"description": "include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "language code
required field if you don't specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:English",
"type": "string"
},
"limit": {
"description": "the maximum number of returned keywords
optional fieldoffset_token provided in the response to each subsequent request
default value: 1000
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:United Kingdom",
"type": "string"
},
"offset": {
"description": "offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 10,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 task
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"keyword_info.competition,desc\"]
default rule:[\"keyword_info.search_volume,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveRequestInfo": {
"properties": {
"category": {
"description": "id of the target technology category
required field if you don't specify group, keyword or technology
at least one field (group, category, keyword, technology) must be set
you can find the full list of technology category ids on this page
example:\"crm\"",
"type": "string"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in, like,not_like
you can use the % operator with like and not_like to match any string of zero or more characters
you can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code
Note: all filtering parameters are taken from the domain_technology_item of the domain_technologies endpoint;
example:[[\"country_iso_code\",\"=\",\"US\"],for more information about filters, please refer to Domain Analytics Technologies API - Filters",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"group": {
"description": "id of the target technology group
\"and\",
[\"domain_rank\",\">\",800]]
required field if you don't specify technology, category or keyword
at least one field (group, category, keyword, technology) must be set
you can find the full list of technology group ids on this page
example:\"marketing\"",
"type": "string"
},
"internal_categories_list_limit": {
"description": "maximum number of returned technology categories within the same group
optional field
you can use this field to limit the number of items with identical \"category\" in the results
default value: 5
minimum value: 1
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"internal_groups_list_limit": {
"description": "maximum number of returned technology groups
optional field
you can use this field to limit the number of items with identical \"group\" in the results
default value: 5
minimum value: 1
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of items with identical \"category\", \"group\", and \"technology\"
optional field
if you use this field, the values specified in internal_groups_list_limit, internal_categories_list_limit and internal_technologies_list_limit will be ignored;
you can use this field to limit the number of items with identical \"category\", \"group\", or \"technology\"
default value: 10
minimum value: 1
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"internal_technologies_list_limit": {
"description": "maximum number of returned technologies within the same category
optional field
you can use this field to limit the number of items with identical \"technology\" in the results
default value: 10
minimum value: 1
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "target keyword in the domain's meta keywords
required field if you don't specify group, category or technology
at least one field (group, category, keyword, technology) must be set
UTF-8 encoding
example:\"seo\"learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"limit": {
"description": "the maximum number of returned technologies
optional field
default value: 100
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"mode": {
"description": "search mode
optional field
possible search mode types:as_is - search for results exactly matching the specified group ids, category ids, or technology namesentry - search for results matching a part of the specified group ids, category ids, or technology names
default value: as_is",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
maximum value: 9999
if 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",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the following values to sort the results: groups_count, categories_count, technologies_count
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"groups_count,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"groups_count,desc\",\"technologies_count,desc\"]
default value:[\"groups_count,desc\",\"categories_count,desc\",\"technologies_count,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"technology": {
"description": "target technology
required field if you don't specify group, keyword or category
at least one field (group, category, keyword, technology) must be set
you can find the full list of technologies on this page
example:\"Salesforce\"",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DomainAnalyticsTechnologiesDomainTechnologiesLiveRequestInfo": {
"properties": {
"target": {
"description": "target domain
required field
domain name of the website to analyze
Note: results will be returned for the specified domain only",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"domain\",\"like\",\"%seo%\"][[\"country_iso_code\",\"=\",\"US\"],
\"and\",
[\"domain_rank\",\">\",100]][[\"domain_rank\",\">\",100],
\"and\",
[[\"country_iso_code\",\"=\",\"US\"],\"or\",[\"country_iso_code\",\"=\",\"CA\"]]]
optional field
UTF-8 encoding
maximum number of keywords you can specify: 10
example:[\"seo\",\"software\"]keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned domains
optional field
default value: 100
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"mode": {
"description": "search mode
optional field
possible search mode types:strict_entry - search for results exactly matching the order, intervals and separators in the specified search termsentry - search for results ignoring the order, intervals and separators in the specified search terms
default value: entry",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
if 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;
Note: the maximum value is 9999, the sum of limit and offset must not exceed 10000;
use the offset_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
available fields: domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"last_visited,desc\"]
default rule:[\"domain_rank,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"last_visited,desc\",\"domain_rank,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"search_terms": {
"description": "target search terms
required field
specify target HTML elements, tags, attributes, their content or all of the above
if 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
maximum number of search terms you can specify: 10
example:[\"data-attrid\"]",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_DomainAnalyticsTechnologiesDomainsByTechnologyLiveRequestInfo": {
"properties": {
"categories": {
"description": "ids of the target technology categories
required field if you don't specify groups, technology_paths, keywords or technologies
you can find the full list of technology category ids on this page
note: you can specify up to 10 technology categories in this array
example:[\"payment_processors\",\"crm\"]",
"items": {
"type": "string"
},
"type": "array"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"country_iso_code\",\"=\",\"US\"][[\"country_iso_code\",\"=\",\"US\"],
\"and\",
[\"domain_rank\",\">\",100]][[\"domain_rank\",\">\",100],
\"and\",
[[\"country_iso_code\",\"=\",\"US\"],\"or\",[\"country_iso_code\",\"=\",\"CA\"]]]
required field if you don't specify technologies, technology_paths, keywords or categories
you can find the full list of technology group ids on this page
note: you can specify up to 10 technology groups in this array
example:[\"sales\", \"marketing\"]",
"items": {
"type": "string"
},
"type": "array"
},
"keywords": {
"description": "target keywords in the domain's title, description or meta keywords
required field if you don't specify groups, technology_paths, technologies or categories
optional field
you can specify the maximum of 10 keywords;
UTF-8 encoding;
example:[\"seo\",\"software\"]keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"description": "the maximum number of returned domains
optional field
default value: 100
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"mode": {
"description": "search mode
optional field
possible search mode types:as_is - search for results exactly matching the specified group ids, category ids, or technology namesentry - search for results matching a part of the specified group ids, category ids, or technology names
default value: as_is",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
if 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;
Note: the maximum value is 9999, the sum of limit and offset must not exceed 10000;
use the offset_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
available fields: domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"last_visited,desc\"]
default rule:[\"domain_rank,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"last_visited,desc\",\"domain_rank,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"technologies": {
"description": "target technologies
required field if you don't specify groups, technology_paths, keywords or categories
you can find the full list of technologies you can specify here on this page
note: you can specify up to 10 technologies in this array
example:[\"Google Pay\",\"Salesforce\"]",
"items": {
"type": "string"
},
"type": "array"
},
"technology_paths": {
"description": "target technology paths
required field if you don't specify groups, technologies, keywords or categories
at least one field (technology_paths, groups, technologies, keywords or categories) must be set;
each technology path should be specified as a separate object containing \"path\" and \"name\", where \"path\" is specified as \"$group_id.$category_id\" and \"name\" - as the name of the target technology;
each object with a technology path should be separated with a comma
you can find the full list of technology group ids, category ids and technology names on this page
note: you can specify up to 10 technology paths in this array
example:[{\"path\": \"content.cms\",\"name\": \"wordpress\"}, {\"path\": \"marketing.crm\",\"name\": \"salesforce\"}]",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_DomainAnalyticsTechnologiesTechnologiesSummaryLiveRequestInfo": {
"properties": {
"categories": {
"description": "ids of the target technology categories
required field if you don't specify groups, technology_paths, technologies, or keywords
you can find the full list of technology category ids on this page
note: you can specify up to 10 technology categories in this array
example:[\"payment_processors\",\"crm\"]",
"items": {
"type": "string"
},
"type": "array"
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:<, <=, >, >=, =, <>, in, not_in, like,not_like
you can use the % operator with like and not_like to match any string of zero or more characters
you can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code
example:[[\"country_iso_code\",\"=\",\"US\"],
\"and\",
[\"domain_rank\",\">\",800]]
required field if you don't specify technologies, technology_paths, categories, or keywords
you can find the full list of technology group ids on this page
note: you can specify up to 10 technology groups in this array
example:[\"sales\", \"marketing\"]",
"items": {
"type": "string"
},
"type": "array"
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:countries, languages, content_languages, keywords
default value: 10
minimum value: 1
maximum value: 10000",
"type": [
"integer",
"null"
]
},
"keywords": {
"description": "target keywords in the domain's title, description or meta keywords
required field if you don't specify groups, technology_paths, categories, or technologies
you can specify the maximum of 10 keywords;
UTF-8 encoding;
example:[\"seo\",\"software\"]keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"mode": {
"description": "search mode
optional field
possible search mode types:as_is - search for results exactly matching the specified group ids, category ids, or technology namesentry - search for results matching a part of the specified group ids, category ids, or technology names
default value: as_is",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"technologies": {
"description": "target technologies
required field if you don't specify groups, technology_paths, categories, or keywords
you can find the full list of technologies you can specify here on this page
note: you can specify up to 10 technologies in this array
example:[\"Google Pay\",\"Salesforce\"]",
"items": {
"type": "string"
},
"type": "array"
},
"technology_paths": {
"description": "target technology paths
required field if you don't specify groups, technologies and categories
each technology path should be specified as a separate object containing \"path\" and \"name\", where \"path\" is specified as \"$group_id.$category_id\" and \"name\" - as the name of the target technology;
each object with a technology path should be separated with a comma
you can find the full list of technology group ids, category ids and technology names on this page
note: you can specify up to 10 technology paths in this array
example:[{\"path\": \"content.cms\",\"name\": \"wordpress\"}, {\"path\": \"marketing.crm\",\"name\": \"salesforce\"}]",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Provider0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimum value: 2022-10-31
if you don't specify this field, the minimum value will be used by default
date format: \"yyyy-mm-dd\"
example:\"2023-06-01\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2023-01-15\"",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"technology": {
"description": "target technology
required field
you can find the full list of technologies you can specify here on this page
example:\"Salesforce\"",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_DomainAnalyticsWhoisOverviewLiveRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned domains
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned items
optional field
default value: 0
if 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",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
the comma is used as a separator
example:[\"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 request
you should use a comma to separate several sorting rules
example:[\"expiration_datetime,asc\",\"metrics.organic.etv,desc\",\"metrics.organic.pos_1,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingAudienceEstimationLiveRequestInfo": {
"properties": {
"age": {
"description": "selection of age ranges for targeting
possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"bid": {
"description": "desired bid setting value in USD
maximum value: 1000",
"type": [
"number",
"null"
]
},
"daily_budget": {
"description": "daily campaign budget value in USD
maximum value: 10000",
"type": [
"number",
"null"
]
},
"gender": {
"description": "gender to target
possible values: male, female, unknown",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"industry": {
"description": "industry of LinkedIn profile targeting806301758",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"job_function": {
"description": "job function of LinkedIn profile targeting806300451",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius (in km)\" format
the data will be provided for the country the specified coordinates belong to
example:29.6821525,-82.4098881,100",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingAudienceEstimationTaskPostRequestInfo": {
"properties": {
"age": {
"description": "selection of age ranges for targeting
possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"bid": {
"description": "desired bid setting value in USD
maximum value: 1000",
"type": [
"number",
"null"
]
},
"daily_budget": {
"description": "daily campaign budget value in USD
maximum value: 10000",
"type": [
"number",
"null"
]
},
"gender": {
"description": "gender to target
possible values: male, female, unknown",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"industry": {
"description": "industry of LinkedIn profile targeting806301758",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"job_function": {
"description": "job function of LinkedIn profile targeting806300451",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius (in km)\" format
the data will be provided for the country the specified coordinates belong to
example:29.6821525,-82.4098881,100",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingKeywordPerformanceLiveRequestInfo": {
"properties": {
"device": {
"description": "device type
optional field
specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all
default value: all",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the specified keywords will be converted to lowercase, data will be provided in a separate arraykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:\"en\"",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:\"United States\"",
"type": "string"
},
"match": {
"description": "keywords match type
optional field
can take the following values:aggregate returns data across all match types;broad returns data for all user queries containing the specified keyword with varying word order;phrase returns data for all user queries containing the specified keyword with identical word order;exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingKeywordPerformanceTaskPostRequestInfo": {
"properties": {
"device": {
"description": "device type
optional field
specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all
default value: all",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the specified keywords will be converted to lowercase, data will be provided in a separate arraykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:\"en\"",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages
example:\"United States\"",
"type": "string"
},
"match": {
"description": "keywords match type
optional field
can take the following values:aggregate returns data across all match types;broad returns data for all user queries containing the specified keyword with varying word order;phrase returns data for all user queries containing the specified keyword with identical word order;exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingKeywordsForKeywordsLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimal value: 24 months from today's date;
if you don't specify this field, data will be provided for the last 12 months;
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
date format: \"yyyy-mm-dd\"
example:\"2020-01-01\"
optional field
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
maximum value: one month from today's date;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"
optional field
specify this field if you want to get the data for a particular device type;
possible values: all, mobile, desktop, tablet
default value: all",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;
the specified keywords will be converted to lowercase, data will be provided in a separate arraykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"keywords_negative": {
"description": "keywords negative array
optional field
These keywords will be ignored in the results array;
You can specify a maximum of 200 terms that you want to exclude from the results;
the specified keywords will be converted to lowercase format",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
supported languages:en, fr, de",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
supported languages:English, French, German",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
},
"search_partners": {
"description": "Bing search partners type
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
default value: false - results are returned for Bing, AOL, and Yahoo search networks",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimal value: 24 months from today's date;
if you don't specify this field, data will be provided for the last 12 months;
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
date format: \"yyyy-mm-dd\"
example:\"2020-01-01\"
optional field
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
maximum value: one month from today's date;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"
optional field
specify this field if you want to get the data for a particular device type;
possible values: all, mobile, desktop, tablet
default value: all",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;
the specified keywords will be converted to lowercase, data will be provided in a separate arraykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"keywords_negative": {
"description": "keywords negative array
optional field
These keywords will be ignored in the results array;
You can specify a maximum of 200 terms that you want to exclude from the results;
the specified keywords will be converted to lowercase format",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
supported languages:en, fr, de",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
supported languages:English, French, German",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
default value: false - results are returned for Bing, AOL, and Yahoo search networks",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingKeywordsForSiteLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimal value: 24 months from today's date;
if you don't specify this field, data will be provided for the last 12 months;
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
date format: \"yyyy-mm-dd\"
example:\"2020-01-01\"
optional field
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
maximum value: one month from today's date;
note: we do not recommend using a custom time range for the past year's dates;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"
optional field
specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet
default value: all",
"type": [
"string",
"null"
]
},
"keywords_negative": {
"description": "keywords negative array
optional field
These keywords will be ignored in the results array;
You can specify a maximum of 200 terms that you want to exclude from the results;
the specified keywords will be converted to lowercase format",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
supported languages:en, fr, de",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
supported languages:English, French, German",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
},
"search_partners": {
"description": "Bing search partners type
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
default value: false - results are returned for Bing, AOL, and Yahoo search networks",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain or URL
required field
the domain name or URL of the target website",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingKeywordsForSiteTaskPostRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimal value: 24 months from today's date;
if you don't specify this field, data will be provided for the last 12 months;
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
date format: \"yyyy-mm-dd\"
example:\"2020-01-01\"
optional field
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
maximum value: one month from today's date;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"
optional field
specify this field if you want to get the data for a particular device type
possible values: all, mobile, desktop, tablet
default value: all",
"type": [
"string",
"null"
]
},
"keywords_negative": {
"description": "keywords negative array
optional field
These keywords will be ignored in the results array;
You can specify a maximum of 200 terms that you want to exclude from the results;
the specified keywords will be converted to lowercase format",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
supported languages:en, fr, de",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
supported languages:English, French, German",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
default value: false - results are returned for Bing, AOL, and Yahoo search networks",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain or URL
required field
the URL of the webpage or the domain to scan for possible keywords",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingSearchVolumeHistoryLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimum value: 24 months back from today’s date;
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;\"yyyy-mm-dd\"
example:\"2020-01-01\"Note: we do not recommend using a custom time range;date_from and date_to parameters are not specified, the data will be returned for the past 24 months;period parameter:weekly, you will get results for the past 15 weeks;
with value daily, you will get results for the past 45 days",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional fieldminimum value: two years back from today’s date;
maximum value: one day from today's date;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"date_from and date_to parameters are not specified, the data will be returned for the past 24 monthsperiod parameter:weekly, you will get results for the past 15 weeks
with value daily, you will get results for the past 45 days",
"type": [
"string",
"null"
]
},
"device": {
"description": "device types
optional field
specify this field if you want to get the data for a particular device types
possible values: mobile, desktop, tablet, non_smartphones
default value: [\"mobile\", \"desktop\", \"tablet\", \"non_smartphones\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 100
the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
example:London,England,United Kingdom",
"type": "string"
},
"period": {
"description": "aggregates the returned data to a certain time period
optional field
specify this field if you want to get the data in monthly, weekly or daily formatpossible values: monthly, weekly, dailymonthly - returns data up to past 24 monthsweekly - returns data up to past 15 weeksdaily - returns data up to past 45 daysmonthly",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimum value: two years back from today’s date
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
date format: \"yyyy-mm-dd\"
example:\"2020-01-01\"date_from and date_to parameters are not specified, the data will be returned for the past 24 monthsperiod parameter:weekly, you will get results for the past 15 weeks
with value daily, you will get results for the past 45 days",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
maximum value: one day from today's date;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"date_from and date_to parameters are not specified, the data will be returned for the past 24 monthsperiod parameter:weekly, you will get results for the past 15 weeks
with value daily, you will get results for the past 45 days",
"type": [
"string",
"null"
]
},
"device": {
"description": "device types
optional field
specify this field if you want to get the data for a particular device types
possible values: mobile, desktop, tablet, non_smartphones
default value: [\"mobile\", \"desktop\", \"tablet\", \"non_smartphones\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 100
the specified keywords will be converted to lowercase, data will be provided in a separate arraykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"type": [
"string",
"null"
]
},
"language_name": {
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
example:London,England,United Kingdom",
"type": "string"
},
"period": {
"description": "aggregates the returned data to a certain time period
optional field
specify this field if you want to get the data in monthly, weekly or daily formatmonthly, weekly, dailymonthly - returns data up to past 24 monthsweekly - returns data up to past 15 weeksdaily - returns data up to past 45 daysmonthly",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingSearchVolumeLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
minimal value: 24 months from today's date;
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
date format: \"yyyy-mm-dd\"
example:\"2020-01-01\"Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
maximum value: one month from today's date;
note: we do not recommend using a custom time range for the past year's dates;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"Note: we do not recommend using a custom time range for the past year's dates",
"type": [
"string",
"null"
]
},
"device": {
"description": "device type
optional field
specify this field if you want to get the data for a particular device type;
possible values: all, mobile, desktop, tablet
default value: all",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 100
the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
supported languages:en, fr, de",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
supported languages:English, French, German",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
},
"search_partners": {
"description": "Bing search partners type
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
default value: false - results are returned for Bing, AOL, and Yahoo search networks",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataBingSearchVolumeTaskPostRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, data will be provided for the last 12 months
minimal value: 24 months from today's date
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
date format: \"yyyy-mm-dd\"
example:\"2020-01-01\"
optional field
if you don't specify this field, data will be provided for the last 12 months;
minimum value: two years back from today’s date;
maximum value: one month from today's date;
note: we do not recommend using a custom time range for the past year's dates;
date format: \"yyyy-mm-dd\"
example:\"2020-03-15\"
optional field
specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet
default value: all",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 100
the specified keywords will be converted to lowercase, data will be provided in a separate arraykeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
supported languages:en, fr, de",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
supported languages:English, French, German",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format
the data will be provided for the country the specified coordinates belong to
example:52.6178549,-155.352142",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
default value: false - results are returned for Bing, AOL, and Yahoo search networks",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataClickstreamDataBulkSearchVolumeLiveRequestInfo": {
"properties": {
"keywords": {
"description": "target keywords
required field
UTF-8 encoding
maximum number of keywords you can specify in this array: 1000;
each keyword should be at least 3 characters long;
the keywords will be converted to lowercase format;
Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"location_code": {
"description": "location code
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveRequestInfo": {
"properties": {
"keywords": {
"description": "target keywords
required field
UTF-8 encoding
maximum number of keywords you can specify in this array: 1000
the keywords will be converted to lowercase format
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
required field if don’t specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if don’t specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don’t specify location_name
if you use this field, you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages
example:2826",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don’t specify location_code
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"use_clickstream": {
"description": "use clickstream data to provide results
optional field
if set to true, you will get DataForSEO search volume values based on clickstream data;
if set to false, Bing search volume data will be used to calculate DataForSEO search volume;
default value: true;
Note: Bing search volume is available for locations provided in Bing Search Volume History Locations and Bing Ads Locations endpoints; search volume values for any other location are calculated based on clickstream data even if you set this parameter to false",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveRequestInfo": {
"properties": {
"keywords": {
"description": "target keywords
required field
UTF-8 encoding
maximum number of keywords you can specify in this array: 1000;
each keyword should be at least 3 characters long;
the keywords will be converted to lowercase format;
Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataDataforseoTrendsDemographyLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the current day and month of the preceding year will be used by default
minimal value for the web type: 2004-01-01
minimal value for other types: 2008-01-01
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
the maximum number of keywords you can specify: 5
avoid symbols and special characters (e.g., UTF symbols, emojis);
specifying non-Latin characters, you’ll get data for the countries where they are usedkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"location_code": {
"description": "search engine location code
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_code belongs to;
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_name belongs to;
example:United Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"time_range": {
"description": "preset time ranges
optional field
if you specify date_from or date_to parameters, this field will be ignored when setting a task
possible values for all type parameters:past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataDataforseoTrendsExploreLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the current day and month of the preceding year will be used by default
minimal value for the web type: 2004-01-01
minimal value for other types: 2008-01-01
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
the maximum number of keywords you can specify: 5keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"location_code": {
"description": "search engine location code
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_code belongs to;
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_name belongs to;
example:United Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"time_range": {
"description": "preset time ranges
optional field
if you specify date_from or date_to parameters, this field will be ignored when setting a task
possible values for all type parameters:past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataDataforseoTrendsMergedDataLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the current day and month of the preceding year will be used by default
minimal value for the web type: 2004-01-01
minimal value for other types: 2008-01-01
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
the maximum number of keywords you can specify: 5
avoid symbols and special characters (e.g., UTF symbols, emojis);
specifying non-Latin characters, you’ll get data for the countries where they are usedkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"location_code": {
"description": "search engine location code
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_code belongs to;
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_name belongs to;
example:United Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"time_range": {
"description": "preset time ranges
optional field
if you specify date_from or date_to parameters, this field will be ignored when setting a task
possible values for all type parameters:past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataDataforseoTrendsSubregionInterestsLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the current day and month of the preceding year will be used by default
minimal value for the web type: 2004-01-01
minimal value for other types: 2008-01-01
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords
required field
the maximum number of keywords you can specify: 5
avoid symbols and special characters (e.g., UTF symbols, emojis);
specifying non-Latin characters, you’ll get data for the countries where they are usedkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"location_code": {
"description": "search engine location code
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_code belongs to;
example:2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
note that the data will be provided for the country the specified location_name belongs to;
example:United Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"time_range": {
"description": "preset time ranges
optional field
if you specify date_from or date_to parameters, this field will be ignored when setting a task
possible values for all type parameters:past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo": {
"properties": {
"bid": {
"description": "the maximum custom bid
required field
the collected data will be based on this value
it stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics
learn more in this help center article",
"format": "int64",
"type": "integer"
},
"date_from": {
"description": "starting date of the forecasting time range
required field if you specify date_to
if you indicate date_from and date_to, you don't need to specify date_interval
minimum value is tomorrow's date
the value you specify in date_from shouldn't be further than date_to
date format: \"yyyy-mm-dd\"
example:\"2021-10-30\"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": "string"
},
"date_interval": {
"description": "forecasting date interval
optional field
if you specify date_interval, you don't need to indicate date_from and date_to
possible values: next_week, next_month, next_quarter
default value: next_month",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the forecasting time range
required field if you specify date_from
if you indicate date_from and date_to, you don't need to specify date_interval
minimum value is date_from +1 day
maximum value is current day and month of the next year
date format: \"yyyy-mm-dd\"
example:\"2022-10-30\"",
"type": "string"
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the keywords you specify will be converted to a lowercase format
Note: Google Ads may return no data for certain groups of keywords
visit our Help Center to learn more
Also note that Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"match": {
"description": "keywords match-type
required field
can take the following values: exact, broad, phrase",
"type": "string"
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by relevance, impressions, ctr, average_cpc, cost, or clicks in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo": {
"properties": {
"bid": {
"description": "the maximum custom bid
required field
the collected data will be based on this value
it stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics
learn more in this help center article",
"type": "number"
},
"date_from": {
"description": "starting date of the forecasting time range
required field if you specify date_to
if you indicate date_from and date_to, you don't need to specify date_interval
minimum value is tomorrow's date
the value you specify in date_from shouldn't be further than date_to
date format: \"yyyy-mm-dd\"
example:\"2021-10-30\"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": "string"
},
"date_interval": {
"description": "forecasting date interval
optional field
if you specify date_interval, you don't need to indicate date_from and date_to
possible values: next_week, next_month, next_quarter
default value: next_month",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the forecasting time range
required field if you specify date_from
if you indicate date_from and date_to, you don't need to specify date_interval
minimum value is date_from +1 day
maximum value is current day and month of the next year
date format: \"yyyy-mm-dd\"
example:\"2022-10-30\"",
"type": "string"
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the keywords you specify will be converted to a lowercase format
Note #1: Google Ads may return no data for certain groups of keywords;
Note #2: Google Ads provides combined search volume values for groups of similar keywords
to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;
Note #3: Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"match": {
"description": "keywords match-type
required field
can take the following values: exact, broad, phrase",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
Use these parameters to sort the results by relevance, average_cpc, cost, or clicks in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
date format: \"yyyy-mm-dd\"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
Note: the indicated date cannot be greater than yesterday's date;
if you don't specify this field, yesterday's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2022-11-30\"",
"type": [
"string",
"null"
]
},
"include_adult_keywords": {
"description": "include keywords associated with adult content
optional field
if set to true, adult keywords will be included in the response
default value: false
note that the API may return no data for such keywords due to Google Ads restrictions",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 20
The maximum number of characters for each keyword: 80
the keywords you specify will be converted to a lowercase format
Note: Google Ads may return no data for certain groups of keywords
visit our Help Center to learn more
Also note that Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;
default value: false - results are returned for Google search sites",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
date format: \"yyyy-mm-dd\"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
Note: the indicated date cannot be greater than yesterday's date;
if you don't specify this field, yesterday's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2022-11-30\"",
"type": [
"string",
"null"
]
},
"include_adult_keywords": {
"description": "include keywords associated with adult content
optional field
if set to true, adult keywords will be included in the response
default value: false
note that the API may return no data for such keywords due to Google Ads restrictions",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 20
The maximum number of characters for each keyword: 80
the keywords you specify will be converted to a lowercase format
Note: Google Ads may return no data for certain groups of keywords
visit our Help Center to learn more
Also note that Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;
default value: false - results are returned for Google search sites",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "target website
optional field
specify a website or URL to get a list of keywords relevant to it;
Note: if a website url is specified, you will still get keywords relevant for the entire website",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
date format: \"yyyy-mm-dd\"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
Note: the indicated date cannot be greater than yesterday's date;
if you don't specify this field, yesterday's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2022-11-30\"",
"type": [
"string",
"null"
]
},
"include_adult_keywords": {
"description": "include keywords associated with adult content
optional field
if set to true, adult keywords will be included in the response
default value: false
note that the API may return no data for such keywords due to Google Ads restrictions",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;
default value: false - results are returned for Google search sites",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain or page
required field
the domain name of the target website or the url of the target page;
note: to obtain keywords for the target website, use the target_type parameter",
"type": "string"
},
"target_type": {
"description": "search keywords for site or for url
optional field
possible values: site, page;
default value: page;
if set to site, keywords will be provided for the entire site;
if set to page, keywords will be provided for the specified webpage",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
date format: \"yyyy-mm-dd\"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
Note: the indicated date cannot be greater than yesterday's date;
if you don't specify this field, yesterday's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2022-11-30\"",
"type": [
"string",
"null"
]
},
"include_adult_keywords": {
"description": "include keywords associated with adult content
optional field
if set to true, adult keywords will be included in the response
default value: false
note that the API may return no data for such keywords due to Google Ads restrictions",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;
default value: false - results are returned for Google search sites",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain or page
required field
the domain name of the target website or the url of the target page;
note: to obtain keywords for the target website, use the target_type parameter",
"type": "string"
},
"target_type": {
"description": "search keywords for site or url
optional field
possible values: site, page;
default value: page
if set to site, keywords will be provided for the entire site;
if set to page, keywords will be provided for the specified webpage",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsSearchVolumeLiveRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
date format: \"yyyy-mm-dd\"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;
if you don't specify this field, yesterday's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2022-11-30\"",
"type": [
"string",
"null"
]
},
"include_adult_keywords": {
"description": "include keywords associated with adult content
optional field
if set to_true, adult keywords will be included in the response
default value:_false
note_that the API may return no data for such keywords due to_Google Ads restrictionsn",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the keywords you specify will be converted to a lowercase format
Note #1: Google Ads may return no data for certain groups of keywords;
Note #2: Google Ads provides combined search volume values for groups of similar keywords
to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;
Note #3: Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;
default value: false - results are returned for Google search sites",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data array of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskPostRequestInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
optional field
date format: \"yyyy-mm-dd\"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;
if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;
if you don't specify this field, yesterday's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2022-11-30\"",
"type": [
"string",
"null"
]
},
"include_adult_keywords": {
"description": "include keywords associated with adult content
optional field
if set to_true, adult keywords will be included in the response
default value:_false
note_that the API may return no data for such keywords due to_Google Ads restrictionsn",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords
required field
The maximum number of keywords you can specify: 1000
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the keywords you specify will be converted to a lowercase format
Note #1: Google Ads may return no data for certain groups of keywords;
Note #2: Google Ads provides combined search volume values for groups of similar keywords
to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;
Note #3: Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;
to learn more about which symbols and characters can be used, please refer to this articlekeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_coordinate;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_name or location_code;location_coordinate parameter should be specified in the \"latitude,longitude\" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special character in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special character in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;
default value: false - results are returned for Google search sites",
"type": [
"boolean",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order
default value: relevance",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data array of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleTrendsExploreLiveRequestInfo": {
"properties": {
"category_code": {
"description": "google trends search category
required field if you don't specify `keywords`
if you don't specify `keywords`, the value of this field must be greater than `0`
if you specify `keywords` and don't specify this field, the 0 value will be applied by default and the search will be carried out across all available categories
you can receive the list of available categories with their category_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google_trends/categories",
"type": "integer"
},
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the current day and month of the preceding year will be used by default
minimal value for the web type: 2004-01-01
minimal value for other types: 2008-01-01
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of items returned
optional field
to speed up the execution of the request, specify one item at a time;
possible values:\"google_trends_graph\", \"google_trends_map\", \"google_trends_topics_list\",\"google_trends_queries_list\"
default value:\"google_trends_graph\"google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"keywords": {
"description": "keywords
required field if you don't specify `category_code`
the maximum number of keywords you can specify: 5
the maximum number of characters you can specify in a keyword: 100
the minimum number of characters must be greater than 1
comma characters (,) in the specified keywords will be unset and ignored< > | \" - + = ~ ! : * ( ) [ ] { }google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keywordkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
default value: en
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
default value: English
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_name
you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations
example:2840",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_code
you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"time_range": {
"description": "preset time ranges
optional field
if you specify date_from or date_to parameters, this field will be ignored when setting a task
possible values for all type parameters:past_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
possible values for web only:2004_present
possible values for news, youtube, images, froogle:2008_present",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_KeywordsDataGoogleTrendsExploreTaskPostRequestInfo": {
"properties": {
"category_code": {
"description": "google trends search category
required field if you don't specify `keywords`
if you don't specify `keywords`, the value of this field must be greater than `0`
if you specify `keywords` and don't specify this field, the 0 value will be applied by default and the search will be carried out across all available categories
you can receive the list of available categories with their category_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google_trends/categories",
"type": "integer"
},
"date_from": {
"description": "starting date of the time range
optional field
if you don't specify this field, the current day and month of the preceding year will be used by default
minimal value for the web type: 2004-01-01
minimal value for other types: 2008-01-01
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
optional field
if you don't specify this field, the today's date will be used by default
date format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of items returned
optional field
to speed up the execution of the request, specify one item at a time;
possible values:\"google_trends_graph\", \"google_trends_map\", \"google_trends_topics_list\",\"google_trends_queries_list\"
default value:\"google_trends_graph\"google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"keywords": {
"description": "keywords
required field if you don't specify `category_code`
the maximum number of keywords you can specify: 5
the maximum number of characters you can specify in a keyword: 100
the minimum number of characters must be greater than 1
comma characters (,) in the specified keywords will be unset and ignored< > | \" - + = ~ ! : * ( ) [ ] { }google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keywordkeyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "search engine language code
optional field
default value: en
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
default value: English
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_name
you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations
example:2840",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of search engine location
optional field
if you don't use this field, you will recieve global results
if you use this field, you don't need to specify location_code
you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations
example:United Kingdom",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"time_range": {
"description": "preset time ranges
optional field
if you specify date_from or date_to parameters, this field will be ignored when setting a task
possible values for all type parameters:past_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
possible values for web only:2004_present
possible values for news, youtube, images, froogle:2008_present",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_LlmMessageChainItem": {
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonAsinLiveAdvancedRequestInfo": {
"properties": {
"asin": {
"description": "product ID
required field
unique product identifier (ASIN) in Amazon
you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_GB",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United Kingdom)",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with their location_code parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/locations
example:9045969",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:HA1,England,United Kingdom",
"type": "string"
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.com, amazon.co.uk, amazon.fr, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonAsinLiveHtmlRequestInfo": {
"properties": {
"asin": {
"description": "product ID
required field
unique product identifier (ASIN) in Amazon
you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_GB",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United Kingdom)",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with their location_code parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/locations
example:9045969",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:HA1,England,United Kingdom",
"type": "string"
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.com, amazon.co.uk, amazon.fr, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonAsinTaskPostRequestInfo": {
"properties": {
"asin": {
"description": "product ID
required field
unique product identifier (ASIN) in Amazon
you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_GB",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United Kingdom)",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with their location_code parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/locations
example:9045969n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:HA1,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.com, amazon.co.uk, amazon.fr, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonProductsLiveAdvancedRequestInfo": {
"properties": {
"department": {
"description": "amazon product department
optional field
specify one of the following amazon departments for extracting product listings:\"Arts & Crafts\", \"Automotive\", \"Baby\", \"Beauty & Personal Care\", \"Books\", \"Computers\", \"Digital Music\", \"Electronics\", \"Kindle Store\", \"Prime Video\", \"Women's Fashion\", \"Men's Fashion\", \"Girls' Fashion\", \"Boys' Fashion\", \"Deals\", \"Health & Household\", \"Home & Kitchen\", \"Industrial & Scientific\", \"Luggage\", \"Movies & TV\", \"Music, CDs & Vinyl\", \"Pet Supplies\", \"Software\", \"Sports & Outdoors\", \"Tools & Home Improvement\", \"Toys & Games\", \"Video Games\"",
"type": [
"string",
"null"
]
},
"depth": {
"description": "parsing depth
optional field
number of results to be retrieved from the Amazon results page
default value: 100
max value: 700
Your account will be billed per each SERP containing up to 100 results;
Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in this field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_GB",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United Kingdom)",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with their location_code parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/locations
example:9045969",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:HA1,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
max value: 7
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"price_max": {
"description": "maximum product price
optional field
maximum price of the returned products listed on Amazon for the specified query
example:100
Note: if you specify price_max, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"price_min": {
"description": "minimum product price
optional field
minimum price of the returned products listed on Amazon for the specified query
example:5
Note: if you specify price_min, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.com, amazon.co.uk, amazon.fr, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
you can use the following Amazon search URL parameters for customizing the search
example:&low-price=52 - search for products that cost more than 52 USD;&high-price=45 - search for products that cost less than 45 USD;&sort=relevancerank - sort results by relevance;&sort=featured-rank - sort results by featured products;&sort=price-asc-rank - sort by ascending price;&sort=price-desc-rank - sort by descending price;&sort=review-rank - sort by the average customer reviews value;&sort=date-desc-rank - sort by the newest arrival
Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by",
"type": [
"string",
"null"
]
},
"sort_by": {
"description": "results sorting rules
optional field
the following sorting rules are supported:relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival
example:sort_by:\"relevance\"
Note: if you specify sort_by, the search_param parameter will be ignored",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://www.amazon.com/s/?field-keywords=shoes&language=en_US",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonProductsLiveHtmlRequestInfo": {
"properties": {
"department": {
"description": "amazon product department
optional field
specify one of the following amazon departments for extracting product listings:\"Arts & Crafts\", \"Automotive\", \"Baby\", \"Beauty & Personal Care\", \"Books\", \"Computers\", \"Digital Music\", \"Electronics\", \"Kindle Store\", \"Prime Video\", \"Women's Fashion\", \"Men's Fashion\", \"Girls' Fashion\", \"Boys' Fashion\", \"Deals\", \"Health & Household\", \"Home & Kitchen\", \"Industrial & Scientific\", \"Luggage\", \"Movies & TV\", \"Music, CDs & Vinyl\", \"Pet Supplies\", \"Software\", \"Sports & Outdoors\", \"Tools & Home Improvement\", \"Toys & Games\", \"Video Games\"",
"type": [
"string",
"null"
]
},
"depth": {
"description": "parsing depth
optional field
number of results to be retrieved from the Amazon results page
default value: 100
max value: 700
Your account will be billed per each SERP containing up to 100 results;
Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in this field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_GB",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United Kingdom)",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with their location_code parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/locations
example:9045969",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:HA1,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
max value: 7
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"price_max": {
"description": "maximum product price
optional field
maximum price of the returned products listed on Amazon for the specified query
example:100
Note: if you specify price_max, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"price_min": {
"description": "minimum product price
optional field
minimum price of the returned products listed on Amazon for the specified query
example:5
Note: if you specify price_min, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.com, amazon.co.uk, amazon.fr, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
you can use the following Amazon search URL parameters for customizing the search
example:&low-price=52 - search for products that cost more than 52 USD;&high-price=45 - search for products that cost less than 45 USD;&sort=relevancerank - sort results by relevance;&sort=featured-rank - sort results by featured products;&sort=price-asc-rank - sort by ascending price;&sort=price-desc-rank - sort by descending price;&sort=review-rank - sort by the average customer reviews value;&sort=date-desc-rank - sort by the newest arrival
Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by",
"type": [
"string",
"null"
]
},
"sort_by": {
"description": "results sorting rules
optional field
the following sorting rules are supported:relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival
example:sort_by:\"relevance\"
Note: if you specify sort_by, the search_param parameter will be ignored",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://www.amazon.com/s/?field-keywords=shoes&language=en_US",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonProductsTaskPostRequestInfo": {
"properties": {
"department": {
"description": "amazon product department
optional field
specify one of the following amazon departments for extracting product listings:\"Arts & Crafts\", \"Automotive\", \"Baby\", \"Beauty & Personal Care\", \"Books\", \"Computers\", \"Digital Music\", \"Electronics\", \"Kindle Store\", \"Prime Video\", \"Women's Fashion\", \"Men's Fashion\", \"Girls' Fashion\", \"Boys' Fashion\", \"Deals\", \"Health & Household\", \"Home & Kitchen\", \"Industrial & Scientific\", \"Luggage\", \"Movies & TV\", \"Music, CDs & Vinyl\", \"Pet Supplies\", \"Software\", \"Sports & Outdoors\", \"Tools & Home Improvement\", \"Toys & Games\", \"Video Games\"",
"type": [
"string",
"null"
]
},
"depth": {
"description": "parsing depth
optional field
number of results to be retrieved from the Amazon results page
default value: 100
max value: 700
Your account will be billed per each SERP containing up to 100 results;
Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in this field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_GB",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United Kingdom)",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with their location_code parameters by making a separate request to thehttps://api.dataforseo.com/v3/merchant/amazon/locations
example:9045969",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:HA1,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
max value: 7
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
maximum price of the returned products listed on Amazon for the specified query
example:100
Note: if you specify price_max, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"price_min": {
"description": "minimum product price
optional field
minimum price of the returned products listed on Amazon for the specified query
example:5
Note: if you specify price_min, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.com, amazon.co.uk, amazon.fr, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
you can use the following Amazon search URL parameters for customizing the search
example:&low-price=52 - search for products that cost more than 52 USD;&high-price=45 - search for products that cost less than 45 USD;&sort=relevancerank - sort results by relevance;&sort=featured-rank - sort results by featured products;&sort=price-asc-rank - sort by ascending price;&sort=price-desc-rank - sort by descending price;&sort=review-rank - sort by the average customer reviews value;&sort=date-desc-rank - sort by the newest arrival
Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by",
"type": [
"string",
"null"
]
},
"sort_by": {
"description": "results sorting rules
optional field
the following sorting rules are supported:relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival
example:sort_by:\"relevance\"
Note: if you specify sort_by, the search_param parameter will be ignored",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://www.amazon.com/s/?field-keywords=shoes&language=en_US",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonSellersLiveAdvancedRequestInfo": {
"properties": {
"asin": {
"description": "unique product identifier on Amazon
required field
you can get this value making a separate request to the Amazon Products endpoint
note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon
example:B085RFFC9Q
learn more about the identifier in this help center guide",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_US",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United States)",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:London,England,United Kingdom",
"type": "string"
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.co.uk, amazon.com.au, amazon.de, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonSellersLiveHtmlRequestInfo": {
"properties": {
"asin": {
"description": "unique product identifier on Amazon
required field
you can get this value making a separate request to the Amazon Products endpoint
note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon
example:B085RFFC9Q
learn more about the identifier in this help center guide",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_US",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United States)",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:London,England,United Kingdom",
"type": "string"
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.co.uk, amazon.com.au, amazon.de, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantAmazonSellersTaskPostRequestInfo": {
"properties": {
"asin": {
"description": "unique product identifier on Amazon
required field
you can get this value making a separate request to the Amazon Products endpoint
note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon
example:B085RFFC9Q
learn more about the identifier in this help center guide",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:en_US",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages
example:English (United States)",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:amazon.co.uk, amazon.com.au, amazon.de, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantGoogleProductInfoTaskPostRequestInfo": {
"properties": {
"data_docid": {
"description": "unique identifier of the SERP data element
required field if product_id or gid is not specified
we recommend specifying data_docid together with product_id and gid for optimal results;
you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint
example:13071766526042404278",
"type": "string"
},
"gid": {
"description": "global product identifier on Google Shopping
required field if product_id or data_docid is not specified
we recommend specifying gid together with product_id and data_docid for optimal results;
you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint
example:4702526954592161872
learn more about the parameter in this help center guide",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
corresponds to the datatype that will be sent to your server
possible values:advanced",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"product_id": {
"description": "unique product identifier on Google Shopping
required field if data_docid or gid is not specified
we recommend specifying product_id together with data_docid and gid for optimal results;
you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint
example:4485466949985702538
learn more about the parameter in this help center guide",
"type": "string"
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:google.co.uk, google.com.au, google.de, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantGoogleProductsTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results to be retrieved from Google Shopping SERP
default value: 40
max value: 120
Your account will be billed per each SERP containing up to 40 results;
Setting depth above 40 may result in additional charges if the search engine returns more than 40 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword filed
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
max value: 7
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
maximum price of the returned products listed on Google Shopping for the specified query
example:100
Note: if you specify price_max, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"price_min": {
"description": "minimum product price
optional field
minimum price of the returned products listed on Google Shopping for the specified query
example:5
Note: if you specify price_min, the search_param parameter will be ignored",
"type": [
"integer",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:google.co.uk, google.com.au, google.de, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
you can use the following search URL parameters for customizing the search;
example:&tbs=ppr_min:45 – search for products that cost more than 45 USD;&tbs=ppr_max:50 – search for products that cost less than 50 USD;&tbs=p_ord:p – sort by ascending price;&tbs=p_ord:pd – sort by descending price;&tbs=p_ord:rv – sort by review score;&tbs=ppr_max:50,p_ord:rv – sort by review score with the maximum price of 50 USD.;&udm=28 – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum depth is 200; this parameter must be specified without tbm=shop in the url;&shoprs=$value – specify advanced filtering and sorting in the new Shopping markup; replace $value with a string in protobuf Base64 format; learn more on our help center.
Note that search_param values will be ignored if any of the following parameters are used: price_min, price_max, sort_by",
"type": [
"string",
"null"
]
},
"sort_by": {
"description": "results sorting rules
optional field
the following sorting rules are supported:review_score, price_low_to_high, price_high_to_low
example:sort_by:\"review_score\"
Note: if you specify sort_by, the search_param parameter will be ignored",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_MerchantGoogleSellersTaskPostRequestInfo": {
"properties": {
"additional_specifications": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "object containing additional url parameters
you can get additional information about the product by using the \"additional_specifications object, which you can get by making a separate request to the Google Shopping Products endpoint
example:\"additional_specifications\": {",
"type": [
"object",
"null"
]
},
"data_docid": {
"description": "unique identifier of the SERP data element
\"eto\": \"16157121050167572763_0\"
}
required field if product_id or gid is not specified
we recommend specifying data_docid together with product_id and gid for optimal results;
you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint
example:13071766526042404278",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of results to be retrieved from Google Shopping SERP
default value: 10
max value: 200
your account will be billed per each SERP containing up to 10 results;
setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
the cost can be calculated on the Pricing page",
"type": [
"integer",
"null"
]
},
"get_shops_on_google": {
"description": "include \"buy on Google\" shops
optional field
if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google
Note: if set to true, the cost of a task will be doubled",
"type": [
"boolean",
"null"
]
},
"gid": {
"description": "global product identifier on Google Shopping
required field if product_id or data_docid is not specified
we recommend specifying gid together with product_id and data_docid for optimal results;
you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint
example:4702526954592161872
learn more about the parameter in this help center guide",
"type": "string"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations
example:London,England,United Kingdom",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"product_id": {
"description": "unique product identifier on Google Shopping
required field if data_docid or gid is not specified
we recommend specifying product_id together with data_docid and gid for optimal results;
you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint
example:4485466949985702538
learn more about the parameter in this help center guide",
"type": "string"
},
"pvf": {
"description": "product variant filter on Google Shopping
optional field
parameter in Google Shopping URL, setting optional product variant filtration;
example:Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:google.co.uk, google.com.au, google.de, etc.",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageContentParsingLiveRequestInfo": {
"properties": {
"accept_language": {
"description": "language header for accessing the website
optional field
all locale formats are supported (xx, xx-XX, xxx-XX, etc.)
Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\":\"broken in the response array",
"type": [
"string",
"null"
]
},
"browser_preset": {
"description": "preset for browser screen parameters
optional field
if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factordesktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2enable_javascript or enable_browser_rendering to true",
"type": [
"string",
"null"
]
},
"browser_screen_height": {
"description": "browser screen height
optional field
you can set a custom browser screen height to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;enable_javascript or enable_browser_rendering to true240
maximum value, in pixels: 9999",
"type": [
"integer",
"null"
]
},
"browser_screen_scale_factor": {
"description": "browser screen scale factor
optional field
you can set a custom browser screen resolution ratio to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;enable_javascript or enable_browser_rendering to true0.5
maximum value: 3",
"type": [
"number",
"null"
]
},
"browser_screen_width": {
"description": "browser screen width
optional field
you can set a custom browser screen width to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;enable_javascript or enable_browser_rendering to true240
maximum value, in pixels: 9999",
"format": "int64",
"type": [
"integer",
"null"
]
},
"custom_user_agent": {
"description": "custom user agent
optional field
custom user agent for crawling a website
example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
default value: Mozilla/5.0 (compatible; RSiteAuditor)",
"type": [
"string",
"null"
]
},
"disable_cookie_popup": {
"description": "disable the cookie popup
optional field
set to true if you want to disable the popup requesting cookie consent from the user;
default value:false",
"type": [
"boolean",
"null"
]
},
"enable_browser_rendering": {
"description": "emulate browser rendering to measure Core Web Vitals
optional field
by using this parameter you will be able to emulate a browser when loading a web page;enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;
default value: false
set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;
if you use this field, enable_javascript, and load_resources parameters must be set to true
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"enable_javascript": {
"description": "load javascript on a page
optional field
set to true if you want to load the scripts available on a page
default value: false
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"enable_xhr": {
"description": "enable XMLHttpRequest on a page
optional field
set to true if you want our crawler to request data from a web server using the XMLHttpRequest object
default value:falseenable_javascript must be set to true;",
"type": [
"boolean",
"null"
]
},
"ip_pool_for_scan": {
"description": "proxy pool
optional field
you can choose a location of the proxy pool that will be used to obtain the requested data;
the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors
possible values: us, de",
"type": [
"string",
"null"
]
},
"markdown_view": {
"description": "return page content as markdown
optional field
if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response;
default value: false",
"type": [
"boolean",
"null"
]
},
"store_raw_html": {
"description": "store HTML of a crawled page
optional field
set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint
default value: false",
"type": [
"boolean",
"null"
]
},
"switch_pool": {
"description": "switch proxy pool
optional field
if true, additional proxy pools will be used to obtain the requested data;
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors",
"type": [
"boolean",
"null"
]
},
"url": {
"description": "URL of the content to parse
required field
URL of the page to parse
example:
`https://www.fujielectric.com/`",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageContentParsingRequestInfo": {
"properties": {
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
note: the enable_content_parsing parameter in the POST request must be set to true
example:\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"markdown_view": {
"description": "return page content as markdown
optional field
if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response;
default value: false",
"type": [
"boolean",
"null"
]
},
"url": {
"description": "URL of the content to parse
required field
URL of the page to parse
example:
`https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api`",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageDuplicateContentRequestInfo": {
"properties": {
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned pages
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned pages
optional field
default value: 0
maximum value: 2000000
if 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",
"type": [
"integer",
"null"
]
},
"similarity": {
"description": "content similarity score
by default, the content is considered duplicate if the value is greater than or equals 6
you can specify any similarity score in the 0-to-10 range",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL
required field
specify the initial page you want to receive duplicate content for",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageDuplicateTagsRequestInfo": {
"properties": {
"accumulator": {
"description": "tag value
optional field
specify a title or description here if you want to receive a list of duplicate pages that contains this tag",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned pages
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned pages
optional field
default value: 0
maximum value: 2000000
if 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",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageForceStopRequestInfo": {
"properties": {
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"id values as separate objects in the POST array",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageInstantPagesRequestInfo": {
"properties": {
"accept_language": {
"description": "language header for accessing the websiteoptional fieldall locale formats are supported (xx, xx-XX, xxx-XX, etc.)Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\":\"broken in the response array",
"type": [
"string",
"null"
]
},
"browser_preset": {
"description": "preset for browser screen parametersoptional fieldif you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2Note: to use this parameter, set enable_javascript or enable_browser_rendering to true",
"type": [
"string",
"null"
]
},
"browser_screen_height": {
"description": "browser screen heightoptional fieldyou can set a custom browser screen height to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240maximum value, in pixels: 9999",
"type": [
"integer",
"null"
]
},
"browser_screen_scale_factor": {
"description": "browser screen scale factoroptional fieldyou can set a custom browser screen resolution ratio to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value: 0.5maximum value: 3",
"type": [
"number",
"null"
]
},
"browser_screen_width": {
"description": "browser screen widthoptional fieldyou can set a custom browser screen width to perform audit for a particular device;if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240maximum value, in pixels: 9999",
"format": "int64",
"type": [
"integer",
"null"
]
},
"check_spell": {
"description": "check spellingoptional fieldset to true to check spelling on a website using Hunspell librarydefault value: false",
"type": [
"boolean",
"null"
]
},
"checks_threshold": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "custom threshold values for checksoptional fieldyou can specify custom threshold values for the parameters included in the checks array of OnPage API responses;Note: only integer threshold values can be modified;",
"type": [
"object",
"null"
]
},
"custom_js": {
"description": "custom javascriptoptional fieldNote that the execution time for the script you enter here should be 700 ms maximum;for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute:let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute(\"src\");rn if (src != undefined) {rn if (src.indexOf(\"analytics.js\") >= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf(\"gtm.js\") >= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script:meta = {}; meta.url = document.URL; meta.test = 'test'; meta;as a response you will receive the following data:\"custom_js_response\": {\"url\": \"https://dataforseo.com/\",\"test\": \"test\"}",
"type": [
"string",
"null"
]
},
"custom_user_agent": {
"description": "custom user agentoptional fieldcustom user agent for crawling a websiteexample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36default value: Mozilla/5.0 (compatible; RSiteAuditor)",
"type": [
"string",
"null"
]
},
"disable_cookie_popup": {
"description": "disable the cookie popup optional fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false",
"type": [
"boolean",
"null"
]
},
"enable_browser_rendering": {
"description": "emulate browser rendering to measure Core Web Vitalsoptional fieldby using this parameter you will be able to emulate a browser when loading a web page;enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;default value: falseset to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;if you use this field, parameters enable_javascript, and load_resources are enabled automatically;Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"enable_javascript": {
"description": "load javascript on a pageoptional fieldset to true if you want to load the scripts available on a pagedefault value: falseNote: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"enable_xhr": {
"description": "enable XMLHttpRequest on a pageoptional fieldset to true if you want our crawler to request data from a web server using the XMLHttpRequest objectdefault value:falseif you use this field, enable_javascript must be set to true;",
"type": [
"boolean",
"null"
]
},
"ip_pool_for_scan": {
"description": "proxy pooloptional fieldyou can choose a location of the proxy pool that will be used to obtain the requested data;the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errorspossible values: us, de",
"type": [
"string",
"null"
]
},
"load_resources": {
"description": "load resourcesoptional fieldset to true if you want to load image, stylesheets, scripts, and broken resourcesdefault value: falseNote: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"return_despite_timeout": {
"description": "return data on pages despite the timeout erroroptional fieldif true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;default value: false",
"type": [
"boolean",
"null"
]
},
"store_raw_html": {
"description": "store HTML of a crawled pageoptional fieldset to true if you want get the HTML of the page using the OnPage Raw HTML endpointdefault value: false",
"type": [
"boolean",
"null"
]
},
"switch_pool": {
"description": "switch proxy pooloptional fieldif true, additional proxy pools will be used to obtain the requested data;the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors",
"type": [
"boolean",
"null"
]
},
"url": {
"description": "target page urlrequired fieldabsolute URL of the target page;Note #1: results will be returned for the specified URL only;Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue",
"type": "string"
},
"validate_micromarkup": {
"description": "enable microdata validationoptional fieldif set to true, you can use the OnPage API Microdata endpoint with the id of the task;default value: false",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageKeywordDensityRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"keyword\",\"=\",\"%seo%\"][[\"keyword\",\"=\",\"%seo%\"],
\"and\",
[\"frequency\",\"<\",\"6\"]][[\"keyword\",\"not_like\",\"%seo%\"],
\"and\",
[[\"frequency\",\">\",\"6\"],\"or\",[\"density\",\">\",\"0.02\"]]]
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"keyword_length": {
"description": "number of words for a keyword
required field
possible values:1, 2, 3, 4, 5",
"type": "integer"
},
"limit": {
"description": "the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"frequency,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"keyword,asc\",\"frequency,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL
optional field
if you do not specify a page here, the results will be provided for the whole website
if you use this field, the API response will contain only keywords from the specified page
a page should be specified with absolute URL (including http:// or https://)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageLighthouseLiveJsonRequestInfo": {
"properties": {
"audits": {
"description": "Lighthouse audits
optional field
audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (see official definition);
use this field to get data for specific audits you indicate here;categories, you can use this field to get data for the specified audits only
for example, if you ignore \"categories\" and specify \"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"], you will get data only for these audits
for example, if you specify \"categories\": [\"seo\"] and \"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"], you will get only these audits under \"performance\" and all audits under \"seo\"
required if browser_network_throttling_method is set to devtools;
set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;
can be specified within the following range: 1–4;
Note: this parameter is applied only when browser_network_throttling_method is set to devtools;",
"type": [
"number",
"null"
]
},
"browser_network_throttling": {
"description": "browser network throttling
required if browser_network_throttling_method is set to devtools;
set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;
possible values: no_throttling, fast_4g, slow_4g, regular_3g, pc;
Note: this parameter is applied only when browser_network_throttling_method is set to devtools;",
"type": [
"string",
"null"
]
},
"browser_network_throttling_method": {
"description": "browser network throttling method
optional field
defines the method used to apply throttling during the Lighthouse audit;
possible vaules:simulate - calculates estimated performance metrics without applying explicit throttling;devtools - applies the throttling settings specified in browser_network_throttling and browser_cpu_throttling_multiplier;provided - uses the network conditions of the crawling environment;",
"type": [
"string",
"null"
]
},
"browser_screen_height": {
"description": "browser screen height
optional field
set the screen height of the browser used for the Lighthouse audit to emulate a specific device;
can be specified within the following range: 240–9999;",
"type": [
"integer",
"null"
]
},
"browser_screen_scale_factor": {
"description": "browser screen scale factor
optional field
set the device pixel ratio of the browser used for the Lighthouse audit;
can be specified within the following range: 0.5–3;",
"type": [
"number",
"null"
]
},
"browser_screen_width": {
"description": "browser screen width
optional field
set the screen width of the browser used for the Lighthouse audit to emulate a specific device;
can be specified within the following range: 240–9999;",
"format": "int64",
"type": [
"integer",
"null"
]
},
"categories": {
"description": "categories of Lighthouse audits
optional field
each category is a collection of audits and audit groups that applies weighting and scoring to the section (see official definition)audits
use this field to get data for specific categories you indicate hereseo, performance, best_practices, accessibility",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"custom_user_agent": {
"description": "custom user agent
optional field
specify the custom user agent used by the browser when running the Lighthouse audit;
can be specified with up to 254 characters;",
"type": [
"string",
"null"
]
},
"for_mobile": {
"description": "applies mobile emulation
optional field
if set to true, Lighthouse will use mobile device and screen emulation to test the page against mobile environment
if set to false, the results will be provided for desktop
default value: false",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "lighthouse language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages
default value:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "lighthouse language name
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages
default value:English",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "target URL
required field
target page should be specified with its absolute URL (including http:// or https://)
example:https://dataforseo.com/",
"type": "string"
},
"version": {
"description": "lighthouse version
optional field
you can obtain the results specific to a certain Lighthouse version by specifying its number
the list of available versions is available through the Lighthouse Versions endpoint",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageLighthouseTaskPostRequestInfo": {
"properties": {
"audits": {
"description": "Lighthouse audits
optional field
audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (see official definition)if you ignore this field, we will return data for all audits
use this field to get data for specific audits you indicate herecategories, you can use this field to get data for the specified audits only
for example, if you ignore \"categories\" and specify \"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"], you will get data only for these audits
for example, if you specify \"categories\": [\"seo\"] and \"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"], you will get only these audits under \"performance\" and all audits under \"seo\"
required if browser_network_throttling_method is set to devtools;
set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;
can be specified within the following range: 1–4;
Note: this parameter is applied only when browser_network_throttling_method is set to devtools;",
"type": [
"number",
"null"
]
},
"browser_network_throttling": {
"description": "browser network throttling
required if browser_network_throttling_method is set to devtools;
set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;
possible values: no_throttling, fast_4g, slow_4g, regular_3g, pc;
Note: this parameter is applied only when browser_network_throttling_method is set to devtools;",
"type": [
"string",
"null"
]
},
"browser_network_throttling_method": {
"description": "browser network throttling method
optional field
defines the method used to apply throttling during the Lighthouse audit;
possible vaules:simulate - calculates estimated performance metrics without applying explicit throttling;devtools - applies the throttling settings specified in browser_network_throttling and browser_cpu_throttling_multiplier;provided - uses the network conditions of the crawling environment;",
"type": [
"string",
"null"
]
},
"browser_screen_height": {
"description": "browser screen height
optional field
set the screen height of the browser used for the Lighthouse audit to emulate a specific device;
can be specified within the following range: 240–9999;",
"type": [
"integer",
"null"
]
},
"browser_screen_scale_factor": {
"description": "browser screen scale factor
optional field
set the device pixel ratio of the browser used for the Lighthouse audit;
can be specified within the following range: 0.5–3;",
"type": [
"number",
"null"
]
},
"browser_screen_width": {
"description": "browser screen width
optional field
set the screen width of the browser used for the Lighthouse audit to emulate a specific device;
can be specified within the following range: 240–9999;",
"format": "int64",
"type": [
"integer",
"null"
]
},
"categories": {
"description": "categories of Lighthouse audits
optional field
each category is a collection of audits and audit groups that applies weighting and scoring to the section (see official definition)if you ignore this field, we will return data for all categories unless you specify audits
use this field to get data for specific categories you indicate hereseo, performance, best_practices, accessibility",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"custom_user_agent": {
"description": "custom user agent
optional field
specify the custom user agent used by the browser when running the Lighthouse audit;
can be specified with up to 254 characters;",
"type": [
"string",
"null"
]
},
"for_mobile": {
"description": "applies mobile emulation
optional field
if set to true, Lighthouse will use mobile device and screen emulation to test the page against mobile environment
if set to false, the results will be provided for desktop
default value: false",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "lighthouse language code
optional field
you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages
default value:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "lighthouse language name
optional field
you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/on_page/lighthouse/languages
default value:English",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23learn more on our Help Center",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "target URL
required field
target page should be specified with its absolute URL (including http:// or https://)
example:https://dataforseo.com/",
"type": "string"
},
"version": {
"description": "lighthouse version
optional field
you can obtain the results specific to a certain Lighthouse version by specifying its number
the list of available versions is available through the Lighthouse Versions endpoint",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageLinksRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"direction\",\"=\",\"external\"][[\"domain_to\",\"<>\",\"example.com\"],
\"and\",
[\"link_from\",\"not_like\",\"%example.com/blog%\"]][[\"direction\",\"=\",\"external\"],
\"and\",
[[\"link_from\",\"like\",\"%example.com/blog%\"],\"or\",[\"link_from\",\"like\",\"%example.com/help%\"]]]
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned links
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned links
optional field
default value: 0
maximum value: 2000000
if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive links",
"type": [
"integer",
"null"
]
},
"page_from": {
"description": "relative page URL
optional field
if you use this field, the API response will contain only links from the specified page
note that in this field you can specify relative URLs only",
"type": [
"string",
"null"
]
},
"page_to": {
"description": "relative page URL
optional field
if you use this field, the API response will contain only internal links pointing to the specified page
note that in this field you can specify relative URLs only",
"type": [
"string",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;
by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;
Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageMicrodataRequestInfo": {
"properties": {
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "resource URL
required field
you can get this URL in the response of the Pages endpoint
example:https://dataforseo.com/apis",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageNonIndexableRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[[\"reason\",\"<>\",\"robots_txt\"],
\"and\",
[\"url\",\"not_like\",\"%/wp-admin/%\"]][[\"url\",\"not_like\",\"%/wp-admin/%\"],
\"and\",
[[\"reason\",\"<>\",\"meta_tag\"],\"or\",[\"reason\",\"<>\",\"http_header\"]]]
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned pages
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned pages
optional field
default value: 0
maximum value: 2000000
if 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",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPagePageScreenshotRequestInfo": {
"properties": {
"accept_language": {
"description": "language header for accessing the website
optional field
all locale formats are supported (xx, xx-XX, xxx-XX, etc.)
note: if you do not specify this parameter, some websites may deny access; in this case, you will obtain \"error_message\":\"Screenshot is empty\" in the response array",
"type": [
"string",
"null"
]
},
"browser_preset": {
"description": "preset for browser screen parameters
optional field
if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factordesktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled.",
"type": [
"string",
"null"
]
},
"browser_screen_height": {
"description": "browser screen height
optional field
you can set a custom browser screen height to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;240
maximum value, in pixels: 9999",
"type": [
"integer",
"null"
]
},
"browser_screen_scale_factor": {
"description": "browser screen scale factor
optional field
you can set a custom browser screen resolution ratio to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;0.5
maximum value: 3",
"type": [
"number",
"null"
]
},
"browser_screen_width": {
"description": "browser screen width
optional field
you can set a custom browser screen width to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;240
maximum value, in pixels: 9999",
"format": "int64",
"type": [
"integer",
"null"
]
},
"custom_user_agent": {
"description": "custom user agent
optional field
custom user agent for crawling a website
example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
default value: Mozilla/5.0 (compatible; RSiteAuditor)",
"type": [
"string",
"null"
]
},
"disable_cookie_popup": {
"description": "disable the cookie popup
optional field
set to true if you want to disable the popup requesting cookie consent from the user;
default value: false",
"type": [
"boolean",
"null"
]
},
"full_page_screenshot": {
"description": "take a screenshot of the full page
optional field
set to false if you want to capture only the part of the page displayed before scrolling
default value: true",
"type": [
"boolean",
"null"
]
},
"ip_pool_for_scan": {
"description": "proxy pool
optional field
you can choose a location of the proxy pool that will be used to obtain the requested data;
the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors
possible values: us, de",
"type": [
"string",
"null"
]
},
"switch_pool": {
"description": "switch proxy pool
optional field
if true, additional proxy pools will be used to obtain the requested data;
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors",
"type": [
"boolean",
"null"
]
},
"url": {
"description": "page url
required field
absolute URL of the page to snap
note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain \"error_message\":\"Screenshot is empty\" in the response array",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPagePagesByResourceRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"meta.external_links_count\",\"<=\",50][\"url\",\"like\",\"https://dataforseo.com/apis/dataforseo-labs-api\"][[\"checks.high_waiting_time\",\"=\",false],
\"and\",[\"resource_type\",\"=\",\"html\"]][[\"page_timing.duration_time\",\"<\",100],\"and\",[[\"checks.large_page_size\",\"=\",false],\"or\",[\"checks.high_waiting_time\",\"=\",false]]]
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned pages
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned pages
optional field
default value: 0
maximum value: 2000000
if 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",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"meta.external_links_count,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"page_timing.dom_complete,asc\",\"size,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "resource URL
required field
you can get this URL in the response of the Resources endpoint
example:https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPagePagesRequestInfo": {
"properties": {
"filters": {
"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, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_likeyou can use the % operator with like and not_like to match any string of zero or more charactersexample:[\"meta.external_links_count\",\"<=\",50][\"url\",\"like\",\"https://dataforseo.com/apis/dataforseo-labs-api\"][[\"checks.high_waiting_time\",\"=\",false],\"and\",[\"resource_type\",\"=\",\"html\"]][[\"page_timing.duration_time\",\"<\",100],\"and\",[[\"checks.large_page_size\",\"=\",false],\"or\",[\"checks.high_waiting_time\",\"=\",false]]]The full list of possible filters is available by this link.",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the taskrequired fieldyou can get this ID in the response of the Task POST endpointexample:\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned pagesoptional fielddefault value: 100maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned pagesoptional fielddefault value: 0maximum value: 2000000if 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",
"type": [
"integer",
"null"
]
},
"order_by": {
"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 orderyou should use a comma to set up a sorting typeexample:[\"meta.external_links_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:[\"page_timing.dom_complete,asc\",\"size,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"search_after_token": {
"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 20,000 results in a single request;by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request",
"type": [
"string",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageRawHtmlRequestInfo": {
"properties": {
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"url": {
"description": "page url
required field
the absolute URL of a page to request HTML
Note: this field is optional if the task was set using the Instant Pages endpoint",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageRedirectChainsRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can use only one filtering parameter with this endpointis_redirect_loop
the following operators are supported:regex, not_regex, =, <>[\"is_redirect_loop\",\"=\",\"true\"][\"is_redirect_loop\",\"<>\",\"false\"]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned redirect chains
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned redirect chains
optional field
default value: 0
maximum value: 2000000
if you specify the 10 value, the first ten redirect chains in the results array will be omitted and the data will be provided for the successive redirect chains",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL
optional field
absolute URL of the target page
if you use this field, the API response will return only redirect chains which contain the specified URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageResourcesRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"resource_type\",\"=\",\"stylesheet\"][[\"resource_type\",\"=\",\"image\"],
\"and\",[\"checks.is_https\",\"=\",false]][[\"fetch_timing.duration_time\",\">\",1],\"and\",[[\"total_transfer_size\",\">\",100],\"or\",[\"checks.high_loading_time\",\"=\",true]]]
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned resources
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned resources
optional field
default value: 0
maximum value: 2000000
if you specify the 10 value, the first ten resources in the results array will be omitted and the data will be provided for the successive resources",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"size,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"size,desc\",\"fetch_timing.fetch_end,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"relevant_pages_filters": {
"description": "filter the resources by relevant pages
optional field
you can use this field to obtain resources from pages matching to the defined parameters
you can apply the same filters here as available for the pages endpoint
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"checks.no_image_title\",\"=\",true]",
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"array",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;
by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;
Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL
optional field
specify this field if you want to get the resources for a specific page
note that to obtain resource's meta from a particular URL, you should specify the URL in this field;
if you do not indicate a url when setting a task, resource's meta in the results will be returned based on the data from the page where our crawler first saw the resource",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageTaskPostRequestInfo": {
"properties": {
"accept_language": {
"description": "language header for accessing the website
optional field
all locale formats are supported (xx, xx-XX, xxx-XX, etc.)
Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\":\"broken in the response array",
"type": [
"string",
"null"
]
},
"allow_subdomains": {
"description": "include pages on subdomains
optional field
set to true if you want to crawl all subdomains of a target website
default value: false",
"type": [
"boolean",
"null"
]
},
"allowed_subdomains": {
"description": "subdomains to crawl
optional field
specify subdomains that you want to crawl
example: [\"blog.site.com\", \"my.site.com\", \"shop.site.com\"]
Note: to use this parameter, the allow_subdomains parameter should be set to false;
otherwise, the content of allowed_subdomains field will be ignored and the results will be returned for all subdomains",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"browser_preset": {
"description": "preset for browser screen parameters
optional field
if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2
Note: to use this parameter, set enable_javascript or enable_browser_rendering to true",
"type": [
"string",
"null"
]
},
"browser_screen_height": {
"description": "browser screen height
optional field
you can set a custom browser screen height to perform an audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;
Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240
maximum value, in pixels: 9999",
"type": [
"integer",
"null"
]
},
"browser_screen_scale_factor": {
"description": "browser screen scale factor
optional field
you can set a custom browser screen resolution ratio to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;
Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value: 0.5
maximum value: 3",
"type": [
"number",
"null"
]
},
"browser_screen_width": {
"description": "browser screen width
optional field
you can set a custom browser screen width to perform audit for a particular device;
if you use this field, you don't need to indicate browser_preset as it will be ignored;
Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240
maximum value, in pixels: 9999",
"format": "int64",
"type": [
"integer",
"null"
]
},
"calculate_keyword_density": {
"description": "calculate keyword density for the target domain
optional field
set to true if you want to calculate keyword density for website pages
default value: false
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article
once the crawl is completed, you can obtain keyword density values with the Keyword Density endpoint",
"type": [
"boolean",
"null"
]
},
"check_spell": {
"description": "check spelling
optional field
set to true to check spelling on a website using Hunspell library
default value: false",
"type": [
"boolean",
"null"
]
},
"check_spell_exceptions": {
"description": "words excluded from spell check
optional field
specify the words that you want to exclude from spell check
maximum word length: 100 characters
maximum amount of words: 1000
example: \"SERP\", \"minifiers\", \"JavaScript\"",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"check_spell_language": {
"description": "language of the spell check
optional field
supported languages: 'hy', 'eu', 'bg', 'ca', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'fo', 'fa', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'he', 'hu', 'is', 'ia', 'ga', 'it', 'rw', 'la', 'lv', 'lt', 'mk', 'mn', 'ne', 'nb', 'nn', 'pl', 'pt', 'ro', 'gd', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'tk', 'uk', 'vi'
Note: if no language is specified, it will be set automatically based on page content",
"type": [
"string",
"null"
]
},
"checks_threshold": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "custom threshold values for checks
optional field
you can specify custom threshold values for the parameters included in the checks object of OnPage API responses;
Note: only integer threshold values can be modified;
for example, the high_loading_time and large_page_size parameters are set to 3 seconds and 1 megabyte respectively by default;
if you want to change these thresholds to 1 second and 1000 kbytes, use the following snippet:
`\"checks_threshold\": {
\"high_loading_time\": 1,
\"large_page_size\": 1000
}`
available customizable parameters with default values:
`\"title_too_short\", default value: 30, type: \"int\"
\"title_too_long\", default value: 65, type: \"int\"
\"small_page_size\", default value: 1024, type: \"int\"
\"large_page_size\", default value: 1048576 (1024 * 1024), type: \"int\"
\"low_character_count\", default value: 1024, type: \"int\"
\"high_character_count\", default value: 256000 (250 * 1024), type: \"int\"
\"low_content_rate\", default value: 0.1, type: \"float\"
\"high_content_rate\", default value: 0.9, type: \"float\"
\"high_loading_time\", default value: 3000, type: \"int\"
\"high_waiting_time\", default value: 1500, type: \"int\"
\"low_readability_rate\", default value: 15.0, type: \"float\"
\"irrelevant_description\", default value: 0.2, type: \"float\"
\"irrelevant_title\", default value: 0.3, type: \"float\"
\"irrelevant_meta_keywords\", default value: 0.6, type: \"float\"`",
"type": [
"object",
"null"
]
},
"crawl_delay": {
"description": "delay between hits, ms
optional field
the custom delay between crawler hits to the server
default value: 2000",
"type": [
"integer",
"null"
]
},
"crawl_sitemap_only": {
"description": "crawl only pages indicated in the sitemap
optional field
set to true if you want to crawl only the pages indicated in the sitemap
if you set this parameter to true and do not specify custom_sitemap, we will crawl the default sitemap
default value: false
Note: if you want to use this parameter, respect_sitemap should be true",
"type": [
"boolean",
"null"
]
},
"custom_js": {
"description": "custom javascript
optional field
Note that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute:let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute(\"src\");rn if (src != undefined) {rn if (src.indexOf(\"analytics.js\") >= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf(\"gtm.js\") >= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script:
`meta = {}; meta.url = document.URL; meta.test = 'test'; meta;`
as a response you will receive the following data:
`\"custom_js_response\": {
\"url\": \"https://dataforseo.com/\",
\"test\": \"test\"
}`
Note: the length of the script you enter must be no more than 2000 characters",
"type": [
"string",
"null"
]
},
"custom_robots_txt": {
"description": "custom robots.txt settings
optional field
example: Disallow: /directory1/",
"type": [
"string",
"null"
]
},
"custom_sitemap": {
"description": "custom sitemap url
optional field
the URL of the page where the alternative sitemap is located
Note: if you want to use this parameter, respect_sitemap should be true",
"type": [
"string",
"null"
]
},
"custom_user_agent": {
"description": "custom user agent
optional field
custom user agent for crawling a website
example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
default value: Mozilla/5.0 (compatible; RSiteAuditor)",
"type": [
"string",
"null"
]
},
"disable_cookie_popup": {
"description": "disable the cookie popup
optional field
set to true if you want to disable the popup requesting cookie consent from the user;
default value:false",
"type": [
"boolean",
"null"
]
},
"disable_page_checks": {
"description": "prevent certain page checks from running
optional field
specify certain checks to prevent them from running and impacting the onpage_scoreexample:\"disable_page_checks\": [\"is_5xx_code\", \"is_4xx_code\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"disable_sitewide_checks": {
"description": "prevent certain sitewide checks from running
optional field
specify the following checks to prevent them from running on the target website:\"test_page_not_found\"\"test_canonicalization\"\"test_https_redirect\"\"test_directory_browsing\"example:\"disable_sitewide_checks\": [\"test_directory_browsing\", \"test_page_not_found\"]learn more on our help center",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"disallowed_subdomains": {
"description": "subdomains not to crawl
optional field
specify subdomains that you don't want to crawl
example: [\"status.site.com\", \"docs.site.com\"]
Note: to use this parameter, the allow_subdomains parameter should be set to true",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"enable_browser_rendering": {
"description": "emulate browser rendering to measure Core Web Vitals
optional field
by using this parameter you will be able to emulate a browser when loading a web page;enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;
default value: false
set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;
if you use this field, enable_javascript, and load_resources parameters must be set to true
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"enable_content_parsing": {
"description": "parse content on crawled pages
optional field
set to true to use the OnPage Content Parsing endpoint
default value: false",
"type": [
"boolean",
"null"
]
},
"enable_javascript": {
"description": "load javascript on a page
optional field
set to true if you want to load the scripts available on a page
default value: false
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"enable_www_redirect_check": {
"description": "check if the domain implemented the www redirection
optional field
set to true if you want to check if the requested domain implemented the www to non-www or non-www to www redirect;
default value: false",
"type": [
"boolean",
"null"
]
},
"enable_xhr": {
"description": "enable XMLHttpRequest on a page
optional field
set to true if you want our crawler to request data from a web server using the XMLHttpRequest object
default value: false;if you use this field, enable_javascript must be set to true;",
"type": [
"boolean",
"null"
]
},
"force_sitewide_checks": {
"description": "enable sitewide checks when crawling a single page
optional field
set to true to get data on sitewide checks when crawling a single page;
default value: false",
"type": [
"boolean",
"null"
]
},
"load_resources": {
"description": "load resources
optional field
set to true if you want to load image, stylesheets, scripts, and broken resources
default value: false
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page",
"type": [
"boolean",
"null"
]
},
"max_crawl_depth": {
"description": "crawl depth
optional field
the linking depth of the pages to crawl;
for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc.",
"type": [
"integer",
"null"
]
},
"max_crawl_pages": {
"description": "crawled pages limit
required field
the number of pages to crawl on the specified domain
Note:
if you set max_crawl_pages to 1 and do not specify start_url or set a homepage in it, the following sitewide checks will be disabled:test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirect
to enable them anyway, set force_sitewide_checks to trueif you set max_crawl_pages to 1 and specify start_url other than a homepage, all sitewide checks will be disabled;
to enable them anyway, set force_sitewide_checks to true",
"type": "integer"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
URLs specified in this array will be crawled in the first instance, bypassing the crawling queue;
Note: you should specify the absolute URL;
you can specify up to 20 URLs;
all URLs in the array must belong to the target domain;
subdomains will be ignored unless the allow_subdomains parameter is set to trueexample:
`\"priority_urls\": [
\"https://dataforseo.com/apis/serp-api\",
\"https://dataforseo.com/contact\"
]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"respect_sitemap": {
"description": "respect sitemap when crawling
optional field
set to true if you want to follow the order of pages indicated in the primary sitemap when crawling;
default value: false
Note: if set to true, the click_depth value in the API response will equal 0;
the max_crawl_depth field of the request will be ignored, you can specify the number of pages to crawl using the max_crawl_pages parameter",
"type": [
"boolean",
"null"
]
},
"return_despite_timeout": {
"description": "return data on pages despite the timeout error
optional field
if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;
default value: false",
"type": [
"boolean",
"null"
]
},
"robots_txt_merge_mode": {
"description": "merge with or override robots.txt settings
optional field
possible values: merge, override;
set to override if you want to ignore website crawling restrictions and other robots.txt settings
default value: merge;
Note: if set to override, specify the custom_robots_txt parameter",
"type": [
"string",
"null"
]
},
"start_url": {
"description": "the first url to crawl
optional field
Note: you should specify an absolute URL
if you want to crawl a single page, specify its URL in this field and additionally set the max_crawl_pages parameter to 1
you can also use the live Instant Pages endpoint to get page-specific data",
"type": [
"string",
"null"
]
},
"store_raw_html": {
"description": "store HTML of crawled pages
optional field
set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint
default value: false",
"type": [
"boolean",
"null"
]
},
"support_cookies": {
"description": "support cookies on crawled pages
optional field
set to true to support cookies when crawling the pages
default value: false",
"type": [
"boolean",
"null"
]
},
"switch_pool": {
"description": "switch proxy pool
optional field
if true, additional proxy pools will be used to obtain the requested data;
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors",
"type": [
"boolean",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain
required field
domain name should be specified without https:// and www.
if you specify the page URL, the results will be returned for the domain included in the URL",
"type": "string"
},
"validate_micromarkup": {
"description": "enable microdata validation
optional field
set to true if you want to use the OnPage API Microdata endpoint
default value: false",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageUncrawlableResourcesRequestInfo": {
"properties": {
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example: [[\"meta.content_type\",\"=\",\"image/jpeg\"],
\"and\",
[\"url\",\"not_like\",\"%/help-center/%\"]]
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"limit": {
"description": "the maximum number of returned uncrawlable resources
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned uncrawlable resources
optional field
default value: 0
maximum value: 2000000
if you specify the 10 value, the first ten invalid resources in the results array will be omitted and the data will be provided for the successive invalid resources",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"meta.content_type,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"meta.content_type,asc\",\"fetch_time,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_OnPageWaterfallRequestInfo": {
"properties": {
"id": {
"description": "ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
\"07131248-1535-0216-1000-17384017ad04\"",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL
required field
specify the pages you want to receive timing for",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpAiSummaryRequestInfo": {
"properties": {
"fetch_content": {
"description": "fetch content from pages in SERPs
optional field
if set to true, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;
default value: false",
"type": [
"boolean",
"null"
]
},
"include_links": {
"description": "include source links in the summary
optional field
if set to true, the summary field in the API response will contain links to sources of the generated summary;
default value: false",
"type": [
"boolean",
"null"
]
},
"prompt": {
"description": "AI prompt
optional field
additional task for AI summariser;
any form of text, question or information that communicates to AI what response you're looking for;
max number of symbols or characters you can specify: 2000;
note: your prompt has to be relevant to the keyword specified in the POST request to SERP API",
"type": [
"string",
"null"
]
},
"support_extra": {
"description": "support extra SERP features
optional field
if set to true, the AI model will consider the following extra SERP features, in addition to organic results: answer_box, knowledge_graph, featured_snippet;
default value: true",
"type": [
"boolean",
"null"
]
},
"task_id": {
"description": "task identifier
required field
unique identifier of the associated task in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo": {
"properties": {
"match_type": {
"description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard",
"type": [
"string",
"null"
]
},
"match_value": {
"description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpBaiduOrganicTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 10
max value: 700
Your account will be billed per each SERP containing up to 10 results;
Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
return results for a specific device type
can take the values: desktop, mobile, tablet
default value: desktop",
"type": [
"string",
"null"
]
},
"get_website_url": {
"description": "include direct URL for each ranked result
optional field
if set to true, the returned results will contain direct URLs of the ranked websites
by default, the URLs in Baidu results are encoded by the search engine,
for example:http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kLdefault value: false
Note: if set to true, the charge per task will be multiplied by 10 as our system runs a separate request for each ranked website to return its direct URL",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified) with the zh_CN language code. However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatoryzh_CN",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified). However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatoryChinese (Simplified)",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2156",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, we don't recommend using this field as the results might not be relevant to the specified coordinates
example:53.476225,-2.243572,200",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:New York,New York,United States",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 100
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android
if you specify tablet in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:regular, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priority
You will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpBingOrganicLiveAdvancedRequestInfo": {
"properties": {
"browser_screen_height": {
"description": "240-9999;1080 for desktop;640 for mobile on android;812 for mobile on iOS;calculate_rectangles to true0.5-3;1 for desktop;3 for mobile on android;3 for mobile on iOS;calculate_rectangles to true240-9999;1920 for desktop;360 for mobile on android;375 for mobile on iOS;calculate_rectangles to truefalse10200
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktopkeyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format53.476225,-2.243572location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdomstop_crawl_on_match is specifiedmatch_valuedomain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard patternstop_crawl_on_match is specified\"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"1100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidtag value in the data object of the responsehttps:// and www.target-specific tasks will only include SERP elements that contain a url string;example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified stringhttps://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE10200
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktopkeyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format53.476225,-2.243572location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdomstop_crawl_on_match is specifiedmatch_valuedomain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard patternstop_crawl_on_match is specified\"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"1100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidtag value in the data object of the responsehttps://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE10200
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktopkeyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format53.476225,-2.243572location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdomstop_crawl_on_match is specifiedmatch_valuedomain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard patternstop_crawl_on_match is specified\"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"1100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidtag value in the data object of the responsehttps:// and www.target-specific tasks will only include SERP elements that contain a url string;example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified stringhttps://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE240-9999;1080 for desktop;640 for mobile on android;812 for mobile on iOS;calculate_rectangles to true0.5-3;1 for desktop;3 for mobile on android;3 for mobile on iOS;calculate_rectangles to true240-9999;1920 for desktop;360 for mobile on android;375 for mobile on iOS;calculate_rectangles to truefalse10700
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktopkeyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" format53.476225,-2.243572location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdomstop_crawl_on_match is specifiedmatch_valuedomain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard patternstop_crawl_on_match is specified\"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"1100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroid$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urlregular, advanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the responsehttps://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGEkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center articlelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/ads_advertisers/locations2840location_name, location_code, or location_coordinate, advertisers will be searched across all the available locationslocation_name or location_code52.6178549,-155.352142location_name, location_code, or location_coordinate, advertisers will be searched across all the available locationslocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/ads_advertisers/locationsLondon,England,United Kingdomlocation_name, location_code, or location_coordinate, advertisers will be searched across all the available locations$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvancedgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the responsetarget is not specifiedadvertiser_ids values for this parameter can be found in the Google Ads Advertisers endpoint;date_to is specified; \"yyyy-mm-dd\"\"2020-01-01\"date_from is specified; \"yyyy-mm-dd\"\"2020-01-01\"40700
Your account will be billed per each SERP containing up to 40 results;all, text, image, videolocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/ads_search/locations2840location_name, location_code, or location_coordinate, the ads will be searched across all the available locationslocation_name or location_code52.6178549,-155.352142location_name, location_code, or location_coordinate, the ads will be searched across all the available locationslocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/ads_search/locationsLondon,England,United Kingdomlocation_name, location_code, or location_coordinate, the ads will be searched across all the available locations$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23all, google_play, google_maps, google_search, google_shopping, youtubeallpostback_urladvancedgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the responseadvertiser_ids is not specified240-9999;1080 for desktop;640 for mobile on android;812 for mobile on iOS;calculate_rectangles to true0.5-3;1 for desktop;3 for mobile on android;3 for mobile on iOS;calculate_rectangles to true240-9999;1920 for desktop;360 for mobile on android;375 for mobile on iOS;calculate_rectangles to truefalsetrue, the charge per task will be multiplied by 2desktop, mobiledesktopkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_name;language_name;language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languageslanguage_code;language_code;language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languages;location_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationslocation_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format52.6178549,-155.352142,18zlocation_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsdesktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidtag value in the data object of the response
optional field
return results for a specific device type
can take the values:desktop, mobile
default value: desktop",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character '+' will be decoded to a space character)
if you need to use the \"%\" character for your keyword, please specify it as \"%25\";
if you need to use the “+” character for your keyword, please specify it as “%2B”;",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languagesn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languages;",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:London,England,United Kingdom",
"type": "string"
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpGoogleAiModeTaskPostRequestInfo": {
"properties": {
"browser_screen_height": {
"description": "240-9999;1080 for desktop;640 for mobile on android;812 for mobile on iOS;calculate_rectangles to true0.5-3;1 for desktop;3 for mobile on android;3 for mobile on iOS;calculate_rectangles to true240-9999;1920 for desktop;360 for mobile on android;375 for mobile on iOS;calculate_rectangles to truefalsetrue, the charge per task will be multiplied by 2desktop, mobiledesktopkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_name;language_name;language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languageslanguage_code;language_code;language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languages;location_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationslocation_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format52.6178549,-155.352142,18zlocation_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsdesktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroid$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the responsechrome — used when google search is opened in google chrome;chrome-omni — used in the address bar in chrome;gws-wiz — used in google search home page;gws-wiz-serp — used in google search engine results page;safari — used when google search is opened in safari browser;firefox — used when google search is opened in firefox browser;psy-ab — may be used when google search is opened in google chrome browser;toolbar — returns XML;youtube — returns JSONP;gws-wiz-local — used in google local;img — used in google's image search;products-cc — used in google shopping search0keyword|which query are s - \"cursor_pointer\": 0which query is s| - \"cursor_pointer\": 16which que|ry is s - \"cursor_pointer\": 9keyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_name;language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_code;language_name by making a separate request to https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_name;location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_code;location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/autocomplete/locationsLondon,England,United Kingdomtag value in the data object of the responsechrome — used when google search is opened in google chrome;chrome-omni — used in the address bar in chrome;gws-wiz — used in google search home page;gws-wiz-serp — used in google search engine results page;safari — used when google search is opened in safari browser;firefox — used when google search is opened in firefox browser;psy-ab — may be used when google search is opened in google chrome browser;toolbar — returns XML;youtube — returns JSONP;gws-wiz-local — used in google local;img — used in google's image search;products-cc — used in google shopping search0keyword|which query are s - \"cursor_pointer\": 0which query is s| - \"cursor_pointer\": 16which que|ry is s - \"cursor_pointer\": 9keyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_name;language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_code;language_name by making a separate request to https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_name;location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_code;location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/autocomplete/locationsLondon,England,United Kingdom$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvancedgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be url-encoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority;tag value in the data object of the responsedataset item of Google Dataset Search resultL2cvMTFqbl85ZHN6MQ==desktoplanguage_nameenlanguage_codeEnglishwindows, macoswindowstag value in the data object of the responsedataset item of Google Dataset Search resultL2cvMTFqbl85ZHN6MQ==desktoplanguage_nameenlanguage_codeEnglishwindows, macoswindows$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvancedgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the response20200
Your account will be billed per each SERP containing up to 20 results;desktopother, archive, text, image, document, tabulartrue, falsekeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_nameenlanguage_codeEnglish1m, 1y, 3ywindows, macoswindowstag value in the data object of the responsehumanities, social_sciences, life_sciences, agriculture, natural_sciences, geo, computer, architecture_and_urban_planning, engineeringcommercial, noncommercial20700
Your account will be billed per each SERP containing up to 20 results;desktopother, archive, text, image, document, tabulartrue, falsekeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”.keyword and keywords fields in DataForSEO APIs in this Help Center articleenlanguage_codeEnglish1m, 1y, 3ywindows, macoswindows$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvancedgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the responsehumanities, social_sciences, life_sciences, agriculture, natural_sciences, geo, computer, architecture_and_urban_planning, engineeringcommercial, noncommercialdesktoplanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomtop_stories, local_market, world_marketstop_storieslocal_market or world_markets, the charge per task will be multiplied by 2windowstag value in the data object of the responsedesktoplanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomtop_stories, local_market, world_marketstop_storieswindowstag value in the data object of the responsedesktoplanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomtop_stories, local_market, world_marketstop_storieslocal_market or world_markets, the charge per task will be multiplied by 2windows$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority;tag value in the data object of the responsedesktoplanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdommost-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currenciesmost-activewindowstag value in the data object of the responsedesktoplanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdommost-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currenciesmost-activewindowstag value in the data object of the responsedesktoplanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdommost-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currenciesmost-activewindows$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority;tag value in the data object of the responsedesktopkeyword field;keyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomwindowstag value in the data object of the responsegoogle_finance_quote graph1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX1D1D, the charge per task will be multiplied by 2desktopkeyword field;keyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomwindowstag value in the data object of the responsegoogle_finance_quote graph1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX1Ddesktopkeyword field;keyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomwindows$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority;tag value in the data object of the responsegoogle_finance_quote graph1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX1D1D, the charge per task will be multiplied by 2all, stock, index, mutual_fund, currency, futuresallkeyword field;keyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomtag value in the data object of the responseall, stock, index, mutual_fund, currency, futuresallkeyword field;keyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_code language_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_namelocation_namelocation_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations2840location_codelocation_codelocation_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdom$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority;tag value in the data object of the response100200
Your account will be billed per each SERP containing up to 100 results;keyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;windows, macoswindowstag value in the data object of the responsehttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS100200
Your account will be billed per each SERP containing up to 100 results;keyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;windows, macoswindowstag value in the data object of the responsehttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS100700
Your account will be billed per each SERP containing up to 100 results;keyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;windows, macoswindows$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the responsehttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS10200
Your account will be billed per each SERP containing up to 10 results;fulltime, partime, contractor, internkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;.net developerkeyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_name;language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_code;language_name by making a separate request to https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_name;location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/jobs/locations2840location_codelocation_code;location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/jobs/locationsLondon,England,United Kingdom1.609;300> 0$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urlregular, advanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority;tag value in the data object of the response10100
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktopkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesenlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format52.6178549,-155.352142,20zlocation_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdomdesktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroid
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the response10100
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktopkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”language_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesenlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format52.6178549,-155.352142,20zlocation_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdomdesktop: 3.5, 4, 4.5;mobile: 2, 2.5, 3, 3.5, 4, 4.5desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidtag value in the data object of the response\"open_now\", \"24_hours\", \"$day_value\", \"$day_value;$time_value\";$day_value use one of these values: \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\", \"sunday\";$time_value use one of these values: \"00\", \"01\", \"02\", \"03\", \"04\", \"05\", \"06\", \"07\", \"08\", \"09\", \"10\", \"11\", \"12\", \"13\", \"14\", \"15\", \"16\", \"17\", \"18\", \"19\", \"20\", \"21\", \"22\", \"23\"\"tuesday;18\"10350
your account will be billed per each SERP containing up to 10 results;
setting depth above 10 may result in additional charges if the search engine returns more than 10 results respectively;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "desktop, mobiledesktopkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesenlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format52.6178549,-155.352142,18zlocation_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdomdesktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroid$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the response100700
Your account will be billed per each SERP containing up to 100 results;desktop, mobiledesktopmobile device, only 20 results are returned for every SERPkeyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format52.6178549,-155.352142,20zlocation_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidgoogle.co.uk, google.com.au, google.de, etc.false;truesearch_places mode is turned off and no results were found in the search area, the results array will be emptytrue, falsetruefalse, the search_this_area mode will be turned offsearch_this_area mode is turned off, Google Maps listings might contain results beyond the displayed areatag value in the data object of the responsehttps://google.com/maps/search/pizza/@37.09024,-95.712891,4z
Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: allinanchor:, allintext:, allintitle:, allinurl:, cache:, define:, definition:, filetype:, id:, inanchor:, info:, intext:, intitle:, inurl:, link:, site:.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpGoogleMapsTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "100700
Your account will be billed per each SERP containing up to 100 results;desktop, mobiledesktopmobile device, only 20 results are returned for every SERPkeyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format52.6178549,-155.352142,20zlocation_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroid$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvancedgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.google.co.ukfalse;default value: truesearch_places mode is turned off and no results were found in the search area, the results array will be emptytrue, falsetruefalse, the search_this_area mode will be turned offsearch_this_area mode is turned off, Google Maps listings might contain results beyond the displayed areatag value in the data object of the responsehttps://google.com/maps/search/pizza/@37.09024,-95.712891,4z
Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: allinanchor:, allintext:, allintitle:, allinurl:, cache:, define:, definition:, filetype:, id:, inanchor:, info:, intext:, intitle:, inurl:, link:, site:.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpGoogleNewsLiveAdvancedRequestInfo": {
"properties": {
"browser_screen_height": {
"description": "1080;calculate_rectangles to true1;calculate_rectangles to true1920;calculate_rectangles to truefalsetrue, the charge per task will be multiplied by 210200
Your account will be billed per each SERP containing up to 10 results;keyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;windows, macoswindowsgoogle.co.uk, google.com.au, google.de, etc.https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS10200
Your account will be billed per each SERP containing up to 10 results;keyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;windows, macoswindowsgoogle.co.uk, google.com.au, google.de, etc.tag value in the data object of the responsehttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS1080;calculate_rectangles to true1;calculate_rectangles to true1920;calculate_rectangles to truefalsetrue, the charge per task will be multiplied by 210700
Your account will be billed per each SERP containing up to 10 results;keyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;windows, macoswindows$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.tag value in the data object of the responsehttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS10200
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktoptrue to expand the ai_overview item;falsestop_crawl_on_match must also be enabledurl and domain fields are checked for targetsorganic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterignore_targets_in\"find_targets_in\": [\"organic\", \"featured_snippet\"]stop_crawl_on_match must also be enabledorganic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterfind_targets_in\"ignore_targets_in\": [\"paid\", \"images\"]keyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;language_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishtrue to obtain ai_overview items is SERPs even if they are loaded asynchronously;false, you will only obtain ai_overview items from cache;false\"asynchronous_ai_overview\": false, all extra charges will be returned to your account balancelocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomstop_crawl_on_match is specifiedmatch_valuedomain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard patternstop_crawl_on_match is specified\"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidgoogle.co.uk, google.com.au, google.de, etc.
Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "tag value in the data object of the responsestop_crawl_on_match must also be enabledstop_crawl_on_matchall, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is foundanyhttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpGoogleOrganicLiveRegularRequestInfo": {
"properties": {
"depth": {
"description": "10200
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktopstop_crawl_on_match must also be enabledurl and domain fields are checked for targetsorganic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterignore_targets_in\"find_targets_in\": [\"organic\", \"featured_snippet\"]true, the related_result element in the response will be provided as a snippet of its parent organic result;false, the related_result element will be provided as a separate organic result;truestop_crawl_on_match must also be enabledorganic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterfind_targets_in\"ignore_targets_in\": [\"paid\", \"images\"]keyword fieldkeyword, please specify it as \"%25\";keyword, please specify it as “%2B”;language_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomstop_crawl_on_match is specifiedmatch_valuedomain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard patternstop_crawl_on_match is specified\"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidgoogle.co.uk, google.com.au, google.de, etc.
Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "tag value in the data object of the responsehttps:// and www.target-specific tasks will only include SERP elements that contain a url string;example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified stringstop_crawl_on_match must also be enabledstop_crawl_on_matchall, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is foundanyhttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpGoogleOrganicTaskPostRequestInfo": {
"properties": {
"browser_screen_height": {
"description": "240-9999;1080 for desktop;640 for mobile on android;812 for mobile on iOS;calculate_rectangles to true0.5-3;1 for desktop;3 for mobile on android;3 for mobile on iOS;calculate_rectangles to true240-9999;1920 for desktop;360 for mobile on android;375 for mobile on iOS;calculate_rectangles to truefalse10700
Your account will be billed per each SERP containing up to 10 results;desktop, mobiledesktoptrue to expand the ai_overview item;false;stop_crawl_on_match must also be enabledurl and domain fields are checked for targetsorganic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterignore_targets_in\"find_targets_in\": [\"organic\", \"featured_snippet\"]true, the related_result element in the response will be provided as a snippet of its parent organic result;false, the related_result element will be provided as a separate organic result;truestop_crawl_on_match must also be enabledorganic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterfind_targets_in\"ignore_targets_in\": [\"paid\", \"images\"]keyword fieldkeyword, please specify it as “%25”;keyword, please specify it as “%2B”;keyword and keywords fields in DataForSEO APIs in this Help Center articlelanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesEnglishtrue to obtain ai_overview items is SERPs even if they are loaded asynchronously;false, you will only obtain ai_overview items from cache;false\"asynchronous_ai_overview\": false, all extra charges will be returned to your account balancelocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsLondon,England,United Kingdomstop_crawl_on_match is specifiedmatch_valuedomain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard patternstop_crawl_on_match is specified\"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"100max_crawl_pages and depth parameters complement each other;desktop in the device field, choose from the following values: windows, macoswindowsmobile in the device field, choose from the following values: android, iosandroidpeople_also_ask element to get additional people_also_ask_element items;1 to 4$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urlregular, advanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requesthttp://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.\"remove_from_url\": [\"srsltid\"]google.co.uk, google.com.au, google.de, etc.
Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "tag value in the data object of the responsestop_crawl_on_match must also be enabledstop_crawl_on_matchall, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is foundanyhttps://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpGoogleSearchByImageTaskPostRequestInfo": {
"properties": {
"browser_screen_height": {
"description": "1080;calculate_rectangles to true1;calculate_rectangles to true1920;calculate_rectangles to truefalsetrue, the charge per task will be multiplied by 2https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpglanguage_namelanguage_namelanguage_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesexample:enlanguage_codelanguage_codelanguage_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesEnglishlocation_name or location_coordinatelocation_name or location_coordinatelocation_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations2840location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200location_code or location_coordinatelocation_code or location_coordinatelocation_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locationsLondon,England,United Kingdom100max_crawl_pages and depth parameters complement each other;$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url will be urlencoded;# character will be encoded into %23postback_urladvanced, htmlgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23
You will be additionally charged for the tasks with high execution priority.google.co.uk, google.com.au, google.de, etc.tag value in the data object of the response
optional field
number of results in SERP
default value: 15
max value: 700
Your account will be billed per each SERP containing up to 15 results;
Setting depth above 15 may result in additional charges if the search engine returns more than 15 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
return results for a specific device type
can take the values:desktop, mobile
default value: desktop",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 100
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:regular, advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically
however, you can set a custom search engine domain in this field
example:
optional field
get the list of available parameters and additional details here",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields
in most cases, we wouldn’t recommend using this method;
example:https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpScreenshotRequestInfo": {
"properties": {
"browser_preset": {
"description": "browser resolution preset
optional field
browser preset associated with a certain device type
can take the following values: desktop, tablet, mobile
Note: by default, browser preset corresponds to the device type specified in the POST request",
"type": [
"string",
"null"
]
},
"browser_screen_height": {
"description": "height of the browser resolution
optional field
can be specified in the following range: 240-9999
default value for desktop: 1080
default value for mobile: 844
default value for table: 1366",
"type": [
"integer",
"null"
]
},
"browser_screen_scale_factor": {
"description": "browser scale factor
optional field
can be specified in the following range: 0.5-3
default value for desktop: 1
default value for mobile: 3
default value for table: 2",
"type": [
"number",
"null"
]
},
"browser_screen_width": {
"description": "width of the browser resolution
optional field
can be specified in the following range: 240-9999
default value for desktop: 1920
default value for mobile: 390
default value for table: 1024",
"format": "int64",
"type": [
"integer",
"null"
]
},
"page": {
"description": "number of SERP pages
optional field
if depth in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;
default value: 1",
"type": [
"integer",
"null"
]
},
"task_id": {
"description": "task identifier
required field
unique identifier of the associated task in the UUID format
you will be able to use it within 7 days to request the results of the task at any time",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpSeznamOrganicTaskPostRequestInfo": {
"properties": {
"calculate_rectangles": {
"description": "calculate pixel rankings for SERP elements in advanced results
optional field
pixel ranking refers to the distance between the result snippet and top left corner of the screen;
Visit Help Center to learn more>>
by default, the parameter is set to false
Note: if set to true, the charge per task will be multiplied by 2",
"type": [
"boolean",
"null"
]
},
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 10;
maximum value: 500;
Your account will be billed per each SERP containing up to 10 results;
Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
return results for a specific device type
can take the values:desktop, mobile
default value: desktop",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:csn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:Czech",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:London,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 10
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:regular, advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priority
You will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically
however, you can set a custom search engine domain in this field
example:
optional field",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields;
note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL;
in most cases, we wouldn’t recommend using this method.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYahooOrganicLiveAdvancedRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 6
max value: 200
Your account will be billed per each SERP;
Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges ;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
return results for a specific device type
can take the values:desktop, mobile
default value: desktop",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character '+' will be decoded to a space character)
if you need to use the \"%\" character for your keyword, please specify it as \"%25\";
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:London,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 100
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
get the list of available parameters and additional details here",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain, subdomain, or webpage to get results for
optional field
a domain or a subdomain should be specified without https:// and www.
note that the results of target-specific tasks will only include SERP elements that contain a url string;
you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com; example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYahooOrganicLiveHtmlRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 10
max value: 200
Your account will be billed per each SERP containing up to 10 results;
Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
return results for a specific device type
can take the values:desktop, mobile
default value: desktop",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character '+' will be decoded to a space character)
if you need to use the \"%\" character for your keyword, please specify it as \"%25\";
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:London,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 100
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
get the list of available parameters and additional details here",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYahooOrganicLiveRegularRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 6
max value: 200
Your account will be billed per each SERP;
Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges ;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
can take the values:desktop, mobile
default value: desktop",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character '+' will be decoded to a space character)
if you need to use the \"%\" character for your keyword, please specify it as \"%25\";
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:London,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 100
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
get the list of available parameters and additional details here",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain, subdomain, or webpage to get results for
optional field
a domain or a subdomain should be specified without https:// and www.
note that the results of target-specific tasks will only include SERP elements that contain a url string;
you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com; example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYahooOrganicTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 6
max value: 700
Your account will be billed per each SERP;
Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges ;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
return results for a specific device type
can take the values:desktop, mobile
default value: desktop",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character '+' will be decoded to a space character)
if you need to use the \"%\" character for your keyword, please specify it as \"%25\";
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:2840n",
"type": "integer"
},
"location_coordinate": {
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n",
"type": "string"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:London,England,United Kingdom",
"type": "string"
},
"max_crawl_pages": {
"description": "page crawl limit
optional field
number of search results pages to crawl
default value: 1
max value: 100
Note: the max_crawl_pages and depth parameters complement each other;
learn more at our help center",
"type": [
"integer",
"null"
]
},
"os": {
"description": "device operating system
optional field
if you specify desktop in the device field, choose from the following values: windows, macos
default value: windows
if you specify mobile in the device field, choose from the following values: android, ios
default value: android",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:regular, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query
optional field
get the list of available parameters and additional details here",
"type": [
"string",
"null"
]
},
"stop_crawl_on_match": {
"description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Provider0A3E90081762_SerpApiStopCrawlOnMatchInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"url": {
"description": "direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeOrganicLiveAdvancedRequestInfo": {
"properties": {
"block_depth": {
"description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States",
"type": [
"string",
"null"
]
},
"os": {
"description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android",
"type": [
"string",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D",
"type": [
"string",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeOrganicTaskPostRequestInfo": {
"properties": {
"block_depth": {
"description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 700\nNote: your account will be billed per each SERP containing up to 20 blocks of results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States",
"type": [
"string",
"null"
]
},
"os": {
"description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"search_param": {
"description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D",
"type": [
"string",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeVideoCommentsLiveAdvancedRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth
optional field
number of results in SERP
default value: 20
max value: 200
Note: your account will be billed per each SERP containing up to 20 results;
thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results;
if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type
optional field
only value: desktop",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name_
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations
example:2840n",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations
example:United States",
"type": "string"
},
"os": {
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video
required field
you can find video ID in the URL or 'youtube_video' item of YouTube Organic result
example:vQXvyV0zIP4",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeVideoCommentsTaskPostRequestInfo": {
"properties": {
"depth": {
"description": "parsing depth\noptional field\nnumber of results in SERP\ndefault value: 20\nmax value: 700\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
"type": [
"integer",
"null"
]
},
"device": {
"description": "device type\noptional field\nonly value: desktop",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States",
"type": [
"string",
"null"
]
},
"os": {
"description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeVideoInfoLiveAdvancedRequestInfo": {
"properties": {
"device": {
"description": "device type\noptional field\nonly value: desktop",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States",
"type": [
"string",
"null"
]
},
"os": {
"description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows",
"type": [
"string",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeVideoInfoTaskPostRequestInfo": {
"properties": {
"device": {
"description": "device type\noptional field\nonly value: desktop",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States",
"type": [
"string",
"null"
]
},
"os": {
"description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeVideoSubtitlesLiveAdvancedRequestInfo": {
"properties": {
"device": {
"description": "device type\noptional field\nonly value: desktop",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States",
"type": [
"string",
"null"
]
},
"os": {
"description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows",
"type": [
"string",
"null"
]
},
"subtitles_language": {
"description": "language code of original text\nyou can get the language code from YouTube Video Info result",
"type": [
"string",
"null"
]
},
"subtitles_translate_language": {
"description": "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\"",
"type": [
"string",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms",
"type": "string"
}
},
"type": "object"
},
"Provider0A3E90081762_SerpYoutubeVideoSubtitlesTaskPostRequestInfo": {
"properties": {
"device": {
"description": "device type\noptional field\nonly value: desktop",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States",
"type": [
"string",
"null"
]
},
"os": {
"description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"subtitles_language": {
"description": "language code of original text\nyou can get the language code from YouTube Video Info result",
"type": [
"string",
"null"
]
},
"subtitles_translate_language": {
"description": "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\"",
"type": [
"string",
"null"
]
},
"tag": {
"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",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms",
"type": "string"
}
},
"type": "object"
},
"Response0A3E90081762_AboutThisResultElement": {
"deprecated": true,
"properties": {
"language": {
"description": "the language of the result",
"type": [
"string",
"null"
]
},
"location": {
"description": "location for which the result is relevant",
"type": [
"string",
"null"
]
},
"related_terms": {
"description": "related search terms that appear in the result",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_terms": {
"description": "matching search terms that appear in the result",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"source": {
"description": "source of additional information about the result",
"type": [
"string",
"null"
]
},
"source_info": {
"description": "additional information about the result\ndescription of the website from Wikipedia or another additional context",
"type": [
"string",
"null"
]
},
"source_url": {
"description": "URL to full information from the 'source'",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "result’s URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AbsoluteItems": {
"properties": {
"geo_id": {
"description": "location identifier
you can use this field for matching obtained results with location parameters specified in the request
see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
example:US-NY",
"type": [
"string",
"null"
]
},
"geo_name": {
"description": "location name
you can use this field for matching obtained results with location parameters specified in the request
see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
example:Andorra",
"type": [
"string",
"null"
]
},
"values": {
"description": "contains data on relative keyword popularity by country or region",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AdLinkElement": {
"properties": {
"ad_aclk": {
"description": "the identifier of the ad",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the link",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in SERP",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "reference page URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AddressInfo": {
"properties": {
"address": {
"description": "street address of the local establishment",
"type": [
"string",
"null"
]
},
"borough": {
"description": "administrative unit or district the local establishment belongs to",
"type": [
"string",
"null"
]
},
"city": {
"description": "name of the city where the local establishment is located",
"type": [
"string",
"null"
]
},
"country_code": {
"description": "ISO country code of the local establishment",
"type": [
"string",
"null"
]
},
"region": {
"description": "DMA region the local establishment belongs to",
"type": [
"string",
"null"
]
},
"zip": {
"description": "ZIP code of the local establishment",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AdsSearch": {
"properties": {
"advertiser_id": {
"description": "unique identifier of the advertiser account",
"type": [
"string",
"null"
]
},
"creative_id": {
"description": "unique identifier of the advertisement",
"type": [
"string",
"null"
]
},
"first_shown": {
"description": "date and time when the ad was shown for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”",
"type": [
"string",
"null"
]
},
"format": {
"description": "format of the advertisement
possible values: text, image, video",
"type": [
"string",
"null"
]
},
"last_shown": {
"description": "date and time when the ad was shown the last time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”",
"type": [
"string",
"null"
]
},
"preview_image": {
"description": "preview image of the advertisement",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PreviewImage"
}
],
"type": [
"object",
"null"
]
},
"preview_url": {
"description": "url pointing to the ad preview",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
},
"verified": {
"description": "verified advertiser account
equals true if advertiser account is verified by Google Ads",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Advertiser": {
"properties": {
"advertiser_id": {
"description": "unique identifier of the advertiser account
can be used to obtain data on advertising campaigns from the Google Ads Search endpoint",
"type": [
"string",
"null"
]
},
"approx_ads_count": {
"description": "ads count
the approximate number of ads that are run by the advertiser account across all available Google Ads platforms",
"format": "int64",
"type": [
"integer",
"null"
]
},
"location": {
"description": "location of the advertiser account
country code associated with the advertiser account",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"verified": {
"description": "verified advertiser account
equals true if advertiser account is verified by Google Ads",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AggregatedMetricsInfoTotalInfo": {
"properties": {
"ai_search_volume": {
"description": "aggregated AI search volume for mentions within this grouping
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"mentions": {
"description": "total LLM mentions count
the number of times the target keyword or domain were mentioned in relation to this specific grouping key",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AggregatedMetricsItemInfo": {
"properties": {
"ai_search_volume": {
"description": "aggregated AI search volume for mentions within this grouping
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"key": {
"description": "grouping identifier
the specific identifier for the grouping dimension",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "total LLM mentions count
the number of times the target keyword or domain were mentioned in relation to this specific grouping key",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeAiOverviewExpandedComponentInfo": {
"properties": {
"images": {
"description": "images of the component
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeLinkElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format",
"type": [
"string",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "additional text of the element in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "reference page title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeAiOverviewInfo": {
"properties": {
"items": {
"description": "items present in the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
the text of the ai_overview formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"page": {
"description": "SERP page
SERP page on which the element ranks",
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result's snippet in SERP
equals null if calculate_rectangles in the POST request is not set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"references": {
"description": "additional references relevant to the item
includes references to webpages that may have been used to generate the ai_overview",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeAiOverviewPaidElementInfo": {
"properties": {
"ad_aclk": {
"description": "unique ad click referral parameter
using this parameter you can get a URL of the advertisement in Google Shopping Sellers Ad URL",
"type": [
"string",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb path displayed in the ad",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain name of the reference",
"type": [
"string",
"null"
]
},
"images": {
"description": "images present in the ad
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"snippet": {
"description": "description text of the ad",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in SERP",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "reference page URL",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "displayed name of the advertiser's website",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeAiOverviewReferenceInfo": {
"properties": {
"domain": {
"description": "domain name of the reference",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"text": {
"description": "text of the component",
"type": [
"string",
"null"
]
},
"title": {
"description": "link anchor text",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "link URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeAiOverviewShoppingElementInfo": {
"properties": {
"data_docid": {
"description": "unique identifier of the SERP data element",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in link",
"type": [
"string",
"null"
]
},
"gid": {
"description": "global product identifier on Google Shopping
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"marketplace": {
"description": "merchant account provider
e-commerce site that hosts products or websites of individual sellers under the same merchant account
example:by Google",
"type": [
"string",
"null"
]
},
"marketplace_url": {
"description": "URL to the merchant account provider
e-commerce site that hosts products or websites of individual sellers under the same merchant account",
"type": [
"string",
"null"
]
},
"price": {
"description": "product price
product price details on the seller's website;
if there is none, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"product_id": {
"description": "unique product identifier on Google Shopping
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"rating": {
"description": "product rating
the popularity rate based on reviews
if there is none, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"seller": {
"description": "product seller
name of the product's seller as displayed in search results",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "additional information about the result",
"type": [
"string",
"null"
]
},
"title": {
"description": "reference page title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL in link",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeImagesElementInfo": {
"properties": {
"alt": {
"description": "alt tag of the image",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeLinkElementInfo": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeRectangleInfo": {
"properties": {
"height": {
"description": "height of the element in pixels",
"format": "double",
"type": [
"number",
"null"
]
},
"width": {
"description": "width of the element in pixels",
"format": "double",
"type": [
"number",
"null"
]
},
"x": {
"description": "x-axis coordinate\nx-axis coordinate of the top-left corner of the result’s snippet, where top-left corner of the screen is the origin",
"format": "double",
"type": [
"number",
"null"
]
},
"y": {
"description": "y-axis coordinate\ny-axis coordinate of the top-left corner of the result’s snippet, where top-left corner of the screen is the origin",
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiModeTableInfo": {
"properties": {
"table_content": {
"description": "array of contents of the table present in the element
each array represents the table row",
"items": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"array",
"null"
]
},
"table_header": {
"description": "content in the header of the table",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiMonthlySearches": {
"properties": {
"ai_search_volume": {
"description": "current AI search volume rate of a keyword
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"month": {
"description": "month",
"type": [
"integer",
"null"
]
},
"year": {
"description": "year",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveItem": {
"properties": {
"ai_monthly_searches": {
"description": "monthly AI search volume rates
array of objects with AI search volume rates in a certain month of a year",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiMonthlySearches"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"ai_search_volume": {
"description": "current AI search volume rate of a keyword
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "specified keyword",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResultInfo": {
"properties": {
"items": {
"description": "contains specified keywords with their AI search volume rates",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationAiKeywordDataLocationsAndLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationAiKeywordDataLocationsAndLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationAiKeywordDataLocationsAndLanguagesResultInfo": {
"properties": {
"available_languages": {
"description": "supported languages
contains the languages which are supported for a specific location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvailableLanguages"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationAiKeywordDataLocationsAndLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationAiKeywordDataLocationsAndLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"input_tokens": {
"description": "number of tokens in the input
total count of tokens processed",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of response items
contains structured AI response data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model used",
"type": [
"string",
"null"
]
},
"money_spent": {
"description": "cost of AI tokens, USD
the price charged by the third-party AI model provider for according to its Pricing",
"type": [
"number",
"null"
]
},
"output_tokens": {
"description": "number of tokens in the output
total count of tokens generated in the AI response",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"description": "number of reasoning tokens
total count of tokens used to generate reasoning content",
"type": [
"integer",
"null"
]
},
"web_search": {
"description": "indicates if web search was used",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesModelsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesModelsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesModelsResultInfo": {
"properties": {
"model_name": {
"description": "name of the AI model",
"type": [
"string",
"null"
]
},
"task_post_supported": {
"description": "indicates if Standard (POST-GET) data retrieval is supported
if true, you can use the Standard (POST-GET) data retrieval method with the AI model",
"type": [
"boolean",
"null"
]
},
"web_search_supported": {
"description": "web search support for the AI model
if true, the web_search parameter can be set with the AI model",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesModelsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesModelsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskGetResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"input_tokens": {
"description": "number of tokens in the input
total count of tokens processed",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of response items
contains structured AI response data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model used",
"type": [
"string",
"null"
]
},
"money_spent": {
"description": "cost of AI tokens, USD
the price charged by the third-party AI model provider for according to its Pricing",
"type": [
"number",
"null"
]
},
"output_tokens": {
"description": "number of tokens in the output
total count of tokens generated in the AI response",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"description": "number of reasoning tokens
total count of tokens used to generate reasoning content",
"type": [
"integer",
"null"
]
},
"web_search": {
"description": "indicates if web search was used",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "LLM model specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmResponsesTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveAdvancedResultInfo": {
"properties": {
"brand_entities": {
"description": "array of brand entities
contains information on brands mentioned in the response",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptBrandEntity"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"item_types": {
"description": "types of search results
contains types of search results (items) found in SERP.
possible item types:chat_gpt_text, chat_gpt_table, chat_gpt_navigation_list, chat_gpt_images, chat_gpt_local_businesses, chat_gpt_products",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of ChatGPT results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"model": {
"description": "indicates the model version",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
},
"search_results": {
"description": "array of search results
all web search outputs the model retrieved when looking up information, including duplicates and unused entries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatgptSearchResult"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources": {
"description": "array of sources
the sources the model actually cited or relied on in its final answer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetAdvancedResultInfo": {
"properties": {
"brand_entities": {
"description": "array of brand entities
contains information on brands mentioned in the response",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptBrandEntity"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"item_types": {
"description": "types of search results
contains types of search results (items) found.
possible item types:chat_gpt_text, chat_gpt_table, chat_gpt_navigation_list, chat_gpt_images, chat_gpt_local_businesses, chat_gpt_products",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items present in the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"model": {
"description": "indicates the model version",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
},
"search_results": {
"description": "array of search results
all web search outputs the model retrieved when looking up information, including duplicates and unused entries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatgptSearchResult"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources": {
"description": "array of sources
the sources the model actually cited or relied on in its final answer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"input_tokens": {
"description": "number of tokens in the input
total count of tokens processed",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of response items
contains structured AI response data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model used",
"type": [
"string",
"null"
]
},
"money_spent": {
"description": "cost of AI tokens, USD
the price charged by the third-party AI model provider for according to its Pricing",
"type": [
"number",
"null"
]
},
"output_tokens": {
"description": "number of tokens in the output
total count of tokens generated in the AI response",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"description": "number of reasoning tokens
total count of tokens used to generate reasoning content",
"type": [
"integer",
"null"
]
},
"web_search": {
"description": "indicates if web search was used",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesModelsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesModelsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesModelsResultInfo": {
"properties": {
"model_name": {
"description": "name of the AI model",
"type": [
"string",
"null"
]
},
"task_post_supported": {
"description": "indicates if Standard (POST-GET) data retrieval is supported
if true, you can use the Standard (POST-GET) data retrieval method with the AI model",
"type": [
"boolean",
"null"
]
},
"web_search_supported": {
"description": "web search support for the AI model
if true, the web_search parameter can be set with the AI model",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesModelsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesModelsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskGetResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"input_tokens": {
"description": "number of tokens in the input
total count of tokens processed",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of response items
contains structured AI response data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model used",
"type": [
"string",
"null"
]
},
"money_spent": {
"description": "cost of AI tokens, USD
the price charged by the third-party AI model provider for according to its Pricing",
"type": [
"number",
"null"
]
},
"output_tokens": {
"description": "number of tokens in the output
total count of tokens generated in the AI response",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"description": "number of reasoning tokens
total count of tokens used to generate reasoning content",
"type": [
"integer",
"null"
]
},
"web_search": {
"description": "indicates if web search was used",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "LLM model specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationClaudeLlmResponsesTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"input_tokens": {
"description": "number of tokens in the input
total count of tokens processed",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of response items
contains structured AI response data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model used",
"type": [
"string",
"null"
]
},
"money_spent": {
"description": "cost of AI tokens, USD
the price charged by the third-party AI model provider for according to its Pricing",
"type": [
"number",
"null"
]
},
"output_tokens": {
"description": "number of tokens in the output
total count of tokens generated in the AI response",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"description": "number of reasoning tokens
total count of tokens used to generate reasoning content",
"type": [
"integer",
"null"
]
},
"web_search": {
"description": "indicates if web search was used",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesModelsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesModelsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesModelsResultInfo": {
"properties": {
"model_name": {
"description": "name of the AI model",
"type": [
"string",
"null"
]
},
"task_post_supported": {
"description": "indicates if Standard (POST-GET) data retrieval is supported
if true, you can use the Standard (POST-GET) data retrieval method with the AI model",
"type": [
"boolean",
"null"
]
},
"web_search_supported": {
"description": "web search support for the AI model
if true, the web_search parameter can be set with the AI model",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesModelsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesModelsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskGetResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"input_tokens": {
"description": "number of tokens in the input
total count of tokens processed",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of response items
contains structured AI response data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model used",
"type": [
"string",
"null"
]
},
"money_spent": {
"description": "cost of AI tokens, USD
the price charged by the third-party AI model provider for according to its Pricing",
"type": [
"number",
"null"
]
},
"output_tokens": {
"description": "number of tokens in the output
total count of tokens generated in the AI response",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"description": "number of reasoning tokens
total count of tokens used to generate reasoning content",
"type": [
"integer",
"null"
]
},
"web_search": {
"description": "indicates if web search was used",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "LLM model specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmResponsesTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveAdvancedResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results
contains types of search results (items) found in SERP.
possible item types:gemini_text, gemini_table, gemini_images",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of Gemini results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseGeminiLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"model": {
"description": "indicates the model version",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
},
"sources": {
"description": "array of sources
the sources the model actually cited or relied on in its final answer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:\"location_code\": 9041134,
\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",
\"location_code_parent\": 20044location_code_parent corresponds to:\"location_code\": 20044,",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetAdvancedResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
\"location_name\": \"Lower Austria,Austria\"
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results
contains types of search results (items) found in SERP.
possible item types:gemini_text, gemini_table, gemini_images",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items present in the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseGeminiLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"model": {
"description": "indicates the model version",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
},
"sources": {
"description": "array of sources
the sources the model actually cited or relied on in its final answer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the Advanced task
if the Advanced function is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the HTML task
if the HTML function is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"function": {
"description": "search engine function
example: llm_scraper",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationGeminiLlmScraperTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsAvailableFiltersResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsAvailableFiltersTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsAvailableFiltersResultInfo": {
"properties": {
"multi_target_metrics": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"search": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"search_mentions": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"target_metrics": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"target_metrics_lite": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_brand_categories": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_brand_categories_lite": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_brands": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_brands_lite": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_domains": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_domains_lite": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_pages": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_mentioned_pages_lite": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsAvailableFiltersTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsAvailableFiltersResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveItem": {
"properties": {
"metrics": {
"description": "aggregated mentions metrics for the given month of a year",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
},
"month": {
"description": "month",
"type": [
"integer",
"null"
]
},
"year": {
"description": "year",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveResultInfo": {
"properties": {
"items": {
"description": "array of historical mention metrics
contains objects with historical mention metrics for the specified target
each object contains aggregated mentions metrics for one calendar month",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of resuts returned in the items array
",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsLocationsAndLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsLocationsAndLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsLocationsAndLanguagesResultInfo": {
"properties": {
"available_languages": {
"description": "supported languages
contains the languages which are supported for a specific location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ResultAvailableLanguages"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsLocationsAndLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsLocationsAndLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveItem": {
"properties": {
"brand_entities_category": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity categories that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"brand_entities_title": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity titles that appear in search results related to LLM queries
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"key": {
"description": "grouping key
the specific identifier for the group dimension",
"type": [
"string",
"null"
]
},
"language": {
"description": "language-based grouping
array of objects containing mention metrics segmented by content language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location": {
"description": "location-based grouping
array of objects containing mention metrics segmented by geographical location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "platform-based grouping
array of group elements containing mention metrics segmented by AI platform",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_results_domain": {
"description": "found top search results domains relevant to the target
array of objects containing data on top domains that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources_domain": {
"description": "found top source domains relevant to the target
array of objects containing data on top domains that are cited as sources in LLM responses
learn more about the sources and how to retrieve LLM citation data at our Help Center",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total": {
"description": "data on total mentions and search volume for the target",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all LLM mentions that match at least one target specified in the request",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LlmMentionsAggregatedMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "contains relevant mentions data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions dataoffset specified in the request",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveItem": {
"properties": {
"ai_search_volume": {
"description": "current AI search volume rate of a keyword
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"answer": {
"description": "relevant answer in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"brand_entities": {
"description": "array of brand entities
contains information on brands mentioned in the response
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BrandEntities"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response
Note: available only for chat_gpt",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"first_response_at": {
"description": "date and time when the response data was first recorded
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2025-10-21 06:25:30 +00:00",
"type": [
"string",
"null"
]
},
"is_web_search_based": {
"description": "indicates whether the response was generated using web search results
if true, the model retrieved live web search results to produce the response
if false, the response was generated from the model's internal knowledge",
"type": [
"boolean",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"last_response_at": {
"description": "date and time when the response data was last updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2025-10-21 06:25:30 +00:00",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"model_name": {
"description": "name of the AI model from which the data was retrieved
Note: for the google platform type, the value is always google_ai_overview",
"type": [
"string",
"null"
]
},
"monthly_searches": {
"description": "monthly AI search volume rates
array of objects with AI search volume rates in a certain month of a year",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "platform received in a POST array",
"type": [
"string",
"null"
]
},
"question": {
"description": "relevant question",
"type": [
"string",
"null"
]
},
"search_results": {
"description": "array of search results
all web search outputs the model retrieved when looking up information, including duplicates and unused entries
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchResults"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources": {
"description": "array of sources
the sources the model cited or relied on in its final answer
learn more about the sources and how to retrieve LLM citation data at our Help Center",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Sources"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant mentions data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"type": [
"integer",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests
by specifying the unique search_after_token when setting a new task, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveItem": {
"properties": {
"language": {
"description": "language identifier
language of aggregated metrics",
"type": [
"string",
"null"
]
},
"location": {
"description": "location identifier
location of aggregated metrics",
"type": [
"integer",
"null"
]
},
"metrics": {
"description": "LLM metrics
metrics aggregated by specific parameters and respective identifiers",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
},
"platform": {
"description": "LLM platform identifiers
LLM platform of aggregated metrics",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics
in this case, always returns null",
"type": [
"object",
"null"
]
},
"items": {
"description": "array of aggregated mentions metrics
contains objects with aggregated mention metrics for the specified target",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "the number of mentions objects that are omitted in the items array",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics
contains aggregated LLM mention metrics across all found domains, grouped by various dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LlmMentionsAggregatedMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "individual target results
in this case, equals null",
"items": {
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array
in this case, always equals 0",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "the number of mentions objects that are omitted in the items array
in this case, always equals 0",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total amount of results relevant to the request
in this case, always equals 0",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveItem": {
"properties": {
"date": {
"description": "date timestamp
date format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"delta_ai_search_volume": {
"description": "LLM mentions count delta
the difference in ai_search_volume values between the current timestamp and the previous one
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"delta_mentions": {
"description": "LLM mentions count delta
the difference in mentions between the current timestamp and the previous one",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant LLM mentions timeseries data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveItem": {
"properties": {
"date": {
"description": "date timestamp
date format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"lost_ai_search_volume": {
"description": "ai_search_volume decrement
indicates the decrease of ai_search_volume values between the current timestamp and the previous one
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"lost_mentions": {
"description": "lost LLM mentions
indicates the LLM responses that contained the specified target at the date_from timestamp, do not contain it at the date_to timestamp",
"type": [
"integer",
"null"
]
},
"new_ai_search_volume": {
"description": "ai_search_volume increment
indicates the increase of ai_search_volume values between the current timestamp and the previous one
learn more about this metric here",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_mentions": {
"description": "new LLM mentions
indicates the LLM responses that contain the target at the date_to timestamp, did not contain it at the date_from timestamp",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant LLM mentions timeseries data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveItem": {
"properties": {
"brand_category": {
"description": "brand category
brand category identifier of aggregated metrics",
"type": [
"string",
"null"
]
},
"language": {
"description": "language identifier
language of aggregated metrics",
"type": [
"string",
"null"
]
},
"location": {
"description": "location identifier
location of aggregated metrics",
"type": [
"integer",
"null"
]
},
"metrics": {
"description": "LLM metrics
metrics aggregated by specific parameters and respective identifiers",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
},
"platform": {
"description": "LLM platform identifiers
LLM platform of aggregated metrics",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensionsin this case, the value will be null",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains relevant mentions data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions dataoffset specified in the request",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveItem": {
"properties": {
"brand_category": {
"description": "brand category
brand category found in LLM mentions for the specified target",
"type": [
"string",
"null"
]
},
"brand_entities_category": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity categories that appear in search results related to LLM queries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"brand_entities_title": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity titles that appear in search results related to LLM queries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"language": {
"description": "language-based grouping
array of objects containing mention metrics segmented by content language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location": {
"description": "location-based grouping
array of objects containing mention metrics segmented by geographical location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "platform-based grouping
array of group elements containing mention metrics segmented by AI platform",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_results_domain": {
"description": "found top search results domains relevant to the target
array of objects containing data on top domains that appear in search results related to LLM queries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources_domain": {
"description": "found top source domains relevant to the target
array of objects containing data on top domains that are cited as sources in LLM responses
learn more about the sources and how to retrieve LLM citation data at our Help Center",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics
contains aggregated LLM mention metrics across all found brand categories, grouped by various dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LlmMentionsAggregatedMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "individual brand categories results
array containing detailed mention metrics for each of the found brand categories",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "the number of mentions objects that are omitted in the items array",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveItem": {
"properties": {
"brand": {
"description": "brand name
brand identifier of aggregated metrics",
"type": [
"string",
"null"
]
},
"language": {
"description": "language identifier
language of aggregated metrics",
"type": [
"string",
"null"
]
},
"location": {
"description": "location identifier
location of aggregated metrics",
"type": [
"integer",
"null"
]
},
"metrics": {
"description": "LLM metrics
metrics aggregated by specific parameters and respective identifiers",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
},
"platform": {
"description": "LLM platform identifiers
LLM platform of aggregated metrics",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensionsin this case, the value will be null",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains relevant mentions data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions dataoffset specified in the reqest",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveItem": {
"properties": {
"brand": {
"description": "brand name
name of the brand found in LLM mentions for the specified target",
"type": [
"string",
"null"
]
},
"brand_entities_category": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity categories that appear in search results related to LLM queries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"brand_entities_title": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity titles that appear in search results related to LLM queries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"language": {
"description": "language-based grouping
array of objects containing mention metrics segmented by content language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location": {
"description": "location-based grouping
array of objects containing mention metrics segmented by geographical location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "platform-based grouping
array of group elements containing mention metrics segmented by AI platform",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_results_domain": {
"description": "found top search results domains relevant to the target
array of objects containing data on top domains that appear in search results related to LLM queries",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources_domain": {
"description": "found top source domains relevant to the target
array of objects containing data on top domains that are cited as sources in LLM responses
learn more about the sources and how to retrieve LLM citation data at our Help Center",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics
contains aggregated LLM mention metrics across all found brands, grouped by various dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LlmMentionsAggregatedMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "individual domain results
array containing detailed mention metrics for each of the found top domains",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "the number of mentions objects that are omitted in the items array",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveItem": {
"properties": {
"domain": {
"description": "domain name
domain of aggregated metrics",
"type": [
"string",
"null"
]
},
"language": {
"description": "language identifier
language of aggregated metrics",
"type": [
"string",
"null"
]
},
"location": {
"description": "location identifier
location of aggregated metrics",
"type": [
"integer",
"null"
]
},
"metrics": {
"description": "LLM metrics
metrics aggregated by specific parameters and respective identifiers",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
},
"platform": {
"description": "LLM platform identifiers
LLM platform of aggregated metrics",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensionsin this case, the value will be null",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains relevant mentions data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions dataoffset specified in the reqest",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveItem": {
"properties": {
"brand_entities_category": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity categories that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"brand_entities_title": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity titles that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"domain": {
"description": "domain name
the domain name of the website found in LLM mentions for the specified target",
"type": [
"string",
"null"
]
},
"language": {
"description": "language-based grouping
array of objects containing mention metrics segmented by content language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location": {
"description": "location-based grouping
array of objects containing mention metrics segmented by geographical location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "platform-based grouping
array of group elements containing mention metrics segmented by AI platform",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_results_domain": {
"description": "found top search results domains relevant to the target
array of objects containing data on top domains that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources_domain": {
"description": "found top source domains relevant to the target
array of objects containing data on top domains that are cited as sources in LLM responses
learn more about the sources and how to retrieve LLM citation data at our Help Center",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics
contains aggregated LLM mention metrics across all found domains, grouped by various dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LlmMentionsAggregatedMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "individual domain results
array containing detailed mention metrics for each of the found top domains",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "the number of mentions objects that are omitted in the items array",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveItem": {
"properties": {
"language": {
"description": "language identifier
language of aggregated metrics",
"type": [
"string",
"null"
]
},
"location": {
"description": "location identifier
location of aggregated metrics",
"type": [
"integer",
"null"
]
},
"metrics": {
"description": "LLM metrics
metrics aggregated by specific parameters and respective identifiers",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
},
"page": {
"description": "page URL
page identifier of aggregated metrics",
"type": [
"string",
"null"
]
},
"platform": {
"description": "LLM platform identifiers
LLM platform of aggregated metrics",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensionsin this case, the value will be null",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains relevant mentions data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions dataoffset specified in the request",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveItem": {
"properties": {
"brand_entities_category": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity categories that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"brand_entities_title": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity titles that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"language": {
"description": "language-based grouping
array of objects containing mention metrics segmented by content language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location": {
"description": "location-based grouping
array of objects containing mention metrics segmented by geographical location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"page": {
"description": "URL of a found page
the URL of a page found in LLM mentions for the specified target",
"type": [
"string",
"null"
]
},
"platform": {
"description": "platform-based grouping
array of group elements containing mention metrics segmented by AI platform",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_results_domain": {
"description": "found top search results domains relevant to the target
array of objects containing data on top domains that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources_domain": {
"description": "found top source domains relevant to the target
array of objects containing data on top domains that are cited as sources in LLM responses
learn more about the sources and how to retrieve LLM citation data at our Help Center",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveResultInfo": {
"properties": {
"aggregated_metrics": {
"description": "aggregated mentions metrics
contains aggregated LLM mention metrics across all found pages, grouped by various dimensions",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LlmMentionsAggregatedMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "individual page results
array containing detailed mention metrics for each of the found top mentioned pages",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "the number of mentions objects that are omitted in the items array",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationPerplexityLlmResponsesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationPerplexityLlmResponsesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationPerplexityLlmResponsesLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fan_out_queries": {
"description": "array of fan-out queries
contains related search queries derived from the main query to provide a more comprehensive response",
"type": [
"object",
"null"
]
},
"input_tokens": {
"description": "number of tokens in the input
total count of tokens processed",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of response items
contains structured AI response data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MessageAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model used",
"type": [
"string",
"null"
]
},
"money_spent": {
"description": "cost of AI tokens, USD
the price charged by the third-party AI model provider for according to its Pricing",
"type": [
"number",
"null"
]
},
"output_tokens": {
"description": "number of tokens in the output
total count of tokens generated in the AI response",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"type": [
"integer",
"null"
]
},
"web_search": {
"description": "indicates if web search was used
Note: web search is enabled by default in Perplexity Sonar models",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationPerplexityLlmResponsesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationPerplexityLlmResponsesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationPerplexityLlmResponsesModelsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationPerplexityLlmResponsesModelsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOptimizationPerplexityLlmResponsesModelsResultInfo": {
"properties": {
"model_name": {
"description": "name of the AI model",
"type": [
"string",
"null"
]
},
"task_post_supported": {
"description": "indicates if Standard (POST-GET) data retrieval is supported
if true, you can use the Standard (POST-GET) data retrieval method with the AI model",
"type": [
"boolean",
"null"
]
},
"web_search_supported": {
"description": "web search support for the AI model
if true, the web_search parameter can be set with the AI model",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOptimizationPerplexityLlmResponsesModelsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationPerplexityLlmResponsesModelsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AiOverviewElement": {
"properties": {
"images": {
"description": "images of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "content within the item",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOverviewExpandedComponent": {
"properties": {
"images": {
"description": "images of the element
if there is none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format",
"type": [
"string",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "reference text
text snippet from the page that was used to generate the ai_overview_element",
"type": [
"string",
"null"
]
},
"title": {
"description": "reference page title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AiOverviewSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"asynchronous_ai_overview": {
"description": "indicates whether the element is loaded asynchronously
if true, the ai_overview element is loaded asynchronously;
if false, the ai_overview element is loaded from cache;
to obtain the content of ai_overview elements, use the load_async_ai_overview parameter in the POST request",
"type": [
"boolean",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
the text of the ai_overview formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AmazonApplicableVouchersItem": {
"properties": {
"fixed_discount": {
"description": "value of the fixed discount",
"type": [
"number",
"null"
]
},
"fixed_discount_currency": {
"description": "currency code of the fixed discount",
"type": [
"string",
"null"
]
},
"important_details": {
"description": "important details about the terms of discount vouchers",
"type": [
"string",
"null"
]
},
"percentage_discount": {
"description": "value of the percentage discount
if the discount is fixed, the value will be null",
"type": [
"number",
"null"
]
},
"text": {
"description": "text of the voucher",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonDeliveryInfo": {
"properties": {
"delivery_date_from": {
"description": "the earliest date when the product can be shipped",
"type": [
"string",
"null"
]
},
"delivery_date_to": {
"description": "the latest date when the product can be delivered",
"type": [
"string",
"null"
]
},
"delivery_message": {
"description": "message accompanying the delivery information as posted by the seller",
"type": [
"string",
"null"
]
},
"delivery_price": {
"description": "price for the delivery\nprice of the delivery based on the location you specified in the POST request;\nif free delivery is available, the value is null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"fastest_delivery_date_from": {
"description": "the earliest date when the product can be delivered with a fast delivery option",
"type": [
"string",
"null"
]
},
"fastest_delivery_date_to": {
"description": "the latest date when the product can be delivered with a fast delivery option",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonInfo": {
"properties": {
"asin": {
"description": "ASIN in a POST array",
"type": [
"string",
"null"
]
},
"bought_past_month": {
"type": [
"integer",
"null"
]
},
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonDeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"domain": {
"description": "Amazon domain",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the product image featured in the results",
"type": [
"string",
"null"
]
},
"is_amazon_choice": {
"description": "\"Amazon's choice\" label
if the value is true, the product is marked with the \"Amazon's choice\" label",
"type": [
"boolean",
"null"
]
},
"is_best_seller": {
"description": "\"Best Seller\" label
if the value is true, the product is marked with the \"Best Seller\" label",
"type": [
"boolean",
"null"
]
},
"position": {
"description": "the alignment of the element in Amazon SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"price_from": {
"description": "the regular price of a product
example:49.98",
"type": [
"number",
"null"
]
},
"price_to": {
"description": "the upper limit of the product price range
example:384.99",
"type": [
"number",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in Amazon SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"properties": {
"value": {
"description": "评级值",
"format": "float",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"special_offers": {
"description": "special offer details
contains special offer details, including coupon and Subscribe & Save discounts",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the product page",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonKeywordData": {
"properties": {
"keyword": {
"description": "相关关键词",
"type": [
"string",
"null"
]
},
"keyword_info": {
"description": "返回关键词的关键词信息",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonKeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
}
}
},
"Response0A3E90081762_AmazonKeywordInfo": {
"properties": {
"last_updated_time": {
"description": "date and time when keyword data was updated\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample: '2019-11-15 12:57:46 +00:00'",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
},
"search_volume": {
"description": "average monthly search volume rate\nrepresents the (approximate) number of searches for the provided keyword idea on Amazon",
"format": "int64",
"type": [
"integer",
"null"
]
}
}
},
"Response0A3E90081762_AmazonLabelElement": {
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "元素标题",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonMetricsBundleInfo": {
"properties": {
"amazon_paid": {
"description": "ranking data from Amazon paid SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"amazon_serp": {
"description": "ranking data from Amazon organic SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppMetricsInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonProductInfo": {
"properties": {
"applicable_vouchers": {
"description": "array of objects containing information about applicable vouchers",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonApplicableVouchersItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"author": {
"description": "product brand name",
"type": [
"string",
"null"
]
},
"categories": {
"description": "contains related product categories",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Categories"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"data_asin": {
"description": "ASIN of the product received in a POST array",
"type": [
"string",
"null"
]
},
"description": {
"description": "contains description of the product",
"type": [
"string",
"null"
]
},
"details": {
"description": "product specs and other details",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "the URL of the product image",
"type": [
"string",
"null"
]
},
"is_amazon_choice": {
"description": "\"Amazon's choice\" label
if the value is true, the product is marked with the \"Amazon's choice\" label",
"type": [
"boolean",
"null"
]
},
"is_available": {
"description": "indicates whether the product is available for ordering
if the value is true, the product can be ordered",
"type": [
"boolean",
"null"
]
},
"is_newer_model_available": {
"description": "indicates whether the newer model of the product is available",
"type": [
"boolean",
"null"
]
},
"is_prime_video": {
"description": "indicates whether a product has an Amazon Prime Video label
if true, specified product is a part of Amazon Prime Video service",
"type": [
"boolean",
"null"
]
},
"newer_model": {
"description": "information about the newer model of the product",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_NewerModel"
}
],
"type": [
"object",
"null"
]
},
"parent_asin": {
"description": "parent ASIN of the product",
"type": [
"string",
"null"
]
},
"percentage_discount": {
"description": "value of the percentage discount",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the element in Amazon SERP
possible values:left, right",
"type": [
"string",
"null"
]
},
"price_from": {
"description": "the lower limit of the product price range
example:49.98",
"type": [
"number",
"null"
]
},
"price_to": {
"description": "the upper limit of the product price range
example:384.99",
"type": [
"number",
"null"
]
},
"product_asins": {
"description": "ASINs of all found product modifications",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"product_images_list": {
"description": "contains URLs for all images of the product displayed on the left side of the main image",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"product_information": {
"description": "contains related product information",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonProductInformationElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"product_videos_list": {
"description": "contains URLs for all videos of the product displayed on the right side of the main video",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": " absolute rank
absolute position among all the elements in the response array",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "product rating info",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"top_global_reviews": {
"description": "array of objects with top reviews from around the world",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonReviewItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"top_local_reviews": {
"description": "array of objects with top reviews from target location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonReviewItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonRankedSerpElement": {
"properties": {
"check_url": {
"description": "direct URL to Amazon results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"previous_updated_time": {
"description": "previous to the most recent update of SERP data
in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ”
example:2020-09-12T00:07:43.0733218Z",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in Amazon SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"serp_item": {
"description": "contains data on the SERP element
the list of supported SERP elements can be found below",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonInfo"
}
],
"type": [
"object",
"null"
]
},
"serp_item_types": {
"description": "direct URL to Amazon results
contains types of all search results (items) found in the returned SERP;
possible item types:amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonReviewItem": {
"properties": {
"helpful_votes": {
"description": "helpful votes count
number of users who clicked on the 'Helpful\" button under the review text",
"type": [
"string",
"null"
]
},
"images": {
"description": "images of the product submitted by the reviewer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the review in SERP
can take the following values: right",
"type": [
"string",
"null"
]
},
"publication_date": {
"description": "date and time when the review was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score submitted by the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"review_text": {
"description": "content of the review",
"type": [
"string",
"null"
]
},
"subtitle": {
"description": "subtitle of the review",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the review",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
},
"user_profile": {
"description": "user profile of the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_UserProfileInfo"
}
],
"type": [
"object",
"null"
]
},
"verified": {
"description": "indicates whether the review has the \"Verified Purchase\" mark",
"type": [
"boolean",
"null"
]
},
"videos": {
"description": "videos of the product submitted by the reviewer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_VideoElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AmazonSerpElement": {
"properties": {
"bought_past_month": {
"description": "number of product purchases in the past month",
"type": [
"integer",
"null"
]
},
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"data_asin": {
"description": "unique product identifier on Amazon
note that there is no full list of possible values as the data_asin is a dynamic value assigned by Amazon
example:B07G82D89J",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonDeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"domain": {
"description": "Amazon domain",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the product image featured in the results",
"type": [
"string",
"null"
]
},
"is_amazon_choice": {
"description": "\"Amazon's choice\" label
if the value is true, the product is marked with the \"Amazon's choice\" label",
"type": [
"boolean",
"null"
]
},
"is_best_seller": {
"description": "\"Best Seller\" label
if the value is true, the product is marked with the \"Best Seller\" label",
"type": [
"boolean",
"null"
]
},
"labels": {
"description": "product labels
array containing an object with main Amazon labels’ information
if the product contains no labels, the value will be null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"price_from": {
"description": "the regular price of a product
example:49.98",
"type": [
"number",
"null"
]
},
"price_to": {
"description": "the upper limit of the product price range
example:384.99",
"type": [
"number",
"null"
]
},
"rating": {
"description": "product rating info",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"special_offers": {
"description": "special offer details
contains special offer details, including coupon and Subscribe & Save discounts",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "the URL of the product page",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AnalysisContentInfo": {
"properties": {
"author": {
"description": "author of the content",
"type": [
"string",
"null"
]
},
"connotation_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "connotation types
contains types of sentiments (sentiment polarity) related to the given citation and probability index per each sentiment type
possible sentiment connotation types: positive, negative, neutral",
"type": [
"object",
"null"
]
},
"content_quality_score": {
"description": "content quality score
this value is calculated based on the number of words, sentences and characters the content contains",
"type": [
"integer",
"null"
]
},
"content_type": {
"description": "type of content
example:page_content, comment",
"type": [
"string",
"null"
]
},
"date_published": {
"description": "date and time when the content was published
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"group_date": {
"description": "citation group date and time
indicates content publication date or date and time when our crawler visited the page for the first time;
this field can be used to group citations by date and display citation trends;
date and time are provided in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"highlighted_text": {
"description": "highlighted text from the snippet",
"type": [
"string",
"null"
]
},
"language": {
"description": "main language of the domain
to obtain a full list of available languages, refer to the Languages endpoint",
"type": [
"string",
"null"
]
},
"level": {
"description": "title heading level
indicates h-tag level from 1 (top) to 6 (bottom)",
"type": [
"integer",
"null"
]
},
"main_title": {
"description": "page title",
"type": [
"string",
"null"
]
},
"previous_title": {
"description": "title of the previous content block",
"type": [
"string",
"null"
]
},
"rating": {
"description": "content rating
rating related to content_info",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContententRatingInfo"
}
],
"type": [
"object",
"null"
]
},
"semantic_location": {
"description": "semantic location
indicates semantic element in HTML where the target keyword citation is located
example:article, header",
"type": [
"string",
"null"
]
},
"sentiment_connotations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "sentiment connotations
contains sentiments (emotional reactions) related to the given citation and probability index per each sentiment
possible sentiment connotations: anger, happiness, love, sadness, share, fun",
"type": [
"object",
"null"
]
},
"snippet": {
"description": "content snippet",
"type": [
"string",
"null"
]
},
"snippet_length": {
"description": "character length of the snippet",
"type": [
"integer",
"null"
]
},
"social_metrics": {
"description": "social media engagement metrics
data on social media interactions associated with the content based on website embeds developed and supported by social media platforms",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SocialMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text_category": {
"description": "text category
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AnnotationInfo": {
"properties": {
"direct_url": {
"description": "direct URL to the quoted source
contains the original source URL that the Vertex AI redirect in the `url` field leads to",
"type": [
"string",
"null"
]
},
"end_index": {
"description": "end of the annotation indexing",
"type": [
"integer",
"null"
]
},
"start_index": {
"description": "start of the annotation indexing",
"type": [
"integer",
"null"
]
},
"text": {
"description": "text of the reasoning chain section
text of the reasoning chain section summarizing the model's thought process",
"type": [
"string",
"null"
]
},
"title": {
"description": "the domain name or title of the quoted source",
"type": [
"string",
"null"
]
},
"url": {
"description": "redirect URL to the quoted source
contains a Vertex AI redirect that leads to the original source",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AnswerBoxSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"text": {
"description": "text
if there is none, equals null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppInfoTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppInfoTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppInfoTaskGetAdvancedResultInfo": {
"properties": {
"app_id": {
"description": "application id received in a POST request",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found app info",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppStoreInfoOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "the total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppInfoTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppInfoTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppInfoTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppInfoTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppInfoTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
in this case, the value will be null",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found apps
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppStoreSearchOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of app items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "app collection received in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "the total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of resultsin this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListingsCategoriesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListingsCategoriesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListingsCategoriesResultInfo": {
"properties": {
"category": {
"description": "name of the supported app category",
"type": [
"string",
"null"
]
},
"count": {
"description": "number of app listings that make up the supported app category",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListingsCategoriesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListingsCategoriesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListingsSearchLiveItem": {
"properties": {
"app_id": {
"description": "ID of the returned app",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"item": {
"description": "detailed information about the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppStoreInfoOrganic"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"time_update": {
"description": "date and time when SERP data was last updated
in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ”
example:2023-05-23 10:16:19 +00:00",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListingsSearchLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListingsSearchLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListingsSearchLiveResultInfo": {
"properties": {
"count": {
"description": "the number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of apps and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListingsSearchLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"offset": {
"description": "offset in the results array of returned apps",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "the total number of relevant results in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppListingsSearchLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListingsSearchLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppReviewsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppReviewsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppReviewsTaskGetAdvancedResultInfo": {
"properties": {
"app_id": {
"description": "application id received in a POST array",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found reviews",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppStoreReviewsSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of reviews items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "rating of the app
rating of the application for which the reviews are collected",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews
in this case, the value will be null as App Store does not indicate the total number of app reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the app
title of the application for which the reviews are collected",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppReviewsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppReviewsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppReviewsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppReviewsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppReviewsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppSearchesTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppSearchesTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppSearchesTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
in this case, the value will be null",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found apps",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppStoreSearchOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST request",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "the total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppSearchesTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppSearchesTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppSearchesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppSearchesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleAppSearchesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleCategoriesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleCategoriesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleCategoriesResultInfo": {
"properties": {
"categories": {
"description": "contains full list of supported app categories",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleCategoriesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleCategoriesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataAppleLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "位置的 ISO 国家代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "位置代码",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "位置的完整名称",
"type": [
"string",
"null"
]
},
"location_name_parent": {
"description": "the name of the superordinate location\nexample:\n\"location_code\": 1006473,\n\"location_name\": \"Altrincham,England,United Kingdom\",\n\"location_name_parent\": \"England,United Kingdom\", where location_name_parent corresponds to:\n\"location_code\": 20339,\n\"location_name\": \"England,United Kingdom\"\nnote: Apple App Data API currently supports countries only, that is why this value will always be null",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "位置类型",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataAppleLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskGetAdvancedResultInfo": {
"properties": {
"app_id": {
"description": "application id received in a POST request",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found app info",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlayInfoOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "the total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskGetHtmlResultInfo": {
"properties": {
"app_id": {
"description": "application ID received in a POST request",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppInfoTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found apps",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlaySearchOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of app items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "app collection received in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "the total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "app collection received in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListingsCategoriesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListingsCategoriesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListingsCategoriesResultInfo": {
"properties": {
"category": {
"description": "name of the supported app category",
"type": [
"string",
"null"
]
},
"count": {
"description": "number of app listings that make up the supported app category",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListingsCategoriesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListingsCategoriesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListingsSearchLiveItem": {
"properties": {
"app_id": {
"description": "ID of the returned app",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"item": {
"description": "detailed information about the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlayInfoOrganic"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"time_update": {
"description": "date and time when SERP data was last updated
in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ”
example:2023-05-23 10:16:19 +00:00",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListingsSearchLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListingsSearchLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListingsSearchLiveResultInfo": {
"properties": {
"count": {
"description": "the number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of apps and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListingsSearchLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"offset": {
"description": "offset in the results array of returned apps",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "the total number of relevant results in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppListingsSearchLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListingsSearchLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskGetAdvancedResultInfo": {
"properties": {
"app_id": {
"description": "application id received in a POST array",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found reviews
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlayReviewsSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of reviews items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "rating of the app
rating of the application for which the reviews are collected",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the app
title of the application for which the reviews are collected",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskGetHtmlResultInfo": {
"properties": {
"app_id": {
"description": "app id received in a POST array",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppReviewsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found apps",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlaySearchOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST request",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "the total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST request",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleAppSearchesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleCategoriesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleCategoriesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleCategoriesResultInfo": {
"properties": {
"categories": {
"description": "contains full list of supported app categories",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleCategoriesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleCategoriesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppDataGoogleLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_name_parent": {
"description": "the name of the superordinate location
example:\"location_code\": 1006473, where
\"location_name\": \"Altrincham,England,United Kingdom\",
\"location_name_parent\": \"England,United Kingdom\",location_name_parent corresponds to:\"location_code\": 20339,",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppDataGoogleLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"price": {
"description": "price indicated in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppMetricsInfo": {
"properties": {
"count": {
"description": "total count of Amazon organic SERPs that contain the product",
"format": "int64",
"type": [
"integer",
"null"
]
},
"pos_1": {
"description": "number of organic SERPs where the product ranks #1",
"type": [
"integer",
"null"
]
},
"pos_11_100": {
"description": "number of organic SERPs where the product ranks #11-100",
"type": [
"integer",
"null"
]
},
"pos_2_3": {
"description": "number of organic SERPs where the product ranks #2-3",
"type": [
"integer",
"null"
]
},
"pos_4_10": {
"description": "number of organic SERPs where the product ranks #4-10",
"type": [
"integer",
"null"
]
},
"search_volume": {
"description": "total search volume of the product's ranking keywords in organic SERP",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
\"location_name\": \"England,United Kingdom\"
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_AppStoreInfoOrganic": {
"properties": {
"advisories": {
"description": "age rating and age-based content advisories",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"app_id": {
"description": "ID of the app",
"type": [
"string",
"null"
]
},
"categories": {
"description": "all relevant categories/genres of the app
Note: this field returns only one relevant category in the array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the app",
"type": [
"string",
"null"
]
},
"developer": {
"description": "name of the app developer",
"type": [
"string",
"null"
]
},
"developer_id": {
"description": "ID of the app developer",
"type": [
"string",
"null"
]
},
"developer_url": {
"description": "URL to the developer page on App Store",
"type": [
"string",
"null"
]
},
"icon": {
"description": "URL to the app icon",
"type": [
"string",
"null"
]
},
"images": {
"description": "app images
contains URLs to the images used on the app page on App Store",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_free": {
"description": "indicates whether the app is free",
"type": [
"boolean",
"null"
]
},
"languages": {
"description": "languages supported in the app
Note: this field returns only one supported language in the array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"last_update_date": {
"description": "date and time when the app was last updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"main_category": {
"description": "main category/genre of the app",
"type": [
"string",
"null"
]
},
"minimum_os_version": {
"description": "minimum OS version required to install the app",
"type": [
"string",
"null"
]
},
"more_apps_by_developer": {
"description": "similar apps
information about apps built by the same developer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values: left",
"type": [
"string",
"null"
]
},
"price": {
"description": "price of the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed apps
absolute position among all apps on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "average rating of the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"released_date": {
"description": "date and time when the app was released
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00
Note: this field is deprecated and always returns null",
"type": [
"string",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews of the app",
"format": "int64",
"type": [
"integer",
"null"
]
},
"similar_apps": {
"description": "similar apps
displays apps similar to the app in a POST request",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"size": {
"description": "size of the app",
"type": [
"string",
"null"
]
},
"subtitle": {
"description": "subtitle of the app",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the app",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"update_notes": {
"description": "update notes
contains the latest update notes from the developer",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the app page on App Store",
"type": [
"string",
"null"
]
},
"version": {
"description": "current version of the app",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppStoreReviewsSearch": {
"properties": {
"id": {
"description": "id of the review",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the review in SERP
can take the following values: left",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score submitted by the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"review_text": {
"description": "content of the review",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the review was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the review",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"user_profile": {
"description": "user profile of the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppUserProfileInfo"
}
],
"type": [
"object",
"null"
]
},
"version": {
"description": "version of the app
version of the app for which the review is submitted",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppStoreSearchOrganic": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"icon": {
"description": "URL to the app icon",
"type": [
"string",
"null"
]
},
"is_free": {
"description": "indicates whether the app is free",
"type": [
"boolean",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"price": {
"description": "pricing information for the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "average rating of the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews of the app",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the app",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the app page on App Store",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppUserProfileInfo": {
"properties": {
"profile_image_url": {
"description": "URL to the reviewer's profile image",
"type": [
"string",
"null"
]
},
"profile_name": {
"description": "profile name of the reviewer",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppleRankedSerpElementInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"previous_updated_time": {
"description": "previous to the most recent date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-10-15 12:57:46 +00:00;
in this case, will equal null",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "number of search results for the returned keyword",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"serp_item": {
"description": "contains data on the SERP element
the list of supported SERP elements can be found below",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppStoreSearchOrganic"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AppsInfo": {
"properties": {
"app_id": {
"description": "ID of the app",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the app",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the app page on Google Play",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AudienceEstimationInfo": {
"properties": {
"high": {
"description": "indicates the upper bound of the range result",
"format": "double",
"type": [
"number",
"null"
]
},
"low": {
"description": "indicates the lower bound of the range result",
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AuthorsElement": {
"properties": {
"domain": {
"description": "author’s link domain",
"type": [
"string",
"null"
]
},
"name": {
"description": "name of the dataset author",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "author’s link URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Autocomplete": {
"properties": {
"highlighted": {
"description": "keywords highlighted in autocomplete
contains a list of google autocomplete suggestions that are highlighted in the search bar;
Note: array is only available for the following client:gws-wizpsy-abgws-wiz-local",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"relevance": {
"description": "relevance of suggested keyword
represents the relevant of the autocomplete suggestion to the target keyword
can take values from 500 to 2000
the higher the value, the more relevant is the suggestion
Note: only available for the following client:chrome/chrome-omni",
"type": [
"integer",
"null"
]
},
"search_query_url": {
"description": "url to search results
url to search results relevant to the google autocomplete suggestion",
"type": [
"string",
"null"
]
},
"suggestion": {
"description": "google autocomplete keyword suggestion",
"type": [
"string",
"null"
]
},
"suggestion_type": {
"description": "google autocomplete suggestion type
Note: only available for the following client:chrome/chrome-omni",
"type": [
"string",
"null"
]
},
"thumbnail_url": {
"description": "url of the thumbnail image
url of the thumbnail image of the google autocomplete suggestion
Note: only available for the following client:gws-wizgws-wiz-serp",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AvailableLanguages": {
"properties": {
"available_sources": {
"description": "supported sources
contains the sources of data supported for a specific location and language combination
only google and bing are currently available",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"keywords": {
"description": "the number of keywords available for the given location and language",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
},
"serps": {
"description": "the number of SERP pages available for the given location and language",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AvailableLocations": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "location name",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
possible values:Country, Region",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AvailibleVersions": {
"properties": {
"default": {
"description": "the version is used by default
if false, the version is not used by default and should be specified in the corresponding field of the POST request if necessary",
"type": [
"boolean",
"null"
]
},
"version": {
"description": "lighthouse version",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_AvgBacklinksInfo": {
"properties": {
"backlinks": {
"description": "average number of backlinks",
"type": [
"number",
"null"
]
},
"dofollow": {
"description": "average number of dofollow links",
"type": [
"number",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"main_domain_rank": {
"description": "average main domain rank
learn more about the metric and its calculation formula in this help center article",
"type": [
"number",
"null"
]
},
"rank": {
"description": "average rank
learn more about the metric and its calculation formula in this help center article",
"type": [
"number",
"null"
]
},
"referring_domains": {
"description": "average number of referring domains",
"type": [
"number",
"null"
]
},
"referring_main_domains": {
"description": "average number of referring main domains",
"type": [
"number",
"null"
]
},
"referring_pages": {
"description": "average number of referring pages",
"type": [
"number",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksAnchorsLiveItem": {
"properties": {
"anchor": {
"description": "anchor of the backlink",
"type": [
"string",
"null"
]
},
"backlinks": {
"description": "indicates the number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_spam_score": {
"description": "average spam score of all backlinks with this anchor
learn more about how the metric is calculated on this help center page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to",
"type": [
"integer",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink with this anchor for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_date": {
"description": "date and time when the last backlink with this anchor was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "rank of the anchor links
rank volume that referring websites pass to the target through links with a particular anchorrank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "indicates the number of referring domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location
examples:article, section, summary",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "indicates the number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to target with this anchor",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target with this anchor",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksAnchorsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksAnchorsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksAnchorsLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksAnchorsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target in the post array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksAnchorsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksAnchorsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBacklinksLiveItem": {
"properties": {
"alt": {
"description": "alternative text of the image
this field will be null if backlink type is not image",
"type": [
"string",
"null"
]
},
"anchor": {
"description": "anchor text of the backlink",
"type": [
"string",
"null"
]
},
"attributes": {
"description": "link attributes of the referring links
example:nofollow",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"backlink_spam_score": {
"description": "spam score of the backlink
learn more about how the metric is calculated on this help center page",
"type": [
"integer",
"null"
]
},
"dofollow": {
"description": "indicates whether the backlink is dofollow
if false, the backlink is nofollow",
"type": [
"boolean",
"null"
]
},
"domain_from": {
"description": "domain referring to the target domain or webpage",
"type": [
"string",
"null"
]
},
"domain_from_country": {
"description": "ISO country code of the referring domain",
"type": [
"string",
"null"
]
},
"domain_from_ip": {
"description": "IP address of the referring domain",
"type": [
"string",
"null"
]
},
"domain_from_is_ip": {
"description": "indicates if the domain is IP
if true, the domain functions as an IP address and does not have a domain name",
"type": [
"boolean",
"null"
]
},
"domain_from_platform_type": {
"description": "platform types of the referring domaincms, blogs, ecommerce, message-boards, wikis, news, organization",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"domain_from_rank": {
"description": "domain rank of the referring domaindomain_from_rank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"domain_to": {
"description": "domain the backlink is pointing to",
"type": [
"string",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"group_count": {
"description": "indicates total number of backlinks from this domain
for example, if mode is set to one_per_domain, this field will indicate the total number of backlinks coming from this domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"indirect_link_path": {
"description": "indirect link path
indicates a URL or a sequence of URLs that lead to url_to",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksRedirectInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_broken": {
"description": "indicates whether the backlink is broken
if true, the backlink is pointing to a page responding with a 4xx or 5xx status code",
"type": [
"boolean",
"null"
]
},
"is_indirect_link": {
"description": "indicates whether the backlink is an indirect link
if true, the backlink is an indirect link pointing to a page that either redirects to url_to, or points to a canonical page",
"type": [
"boolean",
"null"
]
},
"is_lost": {
"description": "indicates whether the backlink was removed
if true, the backlink or the entire page was removed",
"type": [
"boolean",
"null"
]
},
"is_new": {
"description": "indicates whether the backlink is new
if true, the backlink was found on the page last time our crawler visited it",
"type": [
"boolean",
"null"
]
},
"item_type": {
"description": "link type
possible values:anchor, image, meta, canonical, alternate, redirect",
"type": [
"string",
"null"
]
},
"last_seen": {
"description": "most recent date when our crawler visited the backlink
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"links_count": {
"description": "number of identical backlinks found on the referring page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"original": {
"description": "indicates whether the backlink was present on the referring page when our crawler first visited it",
"type": [
"boolean",
"null"
]
},
"page_from_encoding": {
"description": "character encoding of the referring page
example:utf-8",
"type": [
"string",
"null"
]
},
"page_from_external_links": {
"description": "number of external links found on the referring page",
"type": [
"integer",
"null"
]
},
"page_from_internal_links": {
"description": "number of internal links found on the referring page",
"type": [
"integer",
"null"
]
},
"page_from_language": {
"description": "language of the referring page
in ISO 639-1 format
example:en",
"type": [
"string",
"null"
]
},
"page_from_rank": {
"description": "page rank of the referring pagepage_from_rank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"page_from_size": {
"description": "size of the referring page, in bytes
example:63357",
"type": [
"integer",
"null"
]
},
"page_from_status_code": {
"description": "HTTP status code returned by the referring page
example:200",
"type": [
"integer",
"null"
]
},
"page_from_title": {
"description": "title of the referring page",
"type": [
"string",
"null"
]
},
"prev_seen": {
"description": "previous to the most recent date when our crawler visited the backlink
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "backlink rank
rank that the given backlink passes to the targetrank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"ranked_keywords_info": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankedKeywordsInfo"
}
],
"type": [
"object",
"null"
]
},
"semantic_location": {
"description": "indicates semantic element in HTML where the backlink is found
you can get the full list of semantic elements here
examples:article, section, summary",
"type": [
"string",
"null"
]
},
"text_post": {
"description": "snippet after the anchor text",
"type": [
"string",
"null"
]
},
"text_pre": {
"description": "snippet before the anchor text",
"type": [
"string",
"null"
]
},
"tld_from": {
"description": "top-level domain of the referring URL",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url_from": {
"description": "URL of the page where the backlink is found",
"type": [
"string",
"null"
]
},
"url_from_https": {
"description": "indicates whether the referring URL is secured with HTTPS
if true, the referring URL is secured with HTTPS",
"type": [
"boolean",
"null"
]
},
"url_to": {
"description": "URL the backlink is pointing to",
"type": [
"string",
"null"
]
},
"url_to_https": {
"description": "indicates if the URL the backlink is pointing to is secured with HTTPS
if true, the URL is secured with HTTPS",
"type": [
"boolean",
"null"
]
},
"url_to_redirect_target": {
"description": "target url of the redirect
target page the redirect is pointing to",
"type": [
"string",
"null"
]
},
"url_to_spam_score": {
"description": "spam score of the referenced page
if the value is null, our crawler hasn't yet visited the webpage the link is pointing to;
learn more about how the metric is calculated on this help center page",
"type": [
"integer",
"null"
]
},
"url_to_status_code": {
"description": "status code of the referenced page
if the value is null, our crawler hasn't yet visited the webpage the link is pointing to
example:200",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBacklinksLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBacklinksLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBacklinksLiveResultInfo": {
"properties": {
"custom_mode": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "custom mode specified in a POST array",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBacklinksLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"mode": {
"description": "mode specified in a POST array",
"type": [
"string",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests
by specifying the unique search_after_token when setting a new task, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBacklinksLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBacklinksLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkBacklinksLiveItem": {
"properties": {
"backlinks": {
"description": "number of backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage from a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkBacklinksLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkBacklinksLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkBacklinksLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant backlink data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkBacklinksLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkBacklinksLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkBacklinksLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveItem": {
"properties": {
"lost_backlinks": {
"description": "number of lost backlinks
number of lost backlinks of the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_backlinks": {
"description": "number of new backlinks
number of new backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage from a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveItem": {
"properties": {
"lost_referring_domains": {
"description": "number of lost referring domains
number of lost referring domains of the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"lost_referring_main_domains": {
"description": "number of lost referring main domains pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_referring_domains": {
"description": "number of new referring domains
number of new referring domains pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_referring_main_domains": {
"description": "number of new referring main domains pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage from a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkPagesSummaryLiveItem": {
"properties": {
"backlinks": {
"description": "number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_spam_score": {
"description": "average spam score of the backlinks pointing to the page
learn more about how the metric is calculated on this help center page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to",
"type": [
"integer",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found a backlink to this page for the first time
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_date": {
"description": "date and time when the last backlink to this page was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"main_domain_rank": {
"description": "rank of the main domain
rank of the main domain is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"rank": {
"description": "page rank
rank of the page on the target websiterank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "indicates the number domains referring to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location
examples:article, section, footer",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "indicates the number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to the relevant url",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkPagesSummaryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkPagesSummaryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkPagesSummaryLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkPagesSummaryLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkPagesSummaryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkPagesSummaryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkRanksLiveItem": {
"properties": {
"rank": {
"description": "rank of the target
values represent real-time data for the date of the requestrank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage from a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkRanksLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkRanksLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkRanksLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkRanksLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkRanksLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkRanksLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkReferringDomainsLiveItem": {
"properties": {
"referring_domains": {
"description": "number of referring domains pointing to the target
note that we calculate main domains (root domains, like example.com) and their subdomains (e.g. blog.example.com) separately for this metric",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains": {
"description": "number of referring main domains pointing to the target
the number of primary (root) domains referring to your target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage from a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkReferringDomainsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkReferringDomainsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkReferringDomainsLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkReferringDomainsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkReferringDomainsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkReferringDomainsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkSpamScoreLiveItem": {
"properties": {
"spam_score": {
"description": "average spam score the target
learn more about how the metric is calculated",
"type": [
"integer",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage from a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkSpamScoreLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkSpamScoreLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksBulkSpamScoreLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkSpamScoreLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksBulkSpamScoreLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkSpamScoreLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksCompetitorsLiveItem": {
"properties": {
"intersections": {
"description": "indicates the number of backlink intersections with the target specified in the POST array",
"type": [
"integer",
"null"
]
},
"rank": {
"description": "domain rank
domain rank across all domains in the databaserank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"target": {
"description": "competitor domain",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksCompetitorsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksCompetitorsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksCompetitorsLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksCompetitorsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksCompetitorsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksCompetitorsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksDomainIntersection": {
"properties": {
"backlinks": {
"description": "indicates the number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_spam_score": {
"description": "average spam score of the backlinks pointing to the target
learn more about how the metric is calculated on this help center page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages",
"type": [
"integer",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink from this target for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_date": {
"description": "date and time when the last backlink from this target was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "rank referred to the target from the POST array
indicates the rank that the referring domain (target above) refers to your target from the POST array;rank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "number of referring domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the corresponding target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and the link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and the link count per each semantic location
you can get the full list of semantic elements here",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"type": [
"integer",
"null"
]
},
"description": "top level domains of the referring links
contains top-level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"type": [
"integer",
"null"
]
},
"description": "types of the referring links
indicates the types of referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "domain that links to the corresponding target from the POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksDomainIntersectionLiveItem": {
"properties": {
"domain_intersection": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainIntersection"
}
],
"type": [
"object",
"null"
]
},
"description": "contains data on domains that link to the corresponding targets specified in the POST array
data is provided in separate objects corresponding to domains, subdomains or pages specified in the targets object",
"type": [
"object",
"null"
]
},
"summary": {
"description": "contains the domain intersections summary",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_IntersectionSummaryInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksDomainIntersectionLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainIntersectionLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksDomainIntersectionLiveResultInfo": {
"properties": {
"items": {
"description": "contains domain that link to all targets from the POST array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainIntersectionLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"targets": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "target domains, subdomains or webpages in a POST array",
"type": [
"object",
"null"
]
},
"total_count": {
"description": "total amount of results relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksDomainIntersectionLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainIntersectionLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesLiveItem": {
"properties": {
"content_encoding": {
"description": "type of encoding",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain
domain where the page was found",
"type": [
"string",
"null"
]
},
"encoded_size": {
"description": "page size after encoding
indicates the size of the encoded page, in bytes",
"type": [
"integer",
"null"
]
},
"fetch_time": {
"description": "most recent date and time when our crawler visited the page
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"first_visited": {
"description": "date and time of the first page visit
date and time when our crawler visited this page for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"ip": {
"description": "Internet Protocol address",
"type": [
"string",
"null"
]
},
"location": {
"description": "location header
indicates the URL to redirect a page to if exists",
"type": [
"string",
"null"
]
},
"main_domain": {
"description": "main website domain
main website domain does not include subdomains",
"type": [
"string",
"null"
]
},
"media_type": {
"description": "types of media used to display a page",
"type": [
"string",
"null"
]
},
"meta": {
"description": "page meta data",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksPageMeta"
}
],
"properties": {
"social_media_tags": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"page": {
"description": "page URL
relevant page URL",
"type": [
"string",
"null"
]
},
"page_summary": {
"description": "contains backlink data for this page",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageSummary"
}
],
"properties": {
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": [
"object",
"null"
]
},
"referring_main_domains_nofollow": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"prev_visited": {
"description": "previous to the most recent date when our crawler visited the page
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"server": {
"description": "server version",
"type": [
"string",
"null"
]
},
"size": {
"description": "indicates the page size, in bytes",
"type": [
"integer",
"null"
]
},
"status_code": {
"description": "general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions",
"type": [
"integer",
"null"
]
},
"tld": {
"description": "top-level domain
top-level domain in the DNS root zone",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainPagesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainPagesLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainPagesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesSummaryLiveItem": {
"properties": {
"backlinks": {
"description": "number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_spam_score": {
"description": "average spam score of the backlinks pointing to the page
learn more about how the metric is calculated on this help center page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to",
"type": [
"integer",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found a backlink to this page for the first time
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_date": {
"description": "date and time when the last backlink to this page was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "page rank
rank of the pagerank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "indicates the number domains referring to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location
examples:article, section, footer",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "indicates the number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to the relevant url",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesSummaryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainPagesSummaryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesSummaryLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainPagesSummaryLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target in the post array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksDomainPagesSummaryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainPagesSummaryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksHistoryLiveItem": {
"properties": {
"backlinks": {
"description": "number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages that receive backlinks but respond with 4xx or 5xx status codes",
"type": [
"integer",
"null"
]
},
"crawled_pages": {
"description": "number of crawled pages for the target",
"type": [
"integer",
"null"
]
},
"date": {
"description": "date and time when the data for the target was stored
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"external_links_count": {
"description": "number of external links on the page
calculated as the sum of external links on the pages of the specified target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"info": {
"description": "information about the target",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TargetInfo"
}
],
"type": [
"object",
"null"
]
},
"internal_links_count": {
"description": "number of internal links
calculated as the sum of internal links on the pages of the specified target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"lost_backlinks": {
"description": "number of lost backlinks for the target
data is provided based in a comparison with the previous period
Note: this data is available from May 2021;
if the date range specified in the POST request precedes May 2021, the field will equal 0",
"format": "int64",
"type": [
"integer",
"null"
]
},
"lost_referring_domains": {
"description": "number of lost referring domains for the target
data is provided based in a comparison with the previous period
Note: this data is available from May 2021;
if the date range specified in the POST request precedes May 2021, the field will equal 0",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_backlinks": {
"description": "number of new backlinks for the target
data is provided based in a comparison with the previous period
Note: this data is available from May 2021;
if the date range specified in the POST request precedes May 2021, the field will equal 0",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_referring_domains": {
"description": "number of new referring domains for the target
data is provided based in a comparison with the previous period
Note: this data is available from May 2021;
if the date range specified in the POST request precedes May 2021, the field will equal 0",
"format": "int64",
"type": [
"integer",
"null"
]
},
"rank": {
"description": "domain rank on the given date
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "number of referring domains
referring domains include subdomains that are counted as separate domains for this metric",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location
you can get the full list of semantic elements here
examples:article, section, summary",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top-level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "number of pages pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksHistoryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksHistoryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksHistoryLiveResultInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
in the UTC format: “yyyy-mm-dd”
example:2019-01-01",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
in the UTC format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains historical backlink data for the specified domain
the data is provided month-by-month;
the metrics are aggregated according to the backlinks the specified domain had on the first day of each given month",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksHistoryLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target from the POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksHistoryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksHistoryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksIndexResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksIndexTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksIndexResultInfo": {
"properties": {
"index_history": {
"description": "index volume data for the past 12 months",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_IndexHistory"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_backlinks": {
"description": "total number of backlinks our database contains for the moment of checking",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_pages": {
"description": "total number of pages our database contains for the moment of checking",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksIndexTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksIndexResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksInfo": {
"properties": {
"backlinks": {
"description": "average number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"dofollow": {
"description": "average number of dofollow links",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "average number of referring domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains": {
"description": "average number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "average number of referring pages",
"format": "int64",
"type": [
"integer",
"null"
]
},
"time_update": {
"description": "date and time when backlink data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksPageIntersection": {
"properties": {
"alt": {
"description": "alternative text of the image
this field will be null if backlink type is not image",
"type": [
"string",
"null"
]
},
"anchor": {
"description": "anchor text of the backlink",
"type": [
"string",
"null"
]
},
"attributes": {
"description": "link attributes of the referring links
example:nofollow",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"backlink_spam_score": {
"description": "spam score of the backlink
learn more about how the metric is calculated on this help center page",
"type": [
"integer",
"null"
]
},
"dofollow": {
"description": "indicates whether the backlink is dofollow
if false, the backlink is nofollow",
"type": [
"boolean",
"null"
]
},
"domain_from": {
"description": "domain referring to the target domain or webpage",
"type": [
"string",
"null"
]
},
"domain_from_country": {
"description": "ISO country code of the referring domain",
"type": [
"string",
"null"
]
},
"domain_from_ip": {
"description": "IP address of the referring domain",
"type": [
"string",
"null"
]
},
"domain_from_is_ip": {
"description": "indicates if the domain is IP
if true, the domain functions as an IP address and does not have a domain name",
"type": [
"boolean",
"null"
]
},
"domain_from_platform_type": {
"description": "platform types of the referring domaincms, blogs, ecommerce, message-boards, wikis, news, organization",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"domain_from_rank": {
"description": "domain rank of the referring domain
indicates the rank of the domain at the time our crawler last saw the backlink;domain_from_rank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"domain_to": {
"description": "domain the backlink is pointing to",
"type": [
"string",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"group_count": {
"description": "indicates total number of backlinks from this domain
for example, if mode is set to one_per_domain, this field will indicate the total number of backlinks coming from this domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"indirect_link_path": {
"description": "indirect link path
indicates a URL or a sequence of URLs that lead to url_to",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksRedirectInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_broken": {
"description": "indicates whether the backlink is broken
if true, the backlink is pointing to a page responding with a 4xx or 5xx status code",
"type": [
"boolean",
"null"
]
},
"is_indirect_link": {
"description": "indicates whether the backlink is an indirect link
if true, the backlink is an indirect link pointing to a page that either redirects to url_to, or points to a canonical page",
"type": [
"boolean",
"null"
]
},
"is_lost": {
"description": "indicates whether the backlink was removed
if true, the backlink or the entire page was removed",
"type": [
"boolean",
"null"
]
},
"is_new": {
"description": "indicates whether the backlink is new
if true, the backlink was found on the page last time our crawler visited it",
"type": [
"boolean",
"null"
]
},
"item_type": {
"description": "link type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"string",
"null"
]
},
"last_seen": {
"description": "most recent date when our crawler visited the backlink
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"links_count": {
"description": "number of identical backlinks found on the referring page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"original": {
"description": "indicates whether the backlink was present on the referring page when our crawler first visited it",
"type": [
"boolean",
"null"
]
},
"page_from_encoding": {
"description": "character encoding of the referring page
example:utf-8",
"type": [
"string",
"null"
]
},
"page_from_external_links": {
"description": "number of external links found on the referring page",
"type": [
"integer",
"null"
]
},
"page_from_internal_links": {
"description": "number of internal links found on the referring page",
"type": [
"integer",
"null"
]
},
"page_from_language": {
"description": "language of the referring page
in ISO 639-1 format
example:en",
"type": [
"string",
"null"
]
},
"page_from_rank": {
"description": "page rank of the referring pagepage_from_rank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"page_from_size": {
"description": "size of the referring page, in bytes
example:63357",
"type": [
"integer",
"null"
]
},
"page_from_status_code": {
"description": "HTTP status code returned by the referring page
example:200",
"type": [
"integer",
"null"
]
},
"page_from_title": {
"description": "title of the referring page",
"type": [
"string",
"null"
]
},
"prev_seen": {
"description": "previous to the most recent date when our crawler visited the backlink
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "backlink rankrank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"semantic_location": {
"description": "indicates semantic element in HTML where the backlink is found
you can get the full list of semantic elements here
examples:article, section, summary",
"type": [
"string",
"null"
]
},
"text_post": {
"description": "snippet after the anchor text",
"type": [
"string",
"null"
]
},
"text_pre": {
"description": "text snippet before the anchor text",
"type": [
"string",
"null"
]
},
"tld_from": {
"description": "top-level domain of the referring URL",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url_from": {
"description": "URL of the page where the backlink is found",
"type": [
"string",
"null"
]
},
"url_from_https": {
"description": "indicates whether the referring URL is secured with HTTPS
if true, the referring URL is secured with HTTPS",
"type": [
"boolean",
"null"
]
},
"url_to": {
"description": "URL the backlink is pointing to",
"type": [
"string",
"null"
]
},
"url_to_https": {
"description": "indicates if the URL the backlink is pointing to is secured with HTTPS
if true, the URL is secured with HTTPS",
"type": [
"boolean",
"null"
]
},
"url_to_redirect_target": {
"description": "target url of the redirect
target page the redirect is pointing to",
"type": [
"string",
"null"
]
},
"url_to_spam_score": {
"description": "spam score of the referenced page
if the value is null, our crawler hasn't yet visited the webpage the link is pointing to
learn more about how the metric is calculated on this help center page",
"type": [
"integer",
"null"
]
},
"url_to_status_code": {
"description": "status code of the referenced page
if the value is null, our crawler hasn't yet visited the webpage the link is pointing to
example:200",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksPageIntersectionLiveItem": {
"properties": {
"page_intersection": {
"additionalProperties": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksPageIntersection"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "contains data on pages that link to the corresponding targets specified in the POST array
data is provided in separate objects corresponding to pages specified in the targets object",
"type": [
"object",
"null"
]
},
"summary": {
"description": "contains the page intersections summary",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_IntersectionSummaryInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksPageIntersectionLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksPageIntersectionLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksPageIntersectionLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksPageIntersectionLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"targets": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "targets from a POST array",
"type": [
"object",
"null"
]
},
"total_count": {
"description": "total amount of results relevant the request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksPageIntersectionLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksPageIntersectionLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksPageMeta": {
"properties": {
"canonical": {
"description": "canonical page",
"type": [
"string",
"null"
]
},
"charset": {
"description": "character encoding
examples:utf-8",
"type": [
"string",
"null"
]
},
"external_links_count": {
"description": "number of external links on the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"h1": {
"description": "h1 tag
content of h1 tags",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"h2": {
"description": "h2 tag
content of h2 tags",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"h3": {
"description": "h3 tag
content of h3 tags",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images_alt": {
"description": "content of alt tags",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images_count": {
"description": "number of images on the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"internal_links_count": {
"description": "number of internal links on the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language": {
"description": "page content language
example:en",
"type": [
"string",
"null"
]
},
"page_spam_score": {
"description": "spam score of the page
learn more about how the metric is calculated on this help center page",
"type": [
"integer",
"null"
]
},
"platform_type": {
"description": "type of a platform",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"powered_by": {
"description": "CMS details",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"social_media_tags": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "array of social media tags found on the page
contains social media tags and their content
supported tags include but are not limited to Open Graph and Twitter card",
"type": [
"object",
"null"
]
},
"technologies": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "website technologies",
"type": [
"object",
"null"
]
},
"title": {
"description": "page title",
"type": [
"string",
"null"
]
},
"words_count": {
"description": "number of words on the page",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksRedirectInfo": {
"properties": {
"status_code": {
"description": "general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "indirect link URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksReferringDomainsLiveItem": {
"properties": {
"backlinks": {
"description": "indicates the number of backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_spam_score": {
"description": "average spam score of all backlinks pointing to the domain
learn more about how the metric is calculated on this help center page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to",
"type": [
"integer",
"null"
]
},
"domain": {
"description": "referring domain",
"type": [
"string",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_date": {
"description": "date and time when the last backlink from this domain was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "domain rank
rank volume that a referring website passes to the targetrank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "indicates the number of referring domains
note that we calculate main domains (root domains, like example.com) and their subdomains (e.g. blog.example.com) separately for this metric",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and the link count per each semantic location
examples:article, section, summary",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "indicates the number of referring main domains
the number of primary (root) domains referring to your target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to the target specified",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksReferringDomainsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksReferringDomainsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksReferringDomainsLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksReferringDomainsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database
total number of main domains referring to your target;
example.com and blog.example.com are counted as one referring domain",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksReferringDomainsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksReferringDomainsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksReferringNetworksLiveItem": {
"properties": {
"backlinks": {
"description": "indicates the number of backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to",
"type": [
"integer",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_date": {
"description": "date and time when the last backlink from this domain was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"network_address": {
"description": "address of the referring subnetwork or IP",
"type": [
"string",
"null"
]
},
"rank": {
"description": "network rank
rank volume that a referring network passes to the targetrank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "indicates the number of referring domains
referring domains include subdomains that are counted as separate domains for this metric",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and the link count per each semantic location
examples:article, section, summary",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "indicates the number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to the target specified",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksReferringNetworksLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksReferringNetworksLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksReferringNetworksLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksReferringNetworksLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksReferringNetworksLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksReferringNetworksLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksSummaryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksSummaryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksSummaryLiveResultInfo": {
"properties": {
"backlinks": {
"description": "indicates the number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_spam_score": {
"description": "spam score of the backlinks
displays the total spam score of all backlinks pointing to the target domain, subdomain, or webpage;
to learn more about how the metric is calculated, refer to this Help Center page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages on the target that respond with 4xx or 5xx status codestarget discovered by following external links, but it may also include pages discovered by following the target's sitemap",
"type": [
"integer",
"null"
]
},
"crawled_pages": {
"description": "number of crawled pages for the target",
"type": [
"integer",
"null"
]
},
"external_links_count": {
"description": "number of external links on the page
calculated as the sum of external links on the pages of the specified target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink for the target for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"info": {
"description": "information about the target",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TargetInfo"
}
],
"type": [
"object",
"null"
]
},
"internal_links_count": {
"description": "number of internal links
calculated as the sum of internal links on the pages of the specified target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"lost_date": {
"description": "date and time when the backlink was lost
indicates the date and time when our crawler visited the target and it responded with a 4xx or 5xx status code or when its last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "target rank
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "indicates the number of referring domains
referring domains include subdomains that are counted as separate domains for this metric",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute
example values:nofollow, noopener, noreferrer, external, ugc, sponsored",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location
example values:article, section, summary, \"\"",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "indicates the number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksSummaryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksSummaryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveItem": {
"properties": {
"date": {
"description": "date and time when the data for the target was stored
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_backlinks": {
"description": "number of lost backlinks
number of lost backlinks of the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"lost_referring_domains": {
"description": "number of lost referring domains
number of lost referring domains of the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"lost_referring_main_domains": {
"description": "number of lost referring main domains
number of lost referring main domains of the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_backlinks": {
"description": "number of new backlinks
number of new backlinks pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_referring_domains": {
"description": "number of new referring domains
number of new referring domains pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_referring_main_domains": {
"description": "number of new referring main domains
number of new referring main domains pointing to the target",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveResultInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
in the UTC format: “yyyy-mm-dd”
example:2019-01-01",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
in the UTC format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"group_range": {
"description": "group_range from the POST array",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains relevant backlinks and referring domains data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target from a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksTimeseriesNewLostSummaryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesSummaryLiveItem": {
"properties": {
"backlinks": {
"description": "number of backlinks for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_nofollow": {
"description": "number of nofollow backlinks for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"date": {
"description": "date and time when the data for the target was stored
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "target rank for the given date
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "number of referring domains for the given date
referring domains include subdomains that are counted as separate domains for this metric",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the target for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses for the given date
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains": {
"description": "number of referring main domains for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the target for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "number of pages pointing to target for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the target for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks for the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesSummaryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksTimeseriesSummaryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesSummaryLiveResultInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range
in the UTC format: “yyyy-mm-dd”
example:2019-01-01",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range
in the UTC format: \"yyyy-mm-dd\"
example:\"2019-01-15\"",
"type": [
"string",
"null"
]
},
"group_range": {
"description": "POST 数组中的 group_range",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains relevant summary data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksTimeseriesSummaryLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"description": "target from a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BacklinksTimeseriesSummaryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksTimeseriesSummaryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"message": "#/components/schemas/Response0A3E90081762_MessageAiOptimizationLlmResponseElementItem",
"reasoning": "#/components/schemas/Response0A3E90081762_ReasoningAiOptimizationLlmResponseElementItem"
},
"propertyName": "type"
},
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseBingSerpApiElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"ai_overview": "#/components/schemas/Response0A3E90081762_BingAiOverviewSerpElementItem",
"answer_box": "#/components/schemas/Response0A3E90081762_BingAnswerBoxSerpElementItem",
"carousel": "#/components/schemas/Response0A3E90081762_BingCarouselSerpElementItem",
"events": "#/components/schemas/Response0A3E90081762_BingEventsSerpElementItem",
"featured_snippet": "#/components/schemas/Response0A3E90081762_BingFeaturedSnippetSerpElementItem",
"hotels_pack": "#/components/schemas/Response0A3E90081762_BingHotelsPackSerpElementItem",
"images": "#/components/schemas/Response0A3E90081762_BingImagesSerpElementItem",
"jobs": "#/components/schemas/Response0A3E90081762_BingJobsSerpElementItem",
"local_pack": "#/components/schemas/Response0A3E90081762_BingLocalPackSerpElementItem",
"map": "#/components/schemas/Response0A3E90081762_BingMapSerpElementItem",
"organic": "#/components/schemas/Response0A3E90081762_BingOrganicSerpElementItem",
"paid": "#/components/schemas/Response0A3E90081762_BingPaidSerpElementItem",
"people_also_ask": "#/components/schemas/Response0A3E90081762_BingPeopleAlsoAskSerpElementItem",
"people_also_search": "#/components/schemas/Response0A3E90081762_BingPeopleAlsoSearchSerpElementItem",
"questions_and_answers": "#/components/schemas/Response0A3E90081762_BingQuestionsAndAnswersSerpElementItem",
"recipes": "#/components/schemas/Response0A3E90081762_BingRecipesSerpElementItem",
"related_searches": "#/components/schemas/Response0A3E90081762_BingRelatedSearchesSerpElementItem",
"shopping": "#/components/schemas/Response0A3E90081762_BingShoppingSerpElementItem",
"top_stories": "#/components/schemas/Response0A3E90081762_BingTopStoriesSerpElementItem",
"video": "#/components/schemas/Response0A3E90081762_BingVideoSerpElementItem"
},
"propertyName": "type"
},
"properties": {
"page": {
"description": "search results page number
indicates the number of the SERP page on which the element is located",
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:
left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result's snippet in SERP
equals null if calculate_rectangles in the POST request is not set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseChatGptLlmScraperElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"chat_gpt_ad": "#/components/schemas/Response0A3E90081762_ChatGptAdElementItem",
"chat_gpt_images": "#/components/schemas/Response0A3E90081762_ChatGptImagesElementItem",
"chat_gpt_local_businesses": "#/components/schemas/Response0A3E90081762_ChatGptLocalBusinessesElementItem",
"chat_gpt_navigation_list": "#/components/schemas/Response0A3E90081762_ChatGptNavigationListElementItem",
"chat_gpt_products": "#/components/schemas/Response0A3E90081762_ChatGptProductsElementItem",
"chat_gpt_table": "#/components/schemas/Response0A3E90081762_ChatGptTableElementItem",
"chat_gpt_text": "#/components/schemas/Response0A3E90081762_ChatGptTextElementItem"
},
"propertyName": "type"
},
"properties": {
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseDataforseoLabsApiElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"answer_box": "#/components/schemas/Response0A3E90081762_DataLabsAnswerBoxSerpElementItem",
"carousel": "#/components/schemas/Response0A3E90081762_DataLabsCarouselSerpElementItem",
"commercial_units": "#/components/schemas/Response0A3E90081762_DataLabsCommercialUnitsSerpElementItem",
"courses": "#/components/schemas/Response0A3E90081762_DataLabsCoursesSerpElementItem",
"events": "#/components/schemas/Response0A3E90081762_DataLabsEventsSerpElementItem",
"explore_brands": "#/components/schemas/Response0A3E90081762_DataLabsExploreBrandsSerpElementItem",
"featured_snippet": "#/components/schemas/Response0A3E90081762_DataLabsFeaturedSnippetSerpElementItem",
"find_results_on": "#/components/schemas/Response0A3E90081762_DataLabsFindResultsOnSerpElementItem",
"found_on_web": "#/components/schemas/Response0A3E90081762_DataLabsFoundOnWebSerpElementItem",
"google_flights": "#/components/schemas/Response0A3E90081762_DataLabsGoogleFlightsSerpElementItem",
"google_hotels": "#/components/schemas/Response0A3E90081762_DataLabsGoogleHotelsSerpElementItem",
"google_posts": "#/components/schemas/Response0A3E90081762_DataLabsGooglePostsSerpElementItem",
"google_reviews": "#/components/schemas/Response0A3E90081762_DataLabsGoogleReviewsSerpElementItem",
"hotels_pack": "#/components/schemas/Response0A3E90081762_DataLabsHotelsPackSerpElementItem",
"images": "#/components/schemas/Response0A3E90081762_DataLabsImagesSerpElementItem",
"jobs": "#/components/schemas/Response0A3E90081762_DataLabsJobsSerpElementItem",
"knowledge_graph": "#/components/schemas/Response0A3E90081762_DataLabsKnowledgeGraphSerpElementItem",
"local_pack": "#/components/schemas/Response0A3E90081762_DataLabsLocalPackSerpElementItem",
"local_services": "#/components/schemas/Response0A3E90081762_DataLabsLocalServicesSerpElementItem",
"map": "#/components/schemas/Response0A3E90081762_DataLabsMapSerpElementItem",
"math_solver": "#/components/schemas/Response0A3E90081762_DataLabsMathSolverSerpElementItem",
"mention_carousel": "#/components/schemas/Response0A3E90081762_DataLabsMentionCarouselSerpElementItem",
"multi_carousel": "#/components/schemas/Response0A3E90081762_DataLabsMultiCarouselSerpElementItem",
"organic": "#/components/schemas/Response0A3E90081762_DataLabsOrganicSerpElementItem",
"paid": "#/components/schemas/Response0A3E90081762_DataLabsPaidSerpElementItem",
"people_also_ask": "#/components/schemas/Response0A3E90081762_DataLabsPeopleAlsoAskSerpElementItem",
"people_also_search": "#/components/schemas/Response0A3E90081762_DataLabsPeopleAlsoSearchSerpElementItem",
"podcasts": "#/components/schemas/Response0A3E90081762_DataLabsPodcastsSerpElementItem",
"popular_products": "#/components/schemas/Response0A3E90081762_DataLabsPopularProductsSerpElementItem",
"questions_and_answers": "#/components/schemas/Response0A3E90081762_DataLabsQuestionsAndAnswersSerpElementItem",
"recipes": "#/components/schemas/Response0A3E90081762_DataLabsRecipesSerpElementItem",
"related_searches": "#/components/schemas/Response0A3E90081762_DataLabsRelatedSearchesSerpElementItem",
"scholarly_articles": "#/components/schemas/Response0A3E90081762_DataLabsScholarlyArticlesSerpElementItem",
"shopping": "#/components/schemas/Response0A3E90081762_DataLabsShoppingSerpElementItem",
"stocks_box": "#/components/schemas/Response0A3E90081762_DataLabsStocksBoxSerpElementItem",
"top_sights": "#/components/schemas/Response0A3E90081762_DataLabsTopSightsSerpElementItem",
"top_stories": "#/components/schemas/Response0A3E90081762_DataLabsTopStoriesSerpElementItem",
"twitter": "#/components/schemas/Response0A3E90081762_DataLabsTwitterSerpElementItem",
"video": "#/components/schemas/Response0A3E90081762_DataLabsVideoSerpElementItem",
"visual_stories": "#/components/schemas/Response0A3E90081762_DataLabsVisualStoriesSerpElementItem"
},
"propertyName": "type"
},
"properties": {
"position": {
"description": "the alignment of the element in SERP
can take the following values:
left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"knowledge_graph_carousel_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphCarouselItemElementItem",
"knowledge_graph_description_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphDescriptionItemElementItem",
"knowledge_graph_expanded_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphExpandedItemElementItem",
"knowledge_graph_images_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphImagesItemElementItem",
"knowledge_graph_list_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphListItemElementItem",
"knowledge_graph_part_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphPartItemElementItem",
"knowledge_graph_row_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphRowItemElementItem",
"knowledge_graph_shopping_item": "#/components/schemas/Response0A3E90081762_DataforseoLabsKnowledgeGraphShoppingItemElementItem"
},
"propertyName": "type"
},
"properties": {
"position": {
"description": "the alignment of the element in SERP
can take the following values:
left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseGeminiLlmScraperElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"gemini_images": "#/components/schemas/Response0A3E90081762_GeminiImagesElementItem",
"gemini_table": "#/components/schemas/Response0A3E90081762_GeminiTableElementItem",
"gemini_text": "#/components/schemas/Response0A3E90081762_GeminiTextElementItem"
},
"propertyName": "type"
},
"properties": {
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseKeywordDataDataforseoTrendsItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"dataforseo_trends_graph": "#/components/schemas/Response0A3E90081762_DataforseoTrendsDataforseoTrendsGraphElementItem",
"demography": "#/components/schemas/Response0A3E90081762_DataforseoTrendsDemographyElementItem",
"subregion_interests": "#/components/schemas/Response0A3E90081762_DataforseoTrendsSubregionInterestsElementItem"
},
"propertyName": "type"
},
"properties": {
"keywords": {
"description": "keywords in a POST array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element
can take the following values: 1, 2, 3, 4, etc.",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseKeywordDataGoogleTrendsItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"google_trends_graph": "#/components/schemas/Response0A3E90081762_GoogleTrendsGoogleTrendsGraphElementItem",
"google_trends_map": "#/components/schemas/Response0A3E90081762_GoogleTrendsGoogleTrendsMapElementItem",
"google_trends_queries_list": "#/components/schemas/Response0A3E90081762_GoogleTrendsGoogleTrendsQueriesListElementItem",
"google_trends_topics_list": "#/components/schemas/Response0A3E90081762_GoogleTrendsGoogleTrendsTopicsListElementItem"
},
"propertyName": "type"
},
"properties": {
"keywords": {
"description": "relevant keywords
the data included in the google_trends_graph element is based on the keywords listed in this array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element in Google Trends
can take the following values: 1, 2, 3, 4, etc.",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the element in Google Trends",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseLocalBusinessLink": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"menu": "#/components/schemas/Response0A3E90081762_LocalBusinessMenuLink",
"order": "#/components/schemas/Response0A3E90081762_LocalBusinessOrderLink",
"reservation": "#/components/schemas/Response0A3E90081762_LocalBusinessReservationLink"
},
"propertyName": "type"
},
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseMerchantAmazonElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"amazon_paid": "#/components/schemas/Response0A3E90081762_MerchantAmazonPaidSerpElementItem",
"amazon_serp": "#/components/schemas/Response0A3E90081762_MerchantAmazonSerpSerpElementItem",
"editorial_recommendations": "#/components/schemas/Response0A3E90081762_MerchantEditorialRecommendationsSerpElementItem",
"related_searches": "#/components/schemas/Response0A3E90081762_MerchantRelatedSearchesSerpElementItem",
"top_rated_from_our_brands": "#/components/schemas/Response0A3E90081762_MerchantTopRatedFromOurBrandsSerpElementItem"
},
"propertyName": "type"
},
"properties": {
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements found in Amazon SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseMerchantAmazonProductInformationElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"product_information_details_item": "#/components/schemas/Response0A3E90081762_ProductInformationProductInformationDetailsItem",
"product_information_extended_item": "#/components/schemas/Response0A3E90081762_ProductInformationProductInformationExtendedItem",
"product_information_text_item": "#/components/schemas/Response0A3E90081762_ProductInformationProductInformationTextItem"
},
"propertyName": "type"
},
"properties": {
"section_name": {
"description": "name of the section related to product information specified in the contents",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseMerchantAmazonProductInformationRowElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"product_information_image_row": "#/components/schemas/Response0A3E90081762_ProductInformationRowProductInformationImageRowElementItem",
"product_information_text_row": "#/components/schemas/Response0A3E90081762_ProductInformationRowProductInformationTextRowElementItem"
},
"propertyName": "type"
},
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseMerchantAmazonSellersElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"amazon_seller_item": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellerItemSerpElementItem",
"amazon_seller_main_item": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellerMainItemSerpElementItem"
},
"propertyName": "type"
},
"properties": {
"applicable_vouchers": {
"description": "array of objects containing information about applicable vouchers",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonApplicableVouchersItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"condition": {
"description": "product condition
condition of the product offered by the seller",
"type": [
"string",
"null"
]
},
"condition_description": {
"description": "product condition details
expanded details on the condition of the product offered by the seller",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonDeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"percentage_discount": {
"description": "value of the percentage discount",
"type": [
"number",
"null"
]
},
"position": {
"description": "alignment of the element in SERP
possible values:left, right",
"type": [
"string",
"null"
]
},
"price": {
"description": "product pricing details
if there are no details, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements found in Amazon Sellers SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "seller rating details
seller popularity rate based on customer reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"seller_name": {
"description": "business name of the seller",
"type": [
"string",
"null"
]
},
"seller_url": {
"description": "url forwarding to the seller's page on Amazon",
"type": [
"string",
"null"
]
},
"ships_from": {
"description": "sender company name",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseMerchantGoogleShoppingProductsElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"google_shopping_carousel": "#/components/schemas/Response0A3E90081762_GoogleShoppingCarouselElementItem",
"google_shopping_paid": "#/components/schemas/Response0A3E90081762_GoogleShoppingPaidElementItem",
"google_shopping_serp": "#/components/schemas/Response0A3E90081762_GoogleShoppingSerpElementItem",
"google_shopping_sponsored_carousel": "#/components/schemas/Response0A3E90081762_GoogleShoppingSponsoredCarouselElementItem",
"related_searches": "#/components/schemas/Response0A3E90081762_RelatedSearchesElementItem"
},
"propertyName": "type"
},
"properties": {
"position": {
"description": "alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements found in Google Shopping SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseMerchantGoogleShoppingSellersElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"buy_on_google": "#/components/schemas/Response0A3E90081762_GoogleShoppingSellersBuyOnGoogleElementItem",
"shops_list": "#/components/schemas/Response0A3E90081762_GoogleShoppingSellersShopsListElementItem"
},
"propertyName": "type"
},
"properties": {
"base_price": {
"description": "product price without tax and shipping",
"type": [
"number",
"null"
]
},
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"details": {
"description": "details and special offers
if there are no details, the value will be null",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the element in Google Shopping SERP
possible values:left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements found in Google Shopping SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"seller_name": {
"description": "name of the seller
the name of the company that placed a corresponding product on Google Shopping",
"type": [
"string",
"null"
]
},
"shipping_price": {
"description": "product shipping price",
"type": [
"number",
"null"
]
},
"shop_ad_aclk": {
"description": "unique ad click referral parameter
using this parameter you can get a URL of the advertisement in Google Shopping Sellers Ad URL",
"type": [
"string",
"null"
]
},
"tax": {
"description": "the amount of tax
tax is specified as the actual amount of money, not as the percentage",
"type": [
"number",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"total_price": {
"description": "product price including tax and shipping",
"format": "int64",
"type": [
"number",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "Google Shopping URL forwarding to the product page on the seller’s website
if you want to obtain a URL of the advertisement forwarding to the product page on the seller's website, please refer to the Google Shopping Sellers Ad URL endpoint",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseOnPageLinkItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"alternate": "#/components/schemas/Response0A3E90081762_OnPageAlternateLinkItem",
"anchor": "#/components/schemas/Response0A3E90081762_OnPageAnchorLinkItem",
"canonical": "#/components/schemas/Response0A3E90081762_OnPageCanonicalLinkItem",
"image": "#/components/schemas/Response0A3E90081762_OnPageImageLinkItem",
"link": "#/components/schemas/Response0A3E90081762_OnPageLinkLinkItem",
"meta": "#/components/schemas/Response0A3E90081762_OnPageMetaLinkItem",
"redirect": "#/components/schemas/Response0A3E90081762_OnPageRedirectLinkItem"
},
"propertyName": "type"
},
"properties": {
"direction": {
"description": "direction of the link
possible values: internal, external",
"type": [
"string",
"null"
]
},
"dofollow": {
"description": "indicates whether the link is dofollow
if the value is true, the link doesn't have a rel=\"nofollow\" attribute",
"type": [
"boolean",
"null"
]
},
"domain_from": {
"description": "referring domain
the link was found on this domain",
"type": [
"string",
"null"
]
},
"domain_to": {
"description": "referenced domain
the link is pointing to this domain",
"type": [
"string",
"null"
]
},
"is_broken": {
"description": "link is broken
indicates whether a link is directing to a broken page or resource",
"type": [
"boolean",
"null"
]
},
"is_link_relation_conflict": {
"description": "indicates that the link may have a conflict with another link
if true, at least one link pointing to link_to has a rel=\"nofollow\" attribute and at least one is dofollow",
"type": [
"boolean",
"null"
]
},
"link_from": {
"description": "referring page
absolute URL of the page on which the link was found",
"type": [
"string",
"null"
]
},
"link_to": {
"description": "referenced page
absolute URL of the page to which the link is pointing",
"type": [
"string",
"null"
]
},
"page_from": {
"description": "referring page
relative URL of the page on which the link was found",
"type": [
"string",
"null"
]
},
"page_from_scheme": {
"description": "url scheme of the referring page",
"type": [
"string",
"null"
]
},
"page_to": {
"description": "referenced page
relative URL of the page to which the link is pointing",
"type": [
"string",
"null"
]
},
"page_to_scheme": {
"description": "url scheme of the referenced page",
"type": [
"string",
"null"
]
},
"page_to_status_code": {
"description": "status code of the referenced page
status code of the page to which the link is pointing",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseOnPageResourceItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"broken": "#/components/schemas/Response0A3E90081762_OnPageBrokenResourceItem",
"html": "#/components/schemas/Response0A3E90081762_OnPageHtmlResourceItem",
"image": "#/components/schemas/Response0A3E90081762_OnPageImageResourceItem",
"redirect": "#/components/schemas/Response0A3E90081762_OnPageRedirectResourceItem",
"script": "#/components/schemas/Response0A3E90081762_OnPageScriptResourceItem",
"stylesheet": "#/components/schemas/Response0A3E90081762_OnPageStylesheetResourceItem"
},
"propertyName": "resource_type"
},
"properties": {
"cache_control": {
"description": "缓存说明",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CacheControl"
}
],
"type": [
"object",
"null"
]
},
"checks": {
"additionalProperties": {
"type": [
"boolean",
"null"
]
},
"description": "website checkson-page check-ups related to the page",
"type": [
"object",
"null"
]
},
"content_encoding": {
"description": "编码类型",
"type": [
"string",
"null"
]
},
"encoded_size": {
"description": "page size after encodingindicates the size of the encoded page measured in bytes",
"type": [
"integer",
"null"
]
},
"fetch_time": {
"description": "date and time when a resource was fetchedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"last_modified": {
"description": "contains data on changes related to the resourceif there is no data, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LastModified"
}
],
"type": [
"object",
"null"
]
},
"location": {
"description": "location headerindicates the URL to redirect a page to",
"type": [
"string",
"null"
]
},
"media_type": {
"description": "用于显示页面的媒体类型",
"type": [
"string",
"null"
]
},
"resource_errors": {
"description": "资源错误和警告",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourceIssueInfo"
}
],
"type": [
"object",
"null"
]
},
"resource_type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"server": {
"description": "服务器版本",
"type": [
"string",
"null"
]
},
"size": {
"description": "resource sizeindicates the size of a given page measured in bytes",
"type": [
"integer",
"null"
]
},
"status_code": {
"description": "general status codeyou can find the full list of the response codes hereNote: we strongly recommend designing a necessary system for handling related exceptional or error conditions",
"type": [
"integer",
"null"
]
},
"total_transfer_size": {
"description": "compressed page sizeindicates the compressed size of a given page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"url": {
"description": "页面 URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseResponseInfo": {
"properties": {
"cost": {
"description": "任务总成本（美元）",
"format": "double",
"type": [
"number",
"null"
]
},
"status_code": {
"description": "general status code\nyou can find the full list of the response codes here",
"type": [
"integer",
"null"
]
},
"status_message": {
"description": "general informational message\nyou can find the full list of general informational messages here",
"type": [
"string",
"null"
]
},
"tasks_count": {
"description": "tasks 数组中的任务数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"tasks_error": {
"description": "返回错误的 tasks 数组中的任务数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"time": {
"description": "total execution time, seconds",
"type": [
"string",
"null"
]
},
"version": {
"description": "API 的当前版本",
"type": [
"string",
"null"
]
}
}
},
"Response0A3E90081762_BaseResponseTaskInfo": {
"properties": {
"cost": {
"description": "任务总成本（美元）",
"format": "double",
"type": [
"number",
"null"
]
},
"data": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "包含您在 POST 请求中指定的相同参数",
"type": [
"object",
"null"
]
},
"id": {
"description": "task identifier\nunique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"path": {
"description": "URL 路径",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"result_count": {
"description": "结果数组中的元素数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"status_code": {
"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",
"type": [
"integer",
"null"
]
},
"status_message": {
"description": "informational message of the task\nyou can find the full list of general informational messages here",
"type": [
"string",
"null"
]
},
"time": {
"description": "执行时间（秒）",
"type": [
"string",
"null"
]
}
}
},
"Response0A3E90081762_BaseSerpApiAdsAdvertiserElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"ads_advertiser": "#/components/schemas/Response0A3E90081762_SerpApiAdsAdvertiserElementItem",
"ads_domain": "#/components/schemas/Response0A3E90081762_SerpApiAdsDomainElementItem",
"ads_multi_account_advertiser": "#/components/schemas/Response0A3E90081762_SerpApiAdsMultiAccountAdvertiserElementItem"
},
"propertyName": "type"
},
"properties": {
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"ai_overview_element": "#/components/schemas/Response0A3E90081762_SerpApiAiModeAiOverviewElementItem",
"ai_overview_expanded_element": "#/components/schemas/Response0A3E90081762_SerpApiAiModeAiOverviewExpandedElementItem",
"ai_overview_paid": "#/components/schemas/Response0A3E90081762_SerpApiAiModeAiOverviewPaidItem",
"ai_overview_shopping": "#/components/schemas/Response0A3E90081762_SerpApiAiModeAiOverviewShoppingItem",
"ai_overview_table_element": "#/components/schemas/Response0A3E90081762_SerpApiAiModeAiOverviewTableElementItem",
"ai_overview_video_element": "#/components/schemas/Response0A3E90081762_SerpApiAiModeAiOverviewVideoElementItem"
},
"propertyName": "type"
},
"properties": {
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiAiOverviewElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"ai_overview_element": "#/components/schemas/Response0A3E90081762_SerpApiAiOverviewElementItem",
"ai_overview_expanded_element": "#/components/schemas/Response0A3E90081762_SerpApiAiOverviewExpandedElementItem",
"ai_overview_table_element": "#/components/schemas/Response0A3E90081762_SerpApiAiOverviewTableElementItem",
"ai_overview_video_element": "#/components/schemas/Response0A3E90081762_SerpApiAiOverviewVideoElementItem"
},
"propertyName": "type"
},
"properties": {
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiBingAiOverviewElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"ai_overview_element": "#/components/schemas/Response0A3E90081762_SerpApiBingAiOverviewElementItem",
"ai_overview_images_element": "#/components/schemas/Response0A3E90081762_SerpApiBingAiOverviewImagesElementItem",
"ai_overview_organic_element": "#/components/schemas/Response0A3E90081762_SerpApiBingAiOverviewOrganicElementItem",
"ai_overview_video_element": "#/components/schemas/Response0A3E90081762_SerpApiBingAiOverviewVideoElementItem",
"ai_overview_videos_element": "#/components/schemas/Response0A3E90081762_SerpApiBingAiOverviewVideosElementItem"
},
"propertyName": "type"
},
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"ai_overview": "#/components/schemas/Response0A3E90081762_AiOverviewSerpElementItem",
"answer_box": "#/components/schemas/Response0A3E90081762_AnswerBoxSerpElementItem",
"app": "#/components/schemas/Response0A3E90081762_AppSerpElementItem",
"carousel": "#/components/schemas/Response0A3E90081762_CarouselSerpElementItem",
"commercial_units": "#/components/schemas/Response0A3E90081762_CommercialUnitsSerpElementItem",
"compare_sites": "#/components/schemas/Response0A3E90081762_CompareSitesSerpElementItem",
"courses": "#/components/schemas/Response0A3E90081762_CoursesSerpElementItem",
"currency_box": "#/components/schemas/Response0A3E90081762_CurrencyBoxSerpElementItem",
"dictionary": "#/components/schemas/Response0A3E90081762_DictionarySerpElementItem",
"discussions_and_forums": "#/components/schemas/Response0A3E90081762_DiscussionsAndForumsSerpElementItem",
"events": "#/components/schemas/Response0A3E90081762_EventsSerpElementItem",
"explore_brands": "#/components/schemas/Response0A3E90081762_ExploreBrandsSerpElementItem",
"featured_snippet": "#/components/schemas/Response0A3E90081762_FeaturedSnippetSerpElementItem",
"find_results_on": "#/components/schemas/Response0A3E90081762_FindResultsOnSerpElementItem",
"found_on_web": "#/components/schemas/Response0A3E90081762_FoundOnWebSerpElementItem",
"google_flights": "#/components/schemas/Response0A3E90081762_GoogleFlightsSerpElementItem",
"google_hotels": "#/components/schemas/Response0A3E90081762_GoogleHotelsSerpElementItem",
"google_posts": "#/components/schemas/Response0A3E90081762_GooglePostsSerpElementItem",
"google_reviews": "#/components/schemas/Response0A3E90081762_GoogleReviewsSerpElementItem",
"hotels_pack": "#/components/schemas/Response0A3E90081762_HotelsPackSerpElementItem",
"images": "#/components/schemas/Response0A3E90081762_ImagesSerpElementItem",
"jobs": "#/components/schemas/Response0A3E90081762_JobsSerpElementItem",
"knowledge_graph": "#/components/schemas/Response0A3E90081762_KnowledgeGraphSerpElementItem",
"knowledge_graph_ai_overview_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphAiOverviewItemSerpElementItem",
"knowledge_graph_carousel_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphCarouselItemSerpElementItem",
"knowledge_graph_description_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphDescriptionItemSerpElementItem",
"knowledge_graph_expanded_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphExpandedItemSerpElementItem",
"knowledge_graph_hotels_booking_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphHotelsBookingItemSerpElementItem",
"knowledge_graph_images_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphImagesItemSerpElementItem",
"knowledge_graph_list_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphListItemSerpElementItem",
"knowledge_graph_part_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphPartItemSerpElementItem",
"knowledge_graph_row_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphRowItemSerpElementItem",
"knowledge_graph_shopping_item": "#/components/schemas/Response0A3E90081762_KnowledgeGraphShoppingItemSerpElementItem",
"local_pack": "#/components/schemas/Response0A3E90081762_LocalPackSerpElementItem",
"local_services": "#/components/schemas/Response0A3E90081762_LocalServicesSerpElementItem",
"map": "#/components/schemas/Response0A3E90081762_MapSerpElementItem",
"math_solver": "#/components/schemas/Response0A3E90081762_MathSolverSerpElementItem",
"mention_carousel": "#/components/schemas/Response0A3E90081762_MentionCarouselSerpElementItem",
"multi_carousel": "#/components/schemas/Response0A3E90081762_MultiCarouselSerpElementItem",
"organic": "#/components/schemas/Response0A3E90081762_OrganicSerpElementItem",
"paid": "#/components/schemas/Response0A3E90081762_PaidSerpElementItem",
"people_also_ask": "#/components/schemas/Response0A3E90081762_PeopleAlsoAskSerpElementItem",
"people_also_search": "#/components/schemas/Response0A3E90081762_PeopleAlsoSearchSerpElementItem",
"perspectives": "#/components/schemas/Response0A3E90081762_PerspectivesSerpElementItem",
"podcasts": "#/components/schemas/Response0A3E90081762_PodcastsSerpElementItem",
"popular_products": "#/components/schemas/Response0A3E90081762_PopularProductsSerpElementItem",
"product_considerations": "#/components/schemas/Response0A3E90081762_ProductConsiderationsSerpElementItem",
"questions_and_answers": "#/components/schemas/Response0A3E90081762_QuestionsAndAnswersSerpElementItem",
"recipes": "#/components/schemas/Response0A3E90081762_RecipesSerpElementItem",
"refine_products": "#/components/schemas/Response0A3E90081762_RefineProductsSerpElementItem",
"related_searches": "#/components/schemas/Response0A3E90081762_RelatedSearchesSerpElementItem",
"scholarly_articles": "#/components/schemas/Response0A3E90081762_ScholarlyArticlesSerpElementItem",
"shopping": "#/components/schemas/Response0A3E90081762_ShoppingSerpElementItem",
"short_videos": "#/components/schemas/Response0A3E90081762_ShortVideosSerpElementItem",
"stocks_box": "#/components/schemas/Response0A3E90081762_StocksBoxSerpElementItem",
"third_party_reviews": "#/components/schemas/Response0A3E90081762_ThirdPartyReviewsSerpElementItem",
"top_sights": "#/components/schemas/Response0A3E90081762_TopSightsSerpElementItem",
"top_stories": "#/components/schemas/Response0A3E90081762_TopStoriesSerpElementItem",
"twitter": "#/components/schemas/Response0A3E90081762_TwitterSerpElementItem",
"video": "#/components/schemas/Response0A3E90081762_VideoSerpElementItem",
"visual_stories": "#/components/schemas/Response0A3E90081762_VisualStoriesSerpElementItem"
},
"propertyName": "type"
},
"properties": {
"page": {
"description": "search results page number
indicates the number of the SERP page on which the element is located",
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result's snippet in SERP
equals null if calculate_rectangles in the POST request is not set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"google_finance_about": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceAboutElementItem",
"google_finance_asset_pair_element": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceAssetPairElementElementItem",
"google_finance_compare_to": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceCompareToElementItem",
"google_finance_details": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceDetailsElementItem",
"google_finance_earnings_calendar": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceEarningsCalendarElementItem",
"google_finance_explore_market_trends": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceExploreMarketTrendsElementItem",
"google_finance_financial": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceFinancialElementItem",
"google_finance_futures_chain": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceFuturesChainElementItem",
"google_finance_hero_groups": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceHeroGroupsElementItem",
"google_finance_interested": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceInterestedElementItem",
"google_finance_market_index_element": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceMarketIndexElementElementItem",
"google_finance_market_instrument_element": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceMarketInstrumentElementElementItem",
"google_finance_market_trends": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceMarketTrendsElementItem",
"google_finance_most_followed": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceMostFollowedElementItem",
"google_finance_news": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceNewsElementItem",
"google_finance_people_also_search": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinancePeopleAlsoSearchElementItem",
"google_finance_quote": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceQuoteElementItem"
},
"propertyName": "type"
},
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiGoogleFinanceTickerSearchElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"google_finance_asset_pair": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceAssetPairElementItem",
"google_finance_market_index": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceMarketIndexElementItem",
"google_finance_market_instrument": "#/components/schemas/Response0A3E90081762_SerpApiGoogleFinanceMarketInstrumentElementItem"
},
"propertyName": "type"
},
"properties": {
"displayed_name": {
"description": "name of the market index as displayed on Google Finance
example: CAC 40",
"type": [
"string",
"null"
]
},
"identifier": {
"description": "identifier of the element
full identifier of the element that consists from ticker and market_identifier
example: PX1:INDEXDB",
"type": [
"string",
"null"
]
},
"location": {
"description": "location of the market index
example: Europe/Paris",
"type": [
"string",
"null"
]
},
"percentage_delta": {
"description": "percentage of change in value of the market index",
"type": [
"number",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"trend": {
"description": "growth trend of the market index
possible values: up, down, stable",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the page of the market index on Google Finance",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiGoogleImagesElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"carousel": "#/components/schemas/Response0A3E90081762_SerpApiGoogleImagesCarouselElementItem",
"images_search": "#/components/schemas/Response0A3E90081762_SerpApiGoogleImagesImagesSearchElementItem",
"related_searches": "#/components/schemas/Response0A3E90081762_SerpApiGoogleImagesRelatedSearchesElementItem"
},
"propertyName": "type"
},
"properties": {
"rank_absolute": {
"description": " absolute rank in SERP for the target domain
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiGoogleMapsElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"maps_paid_item": "#/components/schemas/Response0A3E90081762_SerpApiMapsPaidItemElementItem",
"maps_search": "#/components/schemas/Response0A3E90081762_SerpApiMapsSearchElementItem"
},
"propertyName": "type"
},
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"rating_distribution": {
"additionalProperties": {
"format": "Int64",
"type": [
"integer",
"null"
]
},
"description": "the distribution of ratings of the business entity
the object displays the number of 1-star to 5-star ratings, as reviewed by users",
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiGoogleNewsElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"news_search": "#/components/schemas/Response0A3E90081762_SerpApiGoogleNewsNewsSearchElementItem",
"top_stories": "#/components/schemas/Response0A3E90081762_SerpApiGoogleNewsTopStoriesElementItem"
},
"propertyName": "type"
},
"properties": {
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result's snippet in SERP
equals null if calculate_rectangles in the POST request is not set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiGoogleSearchByImagesElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"images": "#/components/schemas/Response0A3E90081762_SerpApiGoogleSearchByImagesImagesElementItem",
"organic": "#/components/schemas/Response0A3E90081762_SerpApiGoogleSearchByImagesOrganicElementItem"
},
"propertyName": "type"
},
"properties": {
"page": {
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:
left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result's snippet in SERP
equals null if calculate_rectangles in the POST request is not set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"knowledge_graph_ai_overview_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphAiOverviewItemElementItem",
"knowledge_graph_carousel_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphCarouselItemElementItem",
"knowledge_graph_description_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphDescriptionItemElementItem",
"knowledge_graph_expanded_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphExpandedItemElementItem",
"knowledge_graph_hotels_booking_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphHotelsBookingItemElementItem",
"knowledge_graph_images_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphImagesItemElementItem",
"knowledge_graph_list_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphListItemElementItem",
"knowledge_graph_part_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphPartItemElementItem",
"knowledge_graph_row_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphRowItemElementItem",
"knowledge_graph_shopping_item": "#/components/schemas/Response0A3E90081762_SerpApiKnowledgeGraphShoppingItemElementItem"
},
"propertyName": "type"
},
"properties": {
"page": {
"description": "search results page number
indicates the number of the SERP page on which the element is located",
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result's snippet in SERP
equals null if calculate_rectangles in the POST request is not set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiPeopleAlsoAskExpandedElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"people_also_ask_ai_overview_expanded_element": "#/components/schemas/Response0A3E90081762_SerpApiPeopleAlsoAskAiOverviewExpandedElementItem",
"people_also_ask_expanded_element": "#/components/schemas/Response0A3E90081762_SerpApiPeopleAlsoAskExpandedElementItem"
},
"propertyName": "type"
},
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiProductConsiderationExpandedElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"product_considerations_ai_overview_expanded_element": "#/components/schemas/Response0A3E90081762_SerpApiProductConsiderationsAiOverviewExpandedElementItem",
"product_considerations_expanded_element": "#/components/schemas/Response0A3E90081762_SerpApiProductConsiderationsExpandedElementItem"
},
"propertyName": "type"
},
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BaseSerpApiYoutubeOrganicElementItem": {
"additionalProperties": false,
"discriminator": {
"mapping": {
"youtube_channel": "#/components/schemas/Response0A3E90081762_SerpApiYoutubeChannelElementItem",
"youtube_playlist": "#/components/schemas/Response0A3E90081762_SerpApiYoutubePlaylistElementItem",
"youtube_video": "#/components/schemas/Response0A3E90081762_SerpApiYoutubeVideoElementItem",
"youtube_video_paid": "#/components/schemas/Response0A3E90081762_SerpApiYoutubeVideoPaidElementItem"
},
"propertyName": "type"
},
"properties": {
"block_name": {
"description": "name of the block in SERP
example:
\"People also watched\"
",
"type": [
"string",
"null"
]
},
"block_rank": {
"description": "block rank in SERP
position among all the blocks in SERP",
"type": [
"integer",
"null"
]
},
"channel_id": {
"description": "ID of the channel",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP for the target domain
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the channel",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BingAiOverviewSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiBingAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format",
"type": [
"string",
"null"
]
},
"references": {
"description": "additional references relevant to the item
includes references to webpages that may have been used to generate the ai_overview",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingAnswerBoxSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"links": {
"description": "links featured in the organic result",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "text
if there is none, equals null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingCarouselSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpApiCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingEventsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_EventsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingFeaturedSnippetSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"breadcrumb": {
"description": "breadcrumb of the ad element in SERP",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the ad element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the ad element in SERP",
"type": [
"string",
"null"
]
},
"featured_title": {
"description": "the title of the featured snippets source page",
"type": [
"string",
"null"
]
},
"images": {
"description": "images of the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"table": {
"description": "results table
if there are none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the ad element in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL of the ad element in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingHotelsPackSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"date_from": {
"description": "starting date of stay
in the format “year-month-date”
example:
2019-11-15",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of stay
in the format “year-month-date”
example:
2019-11-17",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelsPackElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingImagesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"related_image_searches": {
"deprecated": true,
"description": "contains keywords and images related to the specified search term
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedImageSearchesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingJobsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_JobsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingLocalPackSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"booking_url": {
"type": [
"string",
"null"
]
},
"cid": {
"description": "bing-defined client id
unique id of a local establishment",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where the video is hosted",
"type": [
"string",
"null"
]
},
"is_claimed": {
"description": "business listing is claimed
if true, the business listing is claimed by the owner or representative",
"type": [
"boolean",
"null"
]
},
"is_paid": {
"description": "indicates whether the element is an ad",
"type": [
"boolean",
"null"
]
},
"phone": {
"description": "phone number",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingMapSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingOrganicSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"about_this_result": {
"deprecated": true,
"description": "contains information from the 'About this result' panel
note: about_this_result feature is not available in Bing search engine, that’s why it always equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AboutThisResultElement"
}
],
"type": [
"object",
"null"
]
},
"amp_version": {
"description": "Accelerated Mobile Pages
indicates whether an item has the Accelerated Mobile Page (AMP) version",
"type": [
"boolean",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"cache_url": {
"description": "cached version of the page",
"type": [
"string",
"null"
]
},
"checks": {
"items": {
"description": "indicates whether the element contains a video",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"extended_people_also_search": {
"description": "extension of the organic element
extension of the organic result containing related search queries
Note: extension appears in SERP upon clicking on the result and then bouncing back to search results",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"extended_snippet": {
"description": "includes additional information appended after the result description in SERP",
"type": [
"string",
"null"
]
},
"faq": {
"deprecated": true,
"description": "frequently asked questions
questions and answers extension shown below some search results
if there are none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FaqBox"
}
],
"type": [
"object",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images": {
"description": "images of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_featured_snippet": {
"description": "indicates whether the element is a featured_snippet",
"type": [
"boolean",
"null"
]
},
"is_image": {
"description": "indicates whether the element contains an image",
"type": [
"boolean",
"null"
]
},
"is_malicious": {
"description": "indicates whether the element is marked as malicious",
"type": [
"boolean",
"null"
]
},
"is_video": {
"description": "indicates whether the element contains a video",
"type": [
"boolean",
"null"
]
},
"is_web_story": {
"description": "indicates whether the element is marked as a web story",
"type": [
"boolean",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"pre_snippet": {
"description": "includes additional information appended before the result description in SERP",
"type": [
"string",
"null"
]
},
"price": {
"description": "pricing details
contains the pricing details of the product or service featured in the result",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"related_result": {
"description": "related result from the same domain
related result from the same domain appears as a part of the main result snippet;
note: related_result feature is not available in Bing search engine, that’s why it always equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedResult"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"related_search_url": {
"description": "URL to a similar search
URL to a new search for the same keyword(s) on related sites",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the results element in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "name of the source website",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingPaidSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"breadcrumb": {
"description": "breadcrumb of the ad element in SERP",
"type": [
"string",
"null"
]
},
"checks": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the ad element in SERP",
"type": [
"string",
"null"
]
},
"description_rows": {
"description": "extended description
if there is none, equals null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"domain": {
"description": "domain of the ad element in SERP",
"type": [
"string",
"null"
]
},
"extra": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "additional information about the result",
"type": [
"object",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images": {
"description": "images of the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_image": {
"description": "indicates whether the element contains an image",
"type": [
"boolean",
"null"
]
},
"is_video": {
"description": "indicates whether the element contains a video",
"type": [
"boolean",
"null"
]
},
"links": {
"description": "links featured in the organic result",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AdLinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"price": {
"description": "price of booking a place for the specified dates of stay",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the ad element in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL of the ad element in SERP",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "website name in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingPeopleAlsoAskSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PeopleAlsoAskElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingPeopleAlsoSearchSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingQuestionsAndAnswersSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_QuestionsAndAnswersElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingRecipesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RecipesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingRelatedSearchesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items in SERP",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingShoppingSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ShoppingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingTopStoriesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopStoriesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BingVideoSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_VideoElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BrandEntities": {
"properties": {
"category": {
"description": "category of the brand",
"type": [
"string",
"null"
]
},
"rank": {
"description": "rank in the results",
"type": [
"integer",
"null"
]
},
"title": {
"description": "source title",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BulkMetricsBundleInfo": {
"properties": {
"featured_snippet": {
"description": "traffic data from the featured snippet results in Google SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BulkMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"local_pack": {
"description": "traffic data from the local pack results in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BulkMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"organic": {
"description": "traffic data from organic search",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BulkMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"paid": {
"description": "traffic data from paid search",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BulkMetricsInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BulkMetricsInfo": {
"properties": {
"count": {
"description": "total count of organic SERPs that contain the domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"etv": {
"description": "estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataAttributesInfo": {
"properties": {
"available_attributes": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "available attributes
indicates attributes a business entity can offer",
"type": [
"object",
"null"
]
},
"unavailable_attributes": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "unavailable attributes
indicates attributes a business entity cannot offer",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataBusinessListingsSearchLiveItem": {
"properties": {
"additional_categories": {
"description": "additional business categories
additional Google My Business categories that describe the services provided by the business entity in more detail",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"address": {
"description": "address of the business entity",
"type": [
"string",
"null"
]
},
"address_info": {
"description": "object containing address components of the business entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AddressInfo"
}
],
"type": [
"object",
"null"
]
},
"attributes": {
"description": "service details in a form of user-reviewed checks;
service details of a business entity displayed in a form of checks and based on user feedback and business category",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataAttributesInfo"
}
],
"type": [
"object",
"null"
]
},
"category": {
"description": "business category
Google My Business general category that best describes the services provided by the business entity",
"type": [
"string",
"null"
]
},
"category_ids": {
"description": "global category IDs
universal category IDs that do not change based on the selected country",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"contact_info": {
"description": "available contacts of the business
list of contacts to interact with the business",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataContactInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the element in SERP
the description of the business entity for which the results are collected",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the business entity",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the business listing element for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2023-03-11 10:04:11 +00:00",
"type": [
"string",
"null"
]
},
"hotel_rating": {
"description": "hotel class rating
class ratings range between 1-5 stars, learn more
if there is no hotel class rating information, the value will be null",
"type": [
"integer",
"null"
]
},
"is_claimed": {
"description": "shows whether the entity is verified by its owner on Google Maps",
"type": [
"boolean",
"null"
]
},
"last_updated_time": {
"description": "date and time when the data was last updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2023-01-26 09:03:15 +00:00",
"type": [
"string",
"null"
]
},
"latitude": {
"description": "latitude coordinate of the local establishments in google maps
example:\"latitude\": 51.584091",
"type": [
"number",
"null"
]
},
"local_business_links": {
"description": "available interactions with the business
list of options to interact with the business directly from search results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseLocalBusinessLink"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"logo": {
"description": "URL of the logo featured in Google My Business profile",
"type": [
"string",
"null"
]
},
"longitude": {
"description": "longitude coordinate of the local establishment in google maps
example:\"longitude\": -0.31365919999999997",
"type": [
"number",
"null"
]
},
"main_image": {
"description": "URL of the main image featured in Google My Business profile",
"type": [
"string",
"null"
]
},
"original_title": {
"description": "original title of the element
original title not translated by Google",
"type": [
"string",
"null"
]
},
"people_also_search": {
"description": "related business entities",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PeopleAlsoSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"phone": {
"description": "phone number of the business entity",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "unique place identifier
place id of the local establishment featured in the element
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"place_topics": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "keywords mentioned in customer reviews
contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword
example:
\"place_topics\": {
\"egg roll\": 48,
\"birthday\": 33
}
information related to busy hours of the business entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PopularTimes"
}
],
"type": [
"object",
"null"
]
},
"price_level": {
"description": "property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"properties": {
"rating_max": {
"description": "rating_type 的最大值",
"format": "double",
"type": [
"number",
"null"
]
},
"rating_type": {
"description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax",
"type": [
"string",
"null"
]
},
"value": {
"description": "评级值",
"format": "double",
"type": [
"number",
"null"
]
},
"votes_count": {
"description": "反馈数量",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"rating_distribution": {
"additionalProperties": {
"format": "Int64",
"type": [
"integer",
"null"
]
},
"description": "the distribution of ratings of the business entity
the object displays the number of 1-star to 5-star ratings, as reviewed by users",
"type": [
"object",
"null"
]
},
"services": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataServiceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"snippet": {
"description": "additional information on the business entity",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in SERP
the name of the business entity for which the results are collected",
"type": [
"string",
"null"
]
},
"total_photos": {
"description": "total count of images featured in Google My Business profile",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "absolute url of the business entity",
"type": [
"string",
"null"
]
},
"work_time": {
"description": "work time details
information related to operational hours of the business entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessWorkHoursInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataBusinessListingsSearchLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataBusinessListingsSearchLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataBusinessListingsSearchLiveResultInfo": {
"properties": {
"count": {
"description": "item types
the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"items": {
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: business_listing",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataBusinessListingsSearchLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"offset": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset_token": {
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataBusinessListingsSearchLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataBusinessListingsSearchLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataContactInfo": {
"properties": {
"source": {
"description": "data source",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"value": {
"description": "the value of the rating",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the 'reviews' element in SERP
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"items": {
"description": "found reviews
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleExtendedReviewsSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of reviews items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"place_id": {
"description": "unique identifier of a business location assigned by Google
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"rating": {
"description": "rating of the corresponding local establishment
popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"sub_title": {
"description": "subtitle of the 'reviews' element in SERP
additional information (e.g., address) on the 'reviews' element for which the reviews are collected",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the 'reviews' element in SERP
the name of the local establishment for which the reviews are collected",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: google",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleExtendedReviewsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoLiveAdvancedResultInfo": {
"properties": {
"about": {
"description": "information about the hotel",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelAboutInfo"
}
],
"type": [
"object",
"null"
]
},
"address": {
"description": "hotel address
physical address of the hotel",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"hotel_identifier": {
"description": "identifier received in a POST array
this field will contain the hotel_identifier parameter specified when setting a task;
example:CgoI-KWyzenM_MV3EAE",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location": {
"description": "information about the hotel location
information about the location where the hotel is located",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelLocationInfo"
}
],
"type": [
"object",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"overview_images": {
"description": "images displayed in the hotel overview
array containing URLs to images displayed in the hotel overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"phone": {
"description": "hotel phone number
contact phone number of the hotel",
"type": [
"string",
"null"
]
},
"prices": {
"description": "pricing details of the hotel entity
contains information about the hotel's prices",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelPriceInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews": {
"description": "hotel reviews by criteria
information about reviews of the hotel entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelReviewInfo"
}
],
"type": [
"object",
"null"
]
},
"stars": {
"description": "hotel class rating
class rating that ranges between 1-5 stars and displayed after review ratings in hotel summary",
"type": [
"integer",
"null"
]
},
"stars_description": {
"description": "hotel class rating
class rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary",
"type": [
"string",
"null"
]
},
"title": {
"description": "hotel title
the title of the hotel entity for which the results are collected",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "unique hotel identifier specified as \"hotel_id:$\"",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo": {
"properties": {
"about": {
"description": "information about the hotel",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelAboutInfo"
}
],
"type": [
"object",
"null"
]
},
"address": {
"description": "hotel address
physical address of the hotel",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"hotel_identifier": {
"description": "unique hotel identifier
this field will contain the hotel_identifier parameter;
example:CgoI-KWyzenM_MV3EAE",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location": {
"description": "information about the hotel location
information about the location where the hotel is located",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelLocationInfo"
}
],
"type": [
"object",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"overview_images": {
"description": "images displayed in the hotel overview
array containing URLs to images displayed in the hotel overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"phone": {
"description": "hotel phone number
contact phone number of the hotel",
"type": [
"string",
"null"
]
},
"prices": {
"description": "pricing details of the hotel entity
contains information about the hotel's prices",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelPriceInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews": {
"description": "hotel reviews by criteria
information about reviews of the hotel entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelReviewInfo"
}
],
"type": [
"object",
"null"
]
},
"stars": {
"description": "hotel class rating
class rating that ranges between 1-5 stars and displayed after review ratings in hotel summary",
"type": [
"integer",
"null"
]
},
"stars_description": {
"description": "hotel class rating
class rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary",
"type": [
"string",
"null"
]
},
"title": {
"description": "hotel title
the title of the hotel entity for which the results are collected",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: google",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelInfoTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelInfoTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesItem": {
"properties": {
"hotel_identifier": {
"description": "unique identifier of a hotel entity in Google search
example:CgoI-KWyzenM_MV3EAE",
"type": [
"string",
"null"
]
},
"is_paid": {
"description": "indicates a paid hotel listing
if true, related hotel_search_item is a paid ad
if false, related hotel_search_item is an organic hotel listing",
"type": [
"boolean",
"null"
]
},
"location": {
"description": "GPS coordinates of the hotel's location",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GpsCoordinatesLocationInfo"
}
],
"type": [
"object",
"null"
]
},
"overview_images": {
"description": "featured images for a hotel",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"prices": {
"description": "hotel price",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelPriceInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews": {
"description": "hotel reviews and rating information",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelReviewInfo"
}
],
"type": [
"object",
"null"
]
},
"stars": {
"description": "hotel class rating
class rating that ranges between 1-5 stars",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the hotel",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesLiveResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: hotel_search_item",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "item types
the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "array of items
note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "item types
the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character);
in order to obtain accurate search results, the location name is appended to the keyword automatically",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID \nformat",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: google",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleHotelSearchesTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleHotelSearchesTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessInfoLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoLiveResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "item types
types of search engine results encountered in the items array;
possible item types: google_business_info",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: google_business_info",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "item types
the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
this field will contain the cid parameter if you specified it in the keyword field when setting a task;
example:cid:2946633002421908862
learn more about the parameter in this help center article",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain as specified in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessInfoLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "item types
types of search engine results encountered in the items array;
possible item types: google_business_info",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "array of directory items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "item types
the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
this field will contain the cid parameter if you specified it in the keyword field when setting a task;
example:cid:2946633002421908862
learn more about the parameter in this help center article",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain as specified in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: google",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo": {
"properties": {
"business_updates_id": {
"description": "identifier of the business updates element in SERP",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment
learn more about the cid identifier in this help center article",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "item types
types of search engine results encountered in the items array;
possible item types: google_business_post",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: google_business_post",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessPost"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "item types
the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
this field will contain the cid parameter if you specified it in the keyword field when setting a task;
example:cid:2946633002421908862
learn more about the parameter in this help center article",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain as specified in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: google",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersLiveResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment;
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": " unique identifier of the SERP feature",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "item types
types of search engine results encountered in the items array;
possible item types: google_business_question_item",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "array of items
items within google_business_question_item",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessQuestionItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"items_without_answers": {
"description": "array of google business question items without answers",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessQuestionItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
this field will contain the cid parameter if you specified it in the keyword field when setting a task;
example:cid:2946633002421908862
learn more about the parameter in this help center article",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain as specified in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment;
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": " unique identifier of the SERP feature",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "item types
types of search engine results encountered in the items array;
possible item types: google_business_question_item",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": " array of items within google_business_question_item
contains answers to the google business questions;
the maximum number of answers returned for each question: 5
possible item types google_business_answer_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessQuestionItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"items_without_answers": {
"description": "array of google business question items without answers",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessQuestionItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
this field will contain the cid parameter if you specified it in the keyword field when setting a task;
example:cid:2946633002421908862
learn more about the parameter in this help center article",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain as specified in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: google",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleReviewsTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the 'reviews' element in SERP
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"items": {
"description": "found reviews
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleReviewsSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of reviews items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"place_id": {
"description": "unique identifier of a business location assigned by Google
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"rating": {
"description": "rating of the corresponding local establishment
popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"sub_title": {
"description": "subtitle of the 'reviews' element in SERP
additional information (e.g., address) on the 'reviews' element for which the reviews are collected",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the 'reviews' element in SERP
the name of the local establishment for which the reviews are collected",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleReviewsTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleReviewsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleReviewsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: google",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataGoogleReviewsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataGoogleReviewsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataServiceInfo": {
"properties": {
"category": {
"description": "business category
Google My Business general category that best describes the services provided by the business entity",
"type": [
"string",
"null"
]
},
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"snippet": {
"description": "additional information on the business entity",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in SERP
the name of the business entity for which the results are collected",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorReviewsTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found reviews
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TripadvisorReviewSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of reviews items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location": {
"description": "location of the local establishment
address of the local establishment for which the reviews are collected",
"type": [
"string",
"null"
]
},
"rating": {
"description": "rating of the corresponding local establishment
popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"rating_distribution": {
"additionalProperties": {
"format": "Int64",
"type": [
"integer",
"null"
]
},
"description": "rating distribution by votes
the distribution of votes across the rating in the range from 1 to 5",
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the 'reviews' element in SERP
the name of the local establishment for which the reviews are collected",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url_path": {
"description": "URL path received in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorReviewsTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorReviewsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorReviewsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: tripadvisor",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorReviewsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorReviewsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorSearchTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to Tripadvisor results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "item types encountered in the result
possible item types: tripadvisor_search_organic",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "Tripadvisor search listing results
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TripadvisorSearchOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
this field will contain the alias parameter if it was specified in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "the total number of results",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorSearchTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorSearchTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorSearchTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: tripadvisor",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTripadvisorSearchTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTripadvisorSearchTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotReviewsTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the business entity",
"type": [
"string",
"null"
]
},
"items": {
"description": "found reviews
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TrustpilotReviewSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"location": {
"description": "location of the business entity as specified on Trustpilot
address of the business entity for which the reviews are collected",
"type": [
"string",
"null"
]
},
"rating": {
"description": "rating of the corresponding business entity
popularity rate based on reviews and displayed in SERP",
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews",
"format": "int64",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the 'reviews' element on Trustpilot
the name of the business entity for which the reviews are collected",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotReviewsTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotReviewsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotReviewsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: trustpilot",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotReviewsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotReviewsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotSearchTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "found reviews
you can get more results by using the depth parameter when setting a task",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TrustpilotSearchOrganic"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of items in the results array
you can get more results by using the depth parameter when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotSearchTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotSearchTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotSearchTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task
can take the following values: trustpilot",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDataTrustpilotSearchTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataTrustpilotSearchTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_BusinessDataUserProfileInfo": {
"properties": {
"image_url": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"reviews_count": {
"description": "total number of reviews submitted by the reviewer",
"format": "int64",
"type": [
"integer",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessDirectoryInfo": {
"properties": {
"items": {
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: google_business_info",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MapsSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the element
domain of the online menu system",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_BusinessWorkHoursInfo": {
"properties": {
"work_hours": {
"description": "open hours
information about work hours of the local establishment",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_WorkHours"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CacheControl": {
"properties": {
"cachable": {
"description": "指示页面是否可缓存",
"type": [
"boolean",
"null"
]
},
"ttl": {
"description": "time to livethe amount of time the browser caches a resource",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CarouselSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpApiCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_Categories": {
"properties": {
"category": {
"description": "product category name",
"type": [
"string",
"null"
]
},
"url": {
"description": "product category URL
indicates the browse path on Amazon with the unique browse node ID (product category ID on Amazon)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ChannelSubscribersCount": {
"properties": {
"count": {
"description": "subscriber count",
"format": "int64",
"type": [
"integer",
"null"
]
},
"displayed_count": {
"description": "displayed subscriber count
subscriber count as displayed on YouTube",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ChatGptAdAdvertiser": {
"properties": {
"favicon_url": {
"description": "URL of the advertiser's favicon image",
"type": [
"string",
"null"
]
},
"name": {
"description": "name of the advertiser",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ChatGptAdElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"advertiser": {
"description": "information about the advertiser associated with the ad",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptAdAdvertiser"
}
],
"type": [
"object",
"null"
]
},
"domain": {
"description": "domain",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image displayed in the ad",
"type": [
"string",
"null"
]
},
"is_rendered": {
"description": " indicates whether the ad is displayed to the user
if `true`, the ad is present in the response and shown on the page
if `false`, the ad is present in the response but not displayed to the user",
"type": [
"boolean",
"null"
]
},
"snippet": {
"description": "source description",
"type": [
"string",
"null"
]
},
"title": {
"description": "name of the brand",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ChatGptBrandEntity": {
"properties": {
"category": {
"description": "category of the brand",
"type": [
"string",
"null"
]
},
"markdown": {
"description": "brand name in markdown format
contains brand name formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"title": {
"description": "name of the brand",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"urls": {
"description": " array of URLs and domains relevant to the brand",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ChatGptGoogleShoppingProduct": {
"properties": {
"catalog_id": {
"description": "Google Shopping catalog identifier of the product
can be used as a product_id in Google Shopping API endpoints",
"type": [
"string",
"null"
]
},
"ei": {
"description": "event identifier
internal event identifier used by Google",
"type": [
"string",
"null"
]
},
"gl": {
"description": "country code
indicates the location for which search results are displayed",
"type": [
"string",
"null"
]
},
"gpcid": {
"description": "Google product cluster identifier
can be used as a gid in Google Shopping API endpoints",
"type": [
"string",
"null"
]
},
"headline_offer_docid": {
"description": "document identifier of the main offer in the headline
can be used as a data_docid in Google Shopping API endpoints",
"type": [
"string",
"null"
]
},
"hl": {
"description": "host language code
indicates the language in which search results are displayed",
"type": [
"string",
"null"
]
},
"image_docid": {
"description": "identifier for the displayed product’s image",
"type": [
"string",
"null"
]
},
"mid": {
"description": "merchant identifier
identifier of the seller or merchant account in Google Shopping",
"type": [
"string",
"null"
]
},
"product_id": {
"description": "product identifier
can be used as a data_docid in Google Shopping API endpoints",
"type": [
"string",
"null"
]
},
"pvt": {
"description": "product view type
internal Google parameter that specifies the product view type used when rendering the product item",
"type": [
"string",
"null"
]
},
"query": {
"description": "search query
search query used by ChatGPT to retrieve the product from Google Shopping",
"type": [
"string",
"null"
]
},
"rds": {
"description": "resource descriptor string
internal Google resource descriptor string that identifies the product within Google's Shopping index",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"uule": {
"description": "encoded location parameter
indicates the location for a search",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ChatGptImagesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "elements of ChatGPT results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GeminiImagesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ChatGptLocalBusinessesElement": {
"properties": {
"address": {
"description": "address of the local business",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the local business",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain",
"type": [
"string",
"null"
]
},
"phone": {
"description": "phone of the local business",
"type": [
"string",
"null"
]
},
"rating": {
"description": "rating of the corresponding local business
popularity rate based on reviews as displayed in the results",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "total number of reviews submitted for the local business",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ChatGptLocalBusinessesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "elements of ChatGPT results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptLocalBusinessesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ChatGptNavigationListElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"sources": {
"description": "array of sources",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "name of the brand",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ChatGptProductsElement": {
"properties": {
"currency": {
"description": "currency of the listed price
ISO code of the currency applied to the price",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain",
"type": [
"string",
"null"
]
},
"id_to_token_map": {
"description": "product identifier token
Base64-encoded token containing Google Shopping product IDs associated with the product",
"type": [
"string",
"null"
]
},
"images": {
"description": "image URLs of the element
contains URLs leading to the images on the original resource or DataForSEO storage (in case the original source is not available)",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"merchants": {
"description": "merchant(s) offering the product",
"type": [
"string",
"null"
]
},
"price": {
"description": "product price",
"type": [
"number",
"null"
]
},
"product_id": {
"description": "product id",
"type": [
"string",
"null"
]
},
"product_ids": {
"description": "Google Shopping product identifiers
array of Google Shopping product IDs associated with the product",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptGoogleShoppingProduct"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rating": {
"description": "rating of the corresponding local business
popularity rate based on reviews as displayed in the results",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"tag": {
"description": "tag text",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ChatGptProductsElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "elements of ChatGPT results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptProductsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ChatGptTableElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"brand_entities": {
"description": "array of brand entities
contains information on brands mentioned in the text",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptBrandEntity"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"table": {
"description": "table present in the element
the header and content of the table present in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"text": {
"description": "text of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ChatGptTextElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseChatGptLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"brand_entities": {
"description": "array of brand entities
contains information on brands mentioned in the text",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChatGptBrandEntity"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"sources": {
"description": "array of sources",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ChatgptSearchResult": {
"properties": {
"breadcrumb": {
"description": "breadcrumb",
"type": [
"string",
"null"
]
},
"description": {
"description": "result description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "result domain",
"type": [
"string",
"null"
]
},
"title": {
"description": "result title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "result URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ClickstreamKeywordInfo": {
"properties": {
"age_distribution": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of clickstream-based metrics by age
learn more about how the metric is calculated in this help center article",
"type": [
"object",
"null"
]
},
"gender_distribution": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of estimated clickstream-based metrics by gender
learn more about how the metric is calculated in this help center article",
"type": [
"object",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_volume": {
"description": "average monthly search volume rate
represents the (approximate) number of searches for the given keyword idea on google.com",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CommercialUnitsElement": {
"properties": {
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"price": {
"description": "price indicated in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CommercialUnitsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CommercialUnitsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_CompareSitesElement": {
"properties": {
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CompareSitesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CompareSitesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_Contacts": {
"properties": {
"emails": {
"description": "array of emails
",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"telephones": {
"description": "array of telephone numbers
",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisAvailableFiltersResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisAvailableFiltersTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisAvailableFiltersResultInfo": {
"properties": {
"search": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisAvailableFiltersTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisAvailableFiltersResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisCategoriesInfo": {
"properties": {
"category": {
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
},
"count": {
"format": "int64",
"type": [
"integer",
"null"
]
}
}
},
"Response0A3E90081762_ContentAnalysisCategoriesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisCategoriesResultInfo": {
"properties": {
"category_code": {
"description": "category code",
"type": [
"integer",
"null"
]
},
"category_code_parent": {
"description": "the code of the superordinate category
example:\"category_code\": 10178,
\"category_name\": \"Apparel Accessories\",
\"category_code_parent\": 10021
where category_code_parent
corresponds to: \"category_code\": 10178,",
"type": [
"integer",
"null"
]
},
"category_name": {
"description": "full name of the category",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisCategoriesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisCategoryTrendsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoryTrendsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisCategoryTrendsLiveResultInfo": {
"properties": {
"connotation_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "connotation types
\"category_name\": \"Apparel Accessories\"
contains types of sentiments (sentiment polarity) related to the category citation and citation count per each sentiment type
possible connotation types: \"positive\", \"negative\", \"neutral\"",
"type": [
"object",
"null"
]
},
"countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "countries
contains countries and citation count in each country
to obtain a full list of available countries, refer to the Locations endpoint",
"type": [
"object",
"null"
]
},
"date": {
"description": "date for which the data is provided",
"type": [
"string",
"null"
]
},
"languages": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "languages
contains languages and citation count in each language
to obtain a full list of available languages, refer to the Languages endpoint",
"type": [
"object",
"null"
]
},
"page_categories": {
"description": "page categories
contains objects with page categories and citation count in each page category
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"page_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "page types
contains page types and citation count per each page type",
"type": [
"object",
"null"
]
},
"rank": {
"description": "rank of all URLs citing the keyword
normalized sum of ranks of all URLs citing the target keyword for the given date",
"type": [
"integer",
"null"
]
},
"sentiment_connotations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "sentiment connotations
contains sentiments (emotional reactions) related to the target category citation and the number of citations per each sentiment
possible connotations: \"anger\", \"fear\", \"happiness\", \"love\", \"sadness\", \"share\", \"neutral\", \"fun\"",
"type": [
"object",
"null"
]
},
"text_categories": {
"description": "text categories
contains objects with text categories and citation count in each text category
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"top_domains": {
"description": "top domains citing the target keyword
contains objects with top domains citing the target category and citation count per each domain",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopDomainInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "total number of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisCategoryTrendsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoryTrendsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisLanguagesResultInfo": {
"properties": {
"country_iso_code": {
"type": [
"string",
"null"
]
},
"location_code": {
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"type": [
"integer",
"null"
]
},
"location_name": {
"type": [
"string",
"null"
]
},
"location_type": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisPhraseTrendsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisPhraseTrendsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisPhraseTrendsLiveResultInfo": {
"properties": {
"connotation_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "connotation types
contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type
possible connotation types: \"positive\", \"negative\", \"neutral\"",
"type": [
"object",
"null"
]
},
"countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "countries
contains countries and citation count in each country
to obtain a full list of available countries, refer to the Locations endpoint",
"type": [
"object",
"null"
]
},
"date": {
"description": "date for which the data is provided",
"type": [
"string",
"null"
]
},
"languages": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "languages
contains languages and citation count in each language
to obtain a full list of available languages, refer to the Languages endpoint",
"type": [
"object",
"null"
]
},
"page_categories": {
"description": "page categories
contains objects with page categories and citation count in each page category
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"page_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "page types
contains page types and citation count per each page type",
"type": [
"object",
"null"
]
},
"rank": {
"description": "rank of all URLs citing the keyword
normalized sum of ranks of all URLs citing the target keyword for the given date",
"type": [
"integer",
"null"
]
},
"sentiment_connotations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "sentiment connotations
contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment
possible connotations: \"anger\", \"happiness\", \"love\", \"sadness\", \"share\", \"fun\"",
"type": [
"object",
"null"
]
},
"text_categories": {
"description": "text categories
contains objects with text categories and citation count in each text category
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"top_domains": {
"description": "top domains citing the target keyword
contains objects with top domains citing the target keyword and citation count per each domain",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopDomainInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "total number of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisPhraseTrendsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisPhraseTrendsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisRatingDistributionLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisRatingDistributionLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisRatingDistributionLiveResultInfo": {
"properties": {
"max": {
"description": "max rating on a distribution scaleurl",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AnalysisContentInfo"
}
],
"type": [
"object",
"null"
]
},
"country": {
"description": "country code of the domain registration
to obtain a full list of available countries, refer to the Locations endpoint",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain name",
"type": [
"string",
"null"
]
},
"domain_rank": {
"description": "rank of the domain
this value is based on backlink data for the given domain from DataForSEO Backlink Index;domain_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"fetch_time": {
"description": "date and time when our crawler visited the page
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"language": {
"description": "main language of the domain
to obtain a full list of available languages, refer to the Languages endpoint",
"type": [
"string",
"null"
]
},
"main_domain": {
"description": "main domain",
"type": [
"string",
"null"
]
},
"page_category": {
"description": "contains all relevant page categories
product and service categories relevant for the page
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"page_types": {
"description": "page types",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"ratings": {
"description": "ratings found on the page
all ratings found on the page based on microdata",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContententRatingInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"score": {
"description": "citation prominence score
this value is based on url_rank, domain_rank, keyword presence in title, main_title, url, snippet
the higher the score, the more value the related citation has",
"type": [
"number",
"null"
]
},
"social_metrics": {
"description": "social media engagement metrics
data on social media interactions associated with the content based on website embeds developed and supported by social media platforms",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SocialMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"spam_score": {
"description": "backlink spam score of the url
this value is based on backlink data for the given URL from DataForSEO Backlink Index;
learn more about how the metric is calculated on this help center page",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL where the citation was found",
"type": [
"string",
"null"
]
},
"url_rank": {
"description": "rank of the url
this value is based on backlink data for the given URL from DataForSEO Backlink Index;url_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSearchLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSearchLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSearchLiveResultInfo": {
"properties": {
"items": {
"description": "contains citations and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSearchLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
you can use the string provided in this field to get the subsequent results of the initial task;
note: offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSearchLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSearchLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSentimentAnalysisLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSentimentAnalysisLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSentimentAnalysisLiveResultInfo": {
"properties": {
"positive_connotation_distribution": {
"description": "citation distribution by sentiment connotation types\ncontains objects with citation counts and relevant data distributed by types of sentiments (sentiment polarity);\npossible sentiment connotation types: positive, negative, neutral",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PositiveConnotationDistribution"
}
],
"type": [
"object",
"null"
]
},
"sentiment_connotation_distribution": {
"description": "citation distribution by sentiment connotations\ncontains objects with citation counts and relevant data distributed by sentiments (emotional reactions);\npossible sentiment connotation types: anger, happiness, love, sadness, share, fun",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SentimentConnotationDistribution"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSentimentAnalysisLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSentimentAnalysisLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSummaryInfo": {
"properties": {
"connotation_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "connotation types
contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type
possible sentiment connotation types: positive, negative, neutral",
"type": [
"object",
"null"
]
},
"countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "countries
contains countries and citation count in each country
to obtain a full list of available countries, refer to the Locations endpoint",
"type": [
"object",
"null"
]
},
"languages": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "languages
contains languages and citation count in each language
to obtain a full list of available languages, refer to the Languages endpoint",
"type": [
"object",
"null"
]
},
"page_categories": {
"description": "page categories
contains objects with page categories and citation count in each page category
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"page_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "page types
contains page types and citation count per each page type",
"type": [
"object",
"null"
]
},
"rank": {
"description": "rank of all URLs citing the keyword
normalized sum of ranks of all URLs citing the target keyword",
"type": [
"integer",
"null"
]
},
"sentiment_connotations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "sentiment connotations
contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment
possible sentiment connotations: anger, happiness, love, sadness, share, fun",
"type": [
"object",
"null"
]
},
"text_categories": {
"description": "text categories
contains objects with text categories and citation count in each text category
to obtain a full list of available categories, refer to the Categories endpoint",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisCategoriesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"top_domains": {
"description": "top domains citing the target keyword
contains objects with top domains citing the target keword and citation count per each domain",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopDomainInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSummaryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentAnalysisSummaryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ContentCommentInfo": {
"properties": {
"author": {
"description": "评论作者",
"type": [
"string",
"null"
]
},
"have_form": {
"description": "",
"type": [
"boolean",
"null"
]
},
"primary_content": {
"description": "primary content on the page\nyou can find more information about content priority calculation in this help center article",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SectionContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"publish_date": {
"description": "评论发布日期",
"type": [
"string",
"null"
]
},
"rating": {
"description": "product’s rating\ncontains information about the rating a customer has given to the product",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContententRatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "客户评论的标题",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentOfferInfo": {
"properties": {
"name": {
"description": "产品名称",
"type": [
"string",
"null"
]
},
"price": {
"description": "产品价格",
"format": "double",
"type": [
"number",
"null"
]
},
"price_currency": {
"description": "价格币种",
"type": [
"string",
"null"
]
},
"price_valid_until": {
"description": "displays the date and time until which the price is valid\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample: \"2022-11-01 10:02:52 +00:00\"",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentParsingElement": {
"properties": {
"fetch_time": {
"description": "date and time when the content was fethced
example:
\"2022-11-01 10:02:52 +00:00\"",
"type": [
"string",
"null"
]
},
"page_as_markdown": {
"description": "page content in the markdown format
page content in the text-to-HTML markdown format
specify markdown_view as true in the request to return the value",
"type": [
"string",
"null"
]
},
"page_content": {
"description": "parsed content of the page
",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageContentInfo"
}
],
"type": [
"object",
"null"
]
},
"status_code": {
"description": "general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContentUrlInfo": {
"properties": {
"anchor_text": {
"description": "URL 的锚文本",
"type": [
"string",
"null"
]
},
"url": {
"description": "包含在内容元素中找到的其他 URL 和锚文本",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ContententRatingInfo": {
"properties": {
"max_rating_value": {
"description": "评分名称的最大值",
"format": "double",
"type": [
"number",
"null"
]
},
"name": {
"description": "rating name\nhere you can find the following elements: Max5, Percents, CustomMax",
"type": [
"string",
"null"
]
},
"rating_count": {
"description": "投票数",
"format": "int64",
"type": [
"integer",
"null"
]
},
"rating_value": {
"description": "评级值",
"format": "double",
"type": [
"number",
"null"
]
},
"relative_rating": {
"description": "相对评级",
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CountryDistribution": {
"properties": {
"country_iso_code": {
"description": "country ISO code",
"type": [
"string",
"null"
]
},
"percentage": {
"description": "percentage of global search volume",
"type": [
"number",
"null"
]
},
"search_volume": {
"description": "clickstream-based average monthly search volume rate
represents the (approximate) number of searches for the given keyword idea based on clickstream
you can learn more about clickstream search volume in this Help Center article",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CoursesElement": {
"properties": {
"date": {
"description": "the date when the page source of the element was published",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the element’s rating \nthe popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"source": {
"description": "source of the element\nindicates the source of information included in the top_stories_element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CoursesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"categories": {
"description": "array of course categories\ncontains a list of categories relevant to courses",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CoursesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_CrawlStatusInfo": {
"properties": {
"max_crawl_pages": {
"description": "maximum number of pages to crawl\n indicates the max_crawl_pages limit you specified when setting a task",
"format": "int64",
"type": [
"integer",
"null"
]
},
"pages_crawled": {
"description": "已抓取页面数",
"format": "int64",
"type": [
"integer",
"null"
]
},
"pages_in_queue": {
"description": "当前位于抓取队列中的页面数量",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_CurrencyBoxSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"converted_currency": {
"description": "converted currency",
"type": [
"string",
"null"
]
},
"converted_value": {
"description": "value converted to a requested currency
indicates the exact value based on Google Fincance data at the time when our API pulled the results
note that exchange rates displayed in the currency_box element may be delayed according to the Google Finance disclaimer",
"type": [
"number",
"null"
]
},
"currency": {
"description": "currency of the listed price
ISO code of the currency applied to the price",
"type": [
"string",
"null"
]
},
"graph": {
"description": "contains data provided in the graph of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Graph"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"table": {
"description": "table present in the element
the header and content of the table present in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"value": {
"description": "the value of the rating",
"type": [
"number",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsAnswerBoxSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "text
if there is none, equals null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsCarouselSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsCommercialUnitsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CommercialUnitsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsCoursesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"categories": {
"description": "array of course categories\ncontains a list of categories relevant to courses",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CoursesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_DataLabsEventsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_EventsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsExploreBrandsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ExploreBrandsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_DataLabsFeaturedSnippetSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"backlinks_info": {
"description": "backlinks information for the relevant page URL",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"clickstream_etv": {
"description": "estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for;
to retrieve results for this field, the parameter include_clickstream_data must be set to true;
learn more about how the metric is calculated in this help center article",
"format": "double",
"type": [
"number",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "subdomain in SERP",
"type": [
"string",
"null"
]
},
"estimated_paid_traffic_cost": {
"description": "estimated cost of converting organic search traffic into paid
represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for;
the 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 Search;
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"etv": {
"description": "estimated traffic volume
estimated organic monthly traffic to the domain or webpage;
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for;
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"featured_title": {
"description": "the title of the featured snippets source page",
"type": [
"string",
"null"
]
},
"main_domain": {
"description": "primary domain name in SERP",
"type": [
"string",
"null"
]
},
"rank_changes": {
"description": "changes in rankings
contains information about the ranking changes of the SERP element since the previous_updated_time",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankChanges"
}
],
"properties": {
"is_down": {
"description": "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check",
"type": "boolean"
},
"is_new": {
"description": "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element",
"type": "boolean"
},
"is_up": {
"description": "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check",
"type": "boolean"
},
"previous_rank_absolute": {
"description": "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"rank_info": {
"description": "page and domain rank information",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankInfo"
}
],
"type": [
"object",
"null"
]
},
"relative_url": {
"description": "URL in SERP that does not specify the HTTPs protocol and domain name",
"type": [
"string",
"null"
]
},
"table": {
"description": "results table
if there are none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsFindResultsOnSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FindResultsOnElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsFoundOnWebSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FoundOnWebElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"related_searches": {
"description": "search queries related to the elment",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_DataLabsGoogleFlightsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFlightsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsGoogleHotelsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"hotel_identifier": {
"description": "unique hotel identifier
unique hotel identifier assigned by Google;
example: \"CgoIjaeSlI6CnNpVEAE\"",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsGooglePostsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"cid": {
"description": "google-defined client id",
"type": [
"string",
"null"
]
},
"feature": {
"description": "the additional feature of the review",
"type": [
"string",
"null"
]
},
"posts_id": {
"description": "the identifier of the google_posts feature",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_DataLabsGoogleReviewsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"cid": {
"description": "google-defined client id",
"type": [
"string",
"null"
]
},
"feature": {
"description": "the additional feature of the review",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "the identifier of a place",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsHotelsPackSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"date_from": {
"description": "starting date of stay
in the format “year-month-date”
example:
2019-11-15",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of stay
in the format “year-month-date”
example:
2019-11-17",
"type": [
"string",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelsPackElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsImagesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"related_image_searches": {
"deprecated": true,
"description": "contains keywords and images related to the specified search term
if there are none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedImageSearchesElement"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsJobsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_JobsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsKnowledgeGraphSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"card_id": {
"description": "card id",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image from knowledge graph",
"type": [
"string",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"logo_url": {
"description": "URL of the logo from knowledge graph",
"type": [
"string",
"null"
]
},
"sub_title": {
"description": "subtitle of the item",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsLocalPackSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"backlinks_info": {
"description": "backlinks information for the ranked website",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"clickstream_etv": {
"description": "estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article",
"format": "double",
"type": [
"number",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "subdomain in SERP",
"type": [
"string",
"null"
]
},
"estimated_paid_traffic_cost": {
"description": "estimated cost of paid monthly search traffic represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"etv": {
"description": "estimated traffic volume estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"is_paid": {
"description": "indicates whether the element is an ad",
"type": [
"boolean",
"null"
]
},
"main_domain": {
"description": "primary domain name in SERP",
"type": [
"string",
"null"
]
},
"phone": {
"description": "phone number",
"type": [
"string",
"null"
]
},
"rank_changes": {
"description": "changes in rankings contains information about the ranking changes of the SERP element since the previous_updated_time",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankChanges"
}
],
"properties": {
"is_down": {
"description": "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check",
"type": "boolean"
},
"is_new": {
"description": "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element",
"type": "boolean"
},
"is_up": {
"description": "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check",
"type": "boolean"
},
"previous_rank_absolute": {
"description": "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"rank_info": {
"description": "page and domain rank information",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"relative_url": {
"description": "URL in SERP that does not specify the HTTPs protocol and domain name",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsLocalServicesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsMapSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsMathSolverSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MathSolverElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"result": {
"description": "solution to the equation
solution to the mathematical equation specified in the keyword field when setting a task",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsMentionCarouselSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MentionCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_DataLabsMultiCarouselSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MultiCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsOrganicSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"about_this_result": {
"deprecated": true,
"description": "contains information from the 'About this result' panel
'About this result' panel provides additional context about why Google returned this result for the given query;
this feature appears after clicking on the three dots next to most results",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AboutThisResultElement"
}
],
"type": [
"object",
"null"
]
},
"amp_version": {
"description": "Accelerated Mobile Pages
indicates whether an item has the Accelerated Mobile Page (AMP) version
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"backlinks_info": {
"description": "backlinks information for the relevant page URL",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"checks": {
"description": "array of properties detected for the SERP element
lists the properties that are true for this element
each value in the array represents a detected property
example:
if is_image is present in the array, the element contains an image
possible values in the array:is_image, is_video, is_featured_snippet, amp_version, is_malicious, is_web_story, is_highly_cited
equals null if none of the properties are detected for the element
learn more about the checks array in this Help Center article",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"clickstream_etv": {
"description": "estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for;
to retrieve results for this field, the parameter include_clickstream_data must be set to true;
learn more about how the metric is calculated in this help center article",
"format": "double",
"type": [
"number",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "subdomain in SERP",
"type": [
"string",
"null"
]
},
"estimated_paid_traffic_cost": {
"description": "estimated cost of converting organic search traffic into paid
represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for;
the 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 Search;
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"etv": {
"description": "estimated traffic volume
estimated organic monthly traffic to the domain or webpage;
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for;
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"extended_snippet": {
"description": "includes additional information appended after the result description in SERP",
"type": [
"string",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_featured_snippet": {
"description": "indicates whether the element is a featured_snippet
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_image": {
"description": "indicates whether the element contains an image
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_malicious": {
"description": "indicates whether the element is marked as malicious
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_video": {
"description": "indicates whether the element contains a video
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"main_domain": {
"description": "primary domain name in SERP",
"type": [
"string",
"null"
]
},
"pre_snippet": {
"description": "includes additional information appended before the result description in SERP",
"type": [
"string",
"null"
]
},
"rank_changes": {
"description": "changes in rankings
contains information about the ranking changes of the SERP element since the previous_updated_time",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankChanges"
}
],
"properties": {
"is_down": {
"description": "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check",
"type": "boolean"
},
"is_new": {
"description": "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element",
"type": "boolean"
},
"is_up": {
"description": "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check",
"type": "boolean"
},
"previous_rank_absolute": {
"description": "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"rank_info": {
"description": "page and domain rank information",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"relative_url": {
"description": "URL in SERP that does not specify the HTTPs protocol and domain name",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "relevant website name in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsPaidSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"backlinks_info": {
"description": "backlinks information for the ranked website",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"checks": {
"description": "array of properties detected for the SERP elementlists the properties that are true for this elementeach value in the array represents a detected property example:if is_image is present in the array, the element contains an imagepossible values in the array:is_image, is_video, is_featured_snippet, amp_version, is_malicious, is_web_story, is_highly_citedequals null if none of the properties are detected for the elementlearn more about the checks array in this Help Center article",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"clickstream_etv": {
"description": "estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article",
"format": "double",
"type": [
"number",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"description_rows": {
"description": "extended description if there is none, equals null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"domain": {
"description": "subdomain in SERP",
"type": [
"string",
"null"
]
},
"estimated_paid_traffic_cost": {
"description": "estimated cost of paid monthly search traffic represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"etv": {
"description": "estimated traffic volume estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"extra": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "sitelinks the links shown below some of Google's search results if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AdLinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"main_domain": {
"description": "primary domain name in SERP",
"type": [
"string",
"null"
]
},
"rank_changes": {
"description": "changes in rankings contains information about the ranking changes of the SERP element since the previous_updated_time",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankChanges"
}
],
"properties": {
"is_down": {
"description": "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check",
"type": "boolean"
},
"is_new": {
"description": "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element",
"type": "boolean"
},
"is_up": {
"description": "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check",
"type": "boolean"
},
"previous_rank_absolute": {
"description": "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"rank_info": {
"description": "page and domain rank information",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankInfo"
}
],
"type": [
"object",
"null"
]
},
"relative_url": {
"description": "URL in SERP that does not specify the HTTPs protocol and domain name",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsPeopleAlsoAskSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PeopleAlsoAskElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsPeopleAlsoSearchSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsPodcastsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PodcastsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_DataLabsPopularProductsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PopularProductsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsQuestionsAndAnswersSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_QuestionsAndAnswersElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsRecipesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RecipesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsRelatedSearchesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsScholarlyArticlesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ScholarlyArticlesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsShoppingSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ShoppingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsStocksBoxSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"graph": {
"description": "contains data provided in the graph of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Graph"
}
],
"type": [
"object",
"null"
]
},
"price": {
"description": "price of booking a place for the specified dates of stay",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"source": {
"description": "source of additional information about the result",
"type": [
"string",
"null"
]
},
"table": {
"description": "table element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsTopSightsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopSightsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsTopStoriesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopStoriesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsTwitterSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TwitterElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsVideoSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_VideoElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataLabsVisualStoriesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveItem": {
"properties": {
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"search_volume": {
"description": "average monthly search volume rate
represents the (approximate) number of searches for the returned keyword on Amazon",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveResultInfo": {
"properties": {
"items": {
"description": "contains keyword search volume data data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonBulkSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveItem": {
"properties": {
"asin": {
"description": "ASIN in a POST array",
"type": [
"string",
"null"
]
},
"avg_position": {
"description": "average position of the product in Amazon SERP
Note: average position is calculated for intersected keywords only;
the value for a given product may differ when combined with different target products",
"format": "float",
"type": [
"number",
"null"
]
},
"competitor_metrics": {
"description": "metrics for intersecting keywords
ranking data relevant to the keywords that the provided asin shares with the target asin;
Note: in this object ranking data is provided for the returned competitor's asin",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonMetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"full_metrics": {
"description": "metrics for all keywords of the product
full overview of ranking data relevant to all keywords that the provided asin is ranking for",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonMetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"intersections": {
"description": "number of intersecting keywords",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"sum_position": {
"description": "sum of all product positions in Amazon SERP
Note: average position is calculated for intersected keywords only;
the value for a given product may differ when combined with different target products",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveResultInfo": {
"properties": {
"asin": {
"description": "ASIN in a POST array",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains detected Amazon product competitors and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductCompetitorsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveItem": {
"properties": {
"intersection_result": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonInfo"
}
],
"type": [
"object",
"null"
]
},
"description": "data on the intersection",
"type": [
"object",
"null"
]
},
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonKeywordData"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo": {
"properties": {
"asins": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "ASINs in a POST array",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains detected Amazon product competitors and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveItem": {
"properties": {
"asin": {
"description": "ASIN of the product
unique product identifier on Amazon;
for more information, refer to this help center guide",
"type": [
"string",
"null"
]
},
"metrics": {
"description": "average keyword position of the product",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonMetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveResultInfo": {
"properties": {
"items": {
"description": "contains detected Amazon product competitors and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonProductRankOverviewLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveItem": {
"properties": {
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"ranked_serp_element": {
"description": "contains data on the products's SERP element found for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonRankedSerpElement"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveResultInfo": {
"properties": {
"asin": {
"description": "ASIN in a POST array",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains detected Amazon product competitors and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonRankedKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveItem": {
"properties": {
"depth": {
"description": "keyword search depth",
"type": [
"integer",
"null"
]
},
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonKeywordData"
}
],
"type": [
"object",
"null"
]
},
"related_keywords": {
"description": "list of related keywords
represents the list of search queries which are related to the keyword returned in the array above",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo": {
"properties": {
"items": {
"description": "contains objects with keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"seed_keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"seed_keyword_data": {
"description": "keyword data for the seed keyword
fields in the object are identical to that of keyword_data",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonKeywordData"
}
],
"type": [
"object",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleAppCompetitorsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleAppCompetitorsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleAppCompetitorsLiveResultInfo": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains data related to the app_id and competitor applications",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsleAppCompetitorsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleAppCompetitorsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleAppCompetitorsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleAppIntersectionLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleAppIntersectionLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleAppIntersectionLiveResultInfo": {
"properties": {
"app_ids": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "ids of the apps in a POST array",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains data related to the ranking keywords for the app specified in the app_id field",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsleAppIntersectionLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleAppIntersectionLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleAppIntersectionLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleBulkAppMetricsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleBulkAppMetricsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleBulkAppMetricsLiveResultInfo": {
"properties": {
"items": {
"description": "contains data related to the ranking app metrics of the specified application",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsleBulkAppMetricsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleBulkAppMetricsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleBulkAppMetricsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveItem": {
"properties": {
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"ranked_serp_element": {
"description": "contains data on the domain's SERP element found for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppleRankedSerpElementInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveResultInfo": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains data related to the ranking keywords for the app specified in the app_id field",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAppleKeywordsForAppLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAvailableFiltersResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAvailableFiltersTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAvailableFiltersResultInfo": {
"properties": {
"app_competitors": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"app_intersection": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"categories_for_domain": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"competitors_domain": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"database_rows_count": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"domain_intersection": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"domain_metrics_by_categories": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"keyword_ideas": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"keyword_suggestions": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"keywords_for_app": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"keywords_for_categories": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"keywords_for_site": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"page_intersection": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"product_competitors": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"product_keyword_intersections": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"ranked_keywords": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"related_keywords": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"relevant_pages": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"serp_competitors": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"subdomains": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
},
"top_searches": {
"additionalProperties": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsAvailableFiltersTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
contains the full list of available parameters that can be used for data filtration
the parameters are grouped by the endpoint they can be used with",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsAvailableFiltersResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsCarouselElement": {
"properties": {
"sub_title": {
"description": "subtitle of the item",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAppCompetitorsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleAppCompetitorsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAppCompetitorsLiveResultInfo": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains data related to the app_id and competitor applications",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsleAppCompetitorsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAppCompetitorsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleAppCompetitorsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAppIntersectionLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleAppIntersectionLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAppIntersectionLiveResultInfo": {
"properties": {
"app_ids": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "ids of the apps in a POST array",
"type": [
"object",
"null"
]
},
"items": {
"description": "contains data related to the ranking keywords for the app specified in the app_id field",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsleAppIntersectionLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAppIntersectionLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleAppIntersectionLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAvailableHistoryResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleAvailableHistoryTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAvailableHistoryResultInfo": {
"properties": {
"date": {
"description": "available dateindicates the date of the range available for setting in the Domain Metrics by Categories endpointexample:2022-05-16",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleAvailableHistoryTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "包含结果的对象数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleAvailableHistoryResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkAppMetricsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkAppMetricsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkAppMetricsLiveResultInfo": {
"properties": {
"items": {
"description": "contains data related to the ranking app metrics of the specified application",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsleBulkAppMetricsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkAppMetricsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkAppMetricsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveItem": {
"properties": {
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"keyword_difficulty": {
"description": "difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
learn more about the metric in this help center guide",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related keyword difficulty scores",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkKeywordDifficultyLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveItem": {
"properties": {
"metrics": {
"description": "traffic data relevant to the specified domain",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BulkMetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveResultInfo": {
"properties": {
"items": {
"description": "array of items with relevant traffic estimation data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleBulkTrafficEstimationLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveItem": {
"properties": {
"categories": {
"description": "product and service categories
you can download the full list of possible categories",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "ranking data relevant to the specified domain or subdomain",
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveResultInfo": {
"properties": {
"items": {
"description": "contains relevant categories and related ranking data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain or subdomain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForDomainLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveItem": {
"properties": {
"categories": {
"description": "product and service categories
you can download the full list of possible categories",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related keyword difficulty scores",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveItem": {
"properties": {
"avg_position": {
"description": "average position of the domain in SERP
Note: average position is calculated for intersected keywords only;
the value for a given domain may differ when combined with different target websites",
"format": "float",
"type": [
"number",
"null"
]
},
"competitor_metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "metrics for intersecting keywords
ranking and traffic data relevant to the keywords that the provided domain shares with the target domain
note: in this array ranking and traffic data is provided for the returned competitor's domain",
"type": [
"object",
"null"
]
},
"domain": {
"description": "domain name",
"type": [
"string",
"null"
]
},
"full_domain_metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "metrics for all keywords of the domain
full overview of ranking and traffic data relevant to all keywords that the provided domain is ranking for",
"type": [
"object",
"null"
]
},
"intersections": {
"description": "number of intersecting keywords",
"type": [
"integer",
"null"
]
},
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "metrics for intersecting keywords
ranking and traffic data relevant to the keywords that the provided domain shares with the target domain
note: in this array ranking and traffic data is provided for the target considering the keywords target shares in search with the competitor's domain",
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"sum_position": {
"description": "sum of all domain positions in SERP
Note: average position is calculated for intersected keywords only;
the value for a given domain may differ when combined with different target websites",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveResultInfo": {
"properties": {
"items": {
"description": "contains data related to the target and competitor domains",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleCompetitorsDomainLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveItem": {
"properties": {
"first_domain_serp_element": {
"description": "contains data on the first domain's SERP element found for the returned keyword the list of supported SERP elements can be found below",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"keyword_data": {
"description": "返回关键词的关键词数据",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
},
"second_domain_serp_element": {
"description": "contains data on the second domain's SERP element found for the returned keyword the list of supported SERP elements can be found below",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords, relevant SERP elements and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "items 数组中返回的结果数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
},
"target1": {
"description": "the first target domain in a POST array",
"type": [
"string",
"null"
]
},
"target2": {
"description": "the second target domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "数据库中与您的请求相关的结果总量",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainIntersectionLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveItem": {
"properties": {
"domain": {
"description": "domain found for the specified category",
"type": [
"string",
"null"
]
},
"main_domain": {
"description": "primary domain",
"type": [
"string",
"null"
]
},
"metrics_difference": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "metrics difference between first_date and second_date
calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date",
"type": [
"object",
"null"
]
},
"metrics_history": {
"additionalProperties": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": "object"
},
"description": "historical ranking and traffic data of the domain",
"type": [
"object",
"null"
]
},
"organic_count": {
"description": "current total count of organic SERPs that contain the domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"organic_etv": {
"description": "current organic ETV of the domain",
"type": [
"number",
"null"
]
},
"organic_is_lost": {
"description": "current number of lost ranked elements
indicates how many ranked elements of the domain were previously presented in SERPs, but weren’t found during the last check",
"type": [
"integer",
"null"
]
},
"organic_is_new": {
"description": "current number of new ranked elements
indicates how many new ranked elements were found for the domain",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"top_categories": {
"description": "categories for which domains are collected",
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveResultInfo": {
"properties": {
"categories": {
"description": "categories in a POST array",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"items": {
"description": "contains historical ranking and traffic data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainMetricsByCategoriesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveItem": {
"properties": {
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "ranking data relevant to the specified domain",
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo": {
"properties": {
"items": {
"description": "contains ranking and traffic data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem": {
"properties": {
"metrics": {
"description": "traffic data relevant to the specified domain",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HistoricalMetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo": {
"properties": {
"items": {
"description": "array of items with relevant traffic estimation data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveItem": {
"properties": {
"history": {
"description": "array of objects with historical data for the keyword",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_History"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "keyword
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveItem": {
"properties": {
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "ranking data relevant to the specified domain",
"type": [
"object",
"null"
]
},
"month": {
"description": "month for which the data is provided",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"year": {
"description": "year for which the data is provided",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo": {
"properties": {
"items": {
"description": "contains historical ranking and traffic data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveItem": {
"properties": {
"avg_backlinks_info": {
"description": "backlink data for the returned keyword\nthis object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvgBacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"clickstream_keyword_info": {
"description": "clickstream data for the returned keyword\nto retrieve results for this field, the parameter include_clickstream_data must be set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ClickstreamKeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword": {
"description": "keyword\nkeyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"keyword_info": {
"description": "返回的关键词建议对应的关键词数据",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_info_normalized_with_bing": {
"description": "包含使用 Bing 搜索量归一化的关键词搜索量",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfoNormalizedWithInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_info_normalized_with_clickstream": {
"description": "包含使用点击流数据归一化的关键词搜索量",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfoNormalizedWithInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_properties": {
"description": "关于关键词的其他信息",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordProperties"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "indicates data for Google and partner sites\nif true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;\nif false, the results are returned for Google search sites only",
"type": [
"boolean",
"null"
]
},
"serp_info": {
"description": "SERP data\nthe value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo": {
"properties": {
"items": {
"description": "包含关键词及相关数据",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "items 数组中返回的结果数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveItem": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
answer_box, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type in a POST array",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveResultInfo": {
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "the total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
the array includes objects with SERPs for each month within the specified time frame",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleHistoricalSerpsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordIdeasLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordIdeasLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordIdeasLiveResultInfo": {
"properties": {
"items": {
"description": "contains keyword ideas and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "current offset value",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
you can use the string provided in this field to get the subsequent results of the initial task;
note: offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"seed_keywords": {
"description": "keywords in a POST array
keywords are returned with decoded %## (plus character '+' will be decoded to a space character)",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "total number of results relevant to your request in our database ",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordIdeasLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordIdeasLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveItem": {
"properties": {
"avg_backlinks_info": {
"description": "backlink data for the returned keyword
this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvgBacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"clickstream_keyword_info": {
"description": "clickstream data for the returned keyword
to retrieve results for this field, the parameter include_clickstream_data must be set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ClickstreamKeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword": {
"description": "keyword
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"keyword_info": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_info_normalized_with_bing": {
"description": "contains keyword search volume normalized with Bing search volume",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfoNormalizedWithInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_info_normalized_with_clickstream": {
"description": "contains keyword search volume normalized with clickstream data
",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfoNormalizedWithInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_properties": {
"description": "additional information about the keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordProperties"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"search_intent_info": {
"description": "search intent info for the returned keyword
learn about search intent in this help center article",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchIntentInfo"
}
],
"type": [
"object",
"null"
]
},
"search_partners": {
"description": "indicates data for Google and partner sites
if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
if false, the results are returned for Google search sites only",
"type": [
"boolean",
"null"
]
},
"serp_info": {
"description": "SERP data
the value will be null if you didn't set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordOverviewLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "current offset value",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
you can use the string provided in this field to get the subsequent results of the initial task;
note: offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"seed_keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"seed_keyword_data": {
"description": "keyword data for the seed keyword
fields in this object are identical to those of the items array",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveItem": {
"properties": {
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"ranked_serp_element": {
"description": "contains data on the domain's SERP element found for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlayRankedSerpElementInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveResultInfo": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains data related to the ranking keywords for the app specified in the app_id field",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordsForAppLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo": {
"properties": {
"items": {
"description": "contains keyword ideas and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "current offset value",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
you can use the string provided in this field to get the subsequent results of the initial task;
note: offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"seed_categories": {
"description": "categories in a POST array",
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "the total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForSiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordsForSiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForSiteLiveResultInfo": {
"properties": {
"items": {
"description": "contains keyword ideas and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "current offset value",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
you can use the string provided in this field to get the subsequent results of the initial task;
note: offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleKeywordsForSiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleKeywordsForSiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGooglePageIntersectionLiveItem": {
"properties": {
"intersection_result": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"description": "contains data on the SERP elements found for the returned keyworddata will be provided in separate arrays for each URL you specified in the pages object when setting a task;depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively",
"type": [
"object",
"null"
]
},
"keyword_data": {
"description": "返回关键词的关键词数据",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGooglePageIntersectionLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGooglePageIntersectionLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGooglePageIntersectionLiveResultInfo": {
"properties": {
"exclude_pages": {
"description": "URLs you specified in a POST array that will be excluded from the results",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "contains keywords, relevant SERP elements and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGooglePageIntersectionLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "items 数组中返回的结果数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"pages": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "URLs you specified a POST array",
"type": [
"object",
"null"
]
},
"se_type": {
"description": "搜索引擎类型",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "数据库中与您的请求相关的结果总量",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGooglePageIntersectionLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGooglePageIntersectionLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveItem": {
"properties": {
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"ranked_serp_element": {
"description": "contains data on the domain's SERP element found for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RankedSerpElement"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveResultInfo": {
"properties": {
"items": {
"description": "contains ranked keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "ranking data relevant to the specified domain or webpage
ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements",
"type": [
"object",
"null"
]
},
"metrics_absolute": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "ranking data relevant to the specified domain or webpage
ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements",
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain or webpage in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRankedKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveItem": {
"properties": {
"depth": {
"description": "keyword search depth",
"type": [
"integer",
"null"
]
},
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"properties": {
"avg_backlinks_info": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvgBacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"search_intent_info": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchIntentInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"related_keywords": {
"description": "list of related keywords
represents the list of search queries which are related to the keyword returned in the array above",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"seed_keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"seed_keyword_data": {
"description": "keyword data for the seed keyword
fields in the array are identical to that of keyword_data",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRelatedKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveItem": {
"properties": {
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "rankings and traffic metrics for the relevant page",
"type": [
"object",
"null"
]
},
"page_address": {
"description": "absolute URL of the relevant page",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveResultInfo": {
"properties": {
"items": {
"description": "relevant pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "target domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleRelevantPagesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSearchIntentLiveItem": {
"properties": {
"keyword": {
"description": "target keyword in a POST array",
"type": [
"string",
"null"
]
},
"keyword_intent": {
"description": "search intent data relevant for the specified keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordIntentInfo"
}
],
"type": [
"object",
"null"
]
},
"secondary_keyword_intents": {
"description": "contains objects with other possible search intents for the specified keyword",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordIntentInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSearchIntentLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSearchIntentLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSearchIntentLiveResultInfo": {
"properties": {
"items": {
"description": "array of items with relevant traffic estimation data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSearchIntentLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSearchIntentLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSearchIntentLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveItem": {
"properties": {
"avg_position": {
"description": "the average position of the domain for the specified keywords
the arithmetic mean of values in the keywords_positions array",
"format": "float",
"type": [
"number",
"null"
]
},
"domain": {
"description": "domain name of the detected SERP competitor",
"type": [
"string",
"null"
]
},
"etv": {
"description": "estimated traffic volume
represents the estimated monthly traffic that specified keywords are driving to the website
calculated as the sum of the products of the specified keywords' search volume values and CTR (click-through-rate) rates at certain positions in SERP
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"keywords_count": {
"description": "the number of specified keywords the domain has positions for in SERPs",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keywords_positions": {
"additionalProperties": {
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "keyword positions
SERP positions the related domain holds in SERP for the specified keywords",
"type": [
"object",
"null"
]
},
"median_position": {
"description": "the median position of the domain for the specified keywords
the median of the values in the keywords_positions array",
"type": [
"number",
"null"
]
},
"rating": {
"description": "the margin between the greatest possible and actual keyword positions
represents the relative visibility rate of the domain in SERP for the specified keywords
calculated as sum(100-keywords_positions)",
"type": [
"number",
"null"
]
},
"relevant_serp_items": {
"description": "the number of SERP elements relevant to the domain
represents the number of search results in SERP relevant to the domain for the specified keywords",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"visibility": {
"description": "SERP visibility rate
represents the website visibility rate based on the SERP positions of the specified keywords
Keywords with positions in the range from 1 to 10 are assigned the visibility index from 1 to 0.1, respectively
Keywords with positions in the range from 11 to 20 have the fixed visibility index of 0.05
keywords with positions from 20 to 100 have the visibility index equal to 0",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo": {
"properties": {
"items": {
"description": "contains detected SERP competitors and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"seed_keywords": {
"description": "keywords specified in the request
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "the total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSubdomainsLiveItem": {
"properties": {
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsMetricsInfo"
},
"description": "ranking data relevant to subdomain",
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"subdomain": {
"description": "returned subdomain",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSubdomainsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSubdomainsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSubdomainsLiveResultInfo": {
"properties": {
"items": {
"description": "contains subdomains and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSubdomainsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain in a POST array",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleSubdomainsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleSubdomainsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleTopSearchesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleTopSearchesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleTopSearchesLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "current offset value",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "offset token for subsequent requests
you can use the string provided in this field to get the subsequent results of the initial task;
note: offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsGoogleTopSearchesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsGoogleTopSearchesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphCarouselItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:
action:listen_artist",
"type": [
"string",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphListElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphDescriptionItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphLinkElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "description content",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphExpandedItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:
action:listen_artist",
"type": [
"string",
"null"
]
},
"expanded_element": {
"description": "link of the element",
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphImagesItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphImagesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphListItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:
action:listen_artist",
"type": [
"string",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphListElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphPartItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:
action:listen_artist",
"type": [
"string",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "description content",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphRowItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:
action:listen_artist",
"type": [
"string",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "description content",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsKnowledgeGraphShoppingItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:
action:listen_artist",
"type": [
"string",
"null"
]
},
"items": {
"description": "historical SERPs and related data found in the database",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphShoppingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsMetricsInfo": {
"properties": {
"clickstream_age_distribution": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of clickstream-based metrics by age
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article",
"type": [
"object",
"null"
]
},
"clickstream_etv": {
"description": "estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article",
"format": "double",
"type": [
"number",
"null"
]
},
"clickstream_gender_distribution": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of estimated clickstream-based metrics by gender
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article",
"type": [
"object",
"null"
]
},
"count": {
"description": "total count of organic SERPs that contain the domain or subdomain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"estimated_paid_traffic_cost": {
"description": "estimated cost of converting organic search traffic into paid
represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for
the 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 Search
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"etv": {
"description": "estimated traffic volume
estimated organic monthly traffic to the domain or subdomain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"is_down": {
"description": "rank went down
indicates how many ranked elements of the indicated target went down",
"type": [
"integer",
"null"
]
},
"is_lost": {
"description": "lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren't found during the last check",
"type": [
"integer",
"null"
]
},
"is_new": {
"description": "number of new ranked elements
indicates how many new ranked elements were found for the indicated target",
"type": [
"integer",
"null"
]
},
"is_up": {
"description": "rank went up
indicates how many ranked elements of the indicated target went up",
"type": [
"integer",
"null"
]
},
"pos_1": {
"description": "number of organic SERPs where the domain or subdomain ranks #1",
"type": [
"integer",
"null"
]
},
"pos_11_20": {
"description": "number of organic SERPs where the domain or subdomain ranks #11-20",
"type": [
"integer",
"null"
]
},
"pos_21_30": {
"description": "number of organic SERPs where the domain or subdomain ranks #21-30",
"type": [
"integer",
"null"
]
},
"pos_2_3": {
"description": "number of organic SERPs where the domain or subdomain ranks #2-3",
"type": [
"integer",
"null"
]
},
"pos_31_40": {
"description": "number of organic SERPs where the domain or subdomain ranks #31-40",
"type": [
"integer",
"null"
]
},
"pos_41_50": {
"description": "number of organic SERPs where the domain or subdomain ranks #41-50",
"type": [
"integer",
"null"
]
},
"pos_4_10": {
"description": "number of organic SERPs where the domain or subdomain ranks #4-10",
"type": [
"integer",
"null"
]
},
"pos_51_60": {
"description": "number of organic SERPs where the domain or subdomain ranks #51-60",
"type": [
"integer",
"null"
]
},
"pos_61_70": {
"description": "number of organic SERPs where the domain or subdomain ranks #61-70",
"type": [
"integer",
"null"
]
},
"pos_71_80": {
"description": "number of organic SERPs where the domain or subdomain ranks #71-80",
"type": [
"integer",
"null"
]
},
"pos_81_90": {
"description": "number of organic SERPs where the domain or subdomain ranks #81-90",
"type": [
"integer",
"null"
]
},
"pos_91_100": {
"description": "number of organic SERPs where the domain or subdomain ranks #91-100",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsStatusInfo": {
"properties": {
"date_update": {
"description": "update date of the Google endpoints
indicates the last date when the Google endpoints of DataForSEO Labs API were updated;
example:2022-05-16",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsStatusResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsStatusTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsStatusResultInfo": {
"properties": {
"amazon": {
"description": "update information for the Amazon endpoints",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"bing": {
"description": "update information for the Bing endpoints",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"google": {
"description": "update information for the Google endpoints",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsStatusInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsStatusTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoLabsStatusResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoLabsleAppCompetitorsLiveItem": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"avg_position": {
"description": "average position of the app in Google Play SERP
Note: average position is calculated for intersected keywords only;
the value for a given application may differ when combined with different target applications",
"format": "float",
"type": [
"number",
"null"
]
},
"competitor_metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_AppMetricsInfo"
},
"description": "metrics for intersecting keywords
ranking data relevant to the keywords that the provided competitor application shares with the app in a POST request;
note: in this array ranking data is provided for the returned competitor's app_id",
"type": [
"object",
"null"
]
},
"full_metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_AppMetricsInfo"
},
"description": "metrics for all keywords of the application
full overview of ranking data relevant to all keywords that the provided app_id is ranking for",
"type": [
"object",
"null"
]
},
"intersections": {
"description": "number of intersecting keywords",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"sum_position": {
"description": "sum of all app positions in Google Play SERP
Note: sum position is calculated for intersected keywords only;
the value for a given application may differ when combined with different target applications",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsleAppIntersectionLiveItem": {
"properties": {
"intersection_result": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlaySearchOrganic"
}
],
"type": [
"object",
"null"
]
},
"description": "contains SERP data for the returned keyword
data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively",
"type": [
"object",
"null"
]
},
"keyword_data": {
"description": "keyword data for the returned keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordDataInfo"
}
],
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoLabsleBulkAppMetricsLiveItem": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"metrics": {
"additionalProperties": {
"$ref": "#/components/schemas/Response0A3E90081762_AppMetricsInfo"
},
"description": "metrics for the ranking keywords of the app
ranking data relevant to the keywords that the provided application ranks for on Google Play",
"type": [
"object",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoTrendsDataInfo": {
"properties": {
"keyword": {
"description": "relevant keyword for which demographic data is provided",
"type": [
"string",
"null"
]
},
"values": {
"description": "contains age range and corresponding keyword popularity values",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DemographyItemValueInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoTrendsDataforseoTrendsGraphElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataDataforseoTrendsItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"averages": {
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
},
"data": {
"description": "contains the same parameters that you specified in the POST request
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsGraphDataTrendsGraphDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoTrendsDemographyElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataDataforseoTrendsItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"demography": {
"description": "demographic breakdown of keyword popularity data per each specified term
conains keyword popularity data by age and gender",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Demography"
}
],
"type": [
"object",
"null"
]
},
"demography_comparison": {
"description": "comparison of demographic data on keyword popularity for the specified parameters
conains keyword popularity data by age and gender
if you specified a single keyword, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DemographyComparisonInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoTrendsGraphDataTrendsGraphDataInfo": {
"properties": {
"date_from": {
"description": "start date of the corresponding time range
in the UTC format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "end date of the corresponding time range
in the UTC format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "a point in time in the Unix time format",
"type": [
"integer",
"null"
]
},
"values": {
"description": "relative keyword popularity rate at a specific timestamp
represents the keyword popularity rate over the given time range
if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords
a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term",
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoTrendsSubregionInterestsElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataDataforseoTrendsItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"interests": {
"description": "subregional keyword popuarity data for each specified term",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsinterestsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"interests_comparison": {
"description": "comparison of data on subregional keyword popularity for the specified parameters
if you specified a single keyword, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_InterestsComparison"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DataforseoTrendsinterestsInfo": {
"properties": {
"keyword": {
"description": "relevant keyword
the data included in the values element is based on this keyword",
"type": [
"string",
"null"
]
},
"values": {
"description": "contains data on relative keyword popularity by country or region",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsinterestsValuesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DataforseoTrendsinterestsValuesInfo": {
"properties": {
"geo_id": {
"description": "location identifier
you can use this field for matching obtained results with location parameters specified in the request
see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
example:US-NY",
"type": [
"string",
"null"
]
},
"geo_name": {
"description": "location name
you can use this field for matching obtained results with location parameters specified in the request
see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations
example:Andorra",
"type": [
"string",
"null"
]
},
"value": {
"description": "relative keyword popularity rate in a given location
represents location-specific keyword popularity rate over the specified time range;
using this value you can understand how popular a keyword is in one location compared to another location;
calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100);
a value of 100 is the highest popularity for the term
a value of 50 means that the term is half as popular
a value of 0 means there was not enough data for this term",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Dataset": {
"properties": {
"area_covered": {
"description": "the list of areas covered in the dataset
for example: Africa, Global",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"authors": {
"description": "the list of authors of the dataset",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AuthorsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"dataset_description": {
"description": "description of the dataset",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DatasetDescription"
}
],
"type": [
"object",
"null"
]
},
"dataset_id": {
"description": "ID of the dataset",
"type": [
"string",
"null"
]
},
"dataset_providers": {
"description": "the list of institutions that provided the dataset",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"formats": {
"description": "the list of file formats of the dataset",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FormatsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"licenses": {
"description": "the list of licenses issued to the dataset",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google Dataset's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"period_covered": {
"description": "period covered in the dataset",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PeriodCovered"
}
],
"type": [
"object",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"related_article": {
"description": "link to related article
link to the published article that is related to the dataset",
"type": [
"string",
"null"
]
},
"scholarly_articles_url": {
"description": "url of scholarly articles
link to the list of scholarly articles on Google Scholar
example: https://scholar.google.com/scholar?q=%2210.6084%20m9%20figshare%207427933%20v1%22",
"type": [
"string",
"null"
]
},
"scholarly_citations_count": {
"description": "count of articles that refer to the dataset",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"unique_identifier": {
"description": "digital identifier of an object
unique digital identifier of the dataset
example: https://doi.org/10.5061/dryad.hmgqnk9m3",
"type": [
"string",
"null"
]
},
"updated_date": {
"description": "date and time when the result was last updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2022-11-27 02:00:00 +00:00",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DatasetDescription": {
"properties": {
"links": {
"description": "links featured in the 'dataset_description'",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "text of the description",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DeliveryInfo": {
"properties": {
"delivery_date_from": {
"description": "earliest delivery date
the earliest date when the product can be shipped, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"delivery_date_to": {
"description": "latest delivery date
the latest date when the product can be delivered, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"delivery_message": {
"description": "delivery information
message accompanying the delivery information as posted by the seller",
"type": [
"string",
"null"
]
},
"delivery_price": {
"description": "price for the delivery
price of the delivery based on the location you specified in the POST request;
if free delivery is available, the value is null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"fastest_delivery_date_from": {
"description": "earliest free delivery date
the earliest date when the product can be delivered with a fast delivery option, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"fastest_delivery_date_to": {
"description": "latest free delivery date
the latest date when the product can be delivered with a fast delivery option, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Demography": {
"properties": {
"age": {
"description": "distribution of keyword popularity by age",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"gender": {
"description": "distribution of keyword popularity by gender",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DemographyComparisonInfo": {
"properties": {
"age": {
"additionalProperties": {
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "type of element",
"type": [
"object",
"null"
]
},
"gender": {
"additionalProperties": {
"items": {
"type": [
"integer",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "type of element",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DemographyItemValueInfo": {
"properties": {
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"value": {
"description": "keyword popularity rate within the specified age range
using this value you can understand how popular a keyword is within each age range;
calculation: we determine the highest popularity value for the relevant keyword across all age groups, and then express all other values as a percentage of that highest value (100);
a value of 100 is the highest popularity for the term
a value of 0 means there was not enough data for this term",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DictionarySerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"breadcrumb": {
"description": "breadcrumb of the Ad element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword highlighted in the result",
"type": [
"string",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"snippet": {
"description": "snippet of the element",
"type": [
"string",
"null"
]
},
"text": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL of the Ad element in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DiscussionsAndForumsElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"posts_count": {
"description": "number of posts from the discussion on the related source",
"format": "int64",
"type": [
"integer",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DiscussionsAndForumsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DiscussionsAndForumsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem": {
"description": "items 数组",
"properties": {
"categories_count": {
"description": "technology categories count
number of domains that match the parameters you specified and are using technologies from the indicated category",
"format": "int64",
"type": [
"integer",
"null"
]
},
"category": {
"description": "technology category id",
"type": [
"string",
"null"
]
},
"group": {
"description": "technology group id",
"type": [
"string",
"null"
]
},
"groups_count": {
"description": "technology groups count
number of domains that match the parameters you specified and are using technologies from the indicated group",
"format": "int64",
"type": [
"integer",
"null"
]
},
"technologies_count": {
"description": "technologies count
number of domains that match the parameters you specified and are using the indicated technology",
"format": "int64",
"type": [
"integer",
"null"
]
},
"technology": {
"description": "technology name",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveResultInfo": {
"properties": {
"items": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains",
"type": [
"integer",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesAggregationTechnologiesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesAvailableFiltersResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesAvailableFiltersTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesAvailableFiltersResultInfo": {
"properties": {
"aggregation_technologies": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"domains_by_html_terms": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"domains_by_technology": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"technologies_summary": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesAvailableFiltersTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesAvailableFiltersResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainTechnologiesLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainTechnologiesLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainTechnologiesLiveResultInfo": {
"properties": {
"content_language_code": {
"description": "content language
code of the language that content on the target domain is written in",
"type": [
"string",
"null"
]
},
"country_iso_code": {
"description": "domain ISO code
ISO code of the country that the target domain is determined to belong to",
"type": [
"string",
"null"
]
},
"description": {
"description": "domain meta description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "specified domain name",
"type": [
"string",
"null"
]
},
"domain_rank": {
"description": "backlink rank of the target domain
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"emails": {
"description": "emails of the target
emails indicated on the target website",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "domain language
code of the language that the target domain is determined to be associated with",
"type": [
"string",
"null"
]
},
"last_visited": {
"description": "most recent date when our crawler visited the domain
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2022-10-10 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"meta_keywords": {
"description": "domain meta keywords",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"phone_numbers": {
"description": "phone numbers of the target
contact phone numbers indicated on the target website",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"social_graph_urls": {
"description": "social media links and handles
social media URLs detected in the social graphs of the target website",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"technologies": {
"description": "technologies used by target domain
contains objects with the names of technologies used on the website
see the full list of available technologies structured by groups and categories",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TechnologiesInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "domain meta title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainTechnologiesLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainTechnologiesLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "specified offset value",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
by specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByLiveItem": {
"description": "items 数组",
"properties": {
"content_language_code": {
"description": "content language
code of the language that content on the target domain is written with",
"type": [
"string",
"null"
]
},
"country_iso_code": {
"description": "domain ISO code
ISO code of the country that target domain is determined to belong to",
"type": [
"string",
"null"
]
},
"description": {
"description": "domain meta description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "specified domain name",
"type": [
"string",
"null"
]
},
"domain_rank": {
"description": "backlink rank of the target domain
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"emails": {
"description": "emails of the target
emails indicated on the target website",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "domain language
code of the language that target domain is determined to be associated with",
"type": [
"string",
"null"
]
},
"last_visited": {
"description": "most recent date when our crawler visited the domain
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2022-10-10 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"meta_keywords": {
"description": "domain meta keywords",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"phone_numbers": {
"description": "phone numbers of the target
contact phone numbers indicated on the target website",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"social_graph_urls": {
"description": "social media links and handles
social media URLs detected in the social graphs of the target website",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"technologies": {
"description": "technologies used by target domain
contains objects with the names of technologies used on the website;
to get a full list of technologies and their structure, refer to the technologies endpoint",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TechnologiesInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "domain meta title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByTechnologyLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByTechnologyLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByTechnologyLiveResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "specified offset value",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
by specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent task",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByTechnologyLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesDomainsByTechnologyLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesResultInfo": {
"properties": {
"groups": {
"description": "array of technology groups",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Groups"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesSummaryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesSummaryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesSummaryLiveResultInfo": {
"properties": {
"content_languages": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of websites by content language
contains content language codes and number of websites per language",
"type": [
"object",
"null"
]
},
"countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of websites by country
contains country codes and number of websites per country",
"type": [
"object",
"null"
]
},
"keywords": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of websites by keywords
contains keywords found in the websites' titles, descriptions or meta keywords, and number of websites using each keyword",
"type": [
"object",
"null"
]
},
"languages": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of websites by language
contains language codes and number of websites per language",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesSummaryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesSummaryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesTechnologiesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveItem": {
"description": "items 数组",
"properties": {
"countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of websites by country
contains country codes and number of websites per country",
"type": [
"object",
"null"
]
},
"date": {
"description": "date for which the data is provided",
"type": [
"string",
"null"
]
},
"domains_count": {
"description": "number of domains that use the specified technology",
"format": "int64",
"type": [
"integer",
"null"
]
},
"domains_rank": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of websites by backlink rank
contains domain rank ranges and number of websites per range
learn more about rank and how it is calculated in this help center article",
"type": [
"object",
"null"
]
},
"languages": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "distribution of websites by language
contains language codes and number of websites per language",
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveResultInfo": {
"properties": {
"date_from": {
"description": "starting date of the time range",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of the time range",
"type": [
"string",
"null"
]
},
"items": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"type": [
"integer",
"null"
]
},
"technology": {
"description": "target technology",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsTechnologiesTechnologyStatsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsWhoisAvailableFiltersResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsWhoisAvailableFiltersTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsWhoisAvailableFiltersResultInfo": {
"properties": {
"overview": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsWhoisAvailableFiltersTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsWhoisAvailableFiltersResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsWhoisOverviewLiveItem": {
"description": "items 数组",
"properties": {
"backlinks_info": {
"description": "backlink data for the returned domain",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"changed_datetime": {
"description": "date and time when the domain entry was changed
date and time (in the ISO 8601 format) when the domain entry was last modified
example: \"2021-01-14 08:36:28 +00:00\"",
"type": [
"string",
"null"
]
},
"created_datetime": {
"description": "date and time of registration
date and time (in the ISO 8601 format) when the domain was first registered
example: \"1997-03-29 03:00:00 +00:00\"",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain name",
"type": [
"string",
"null"
]
},
"epp_status_codes": {
"description": "extensive provisioning protocol status codes
the status of a domain name registration as defined by ICANN",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"expiration_datetime": {
"description": "date and time when the domain will expire
date and time (in the ISO 8601 format) when the domain is due to expire
example: \"2022-11-26 17:21:23 +00:00\"",
"type": [
"string",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the domain for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: \"2019-11-15 12:57:46 +00:00\"",
"type": [
"string",
"null"
]
},
"metrics": {
"description": "ranking data relevant to the specified domain",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"registered": {
"description": "domain registration status
if false, the domain name registration has expired
Note: expired domains will remain in the database for only a short period of time",
"type": [
"boolean",
"null"
]
},
"registrar": {
"description": "domain registrar
if null, the domain registrar is unknown
example:NameCheap, Inc.",
"type": [
"string",
"null"
]
},
"tld": {
"description": "top-level domain
top-level domain in the DNS root zone",
"type": [
"string",
"null"
]
},
"updated_datetime": {
"description": "date and time when the domain was updated
date and time (in the ISO 8601 format) when the domain was last updated
example: \"2021-01-29 13:59:38 +00:00\"",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsWhoisOverviewLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsWhoisOverviewLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsWhoisOverviewLiveResultInfo": {
"properties": {
"items": {
"description": "contains ranking and traffic data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsWhoisOverviewLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"offset": {
"description": " results offset value specified in POST request",
"type": [
"integer",
"null"
]
},
"offset_token": {
"type": [
"string",
"null"
]
},
"total_count": {
"description": "total amount of results in our database relevant to your request",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DomainAnalyticsWhoisOverviewLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainAnalyticsWhoisOverviewLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_DomainInfo": {
"properties": {
"canonicalization_status_code": {
"description": "status code returned by a canonicalized page
the checkup of the server behavior when our crawler tries to access the website via IP;
in most cases, it is recommended that canonicalized pages respond with a 301 or 302 status code",
"type": [
"integer",
"null"
]
},
"checks": {
"additionalProperties": {
"type": [
"boolean",
"null"
]
},
"description": "website checks
other on-page check-ups related to the website",
"type": [
"object",
"null"
]
},
"cms": {
"description": "content management system
content management system identified on a website
the content of_the generator_meta tag
the data is taken from the first random page that returns the 200 response code
if our crawler was unable to identify the cms, the value would be nulln",
"type": [
"string",
"null"
]
},
"crawl_end": {
"description": "time when the crawling ended
date and time when the crawling was finished
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00
Note: informative only if \"crawl_progress\" is \"finished\"
if \"crawl_progress\" is in_progress, the value will be null",
"type": [
"string",
"null"
]
},
"crawl_start": {
"description": "time when the crawling start
date and time when the website was sent for crawling
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"directory_browsing_status_code": {
"description": "status code returned by a directory
the status code returned by a directory page on a target website
in most cases, it is recommended that directories respond with a 403 or 401 status code",
"type": [
"integer",
"null"
]
},
"extended_crawl_status": {
"description": "crawl status and errors
indicates the reason why a website was not crawled;
can take the following values:no_errors - no crawling errors were detected;site_unreachable - our crawler could not reach a website and thus was not able to obtain a status code;invalid_page_status_code - status code of the first crawled page >= 400;forbidden_meta_tag - the first crawled page contains the <meta robots=\"noindex\"> tag;forbidden_robots - robots.txt forbids crawling the page;forbidden_http_header - HTTP header of the page contains \"X-Robots-Tag: noindex\" ;too_many_redirects - the first crawled page has more than 10 redirects;unknown - the reason is unknown",
"type": [
"string",
"null"
]
},
"ip": {
"description": "domain ip address",
"type": [
"string",
"null"
]
},
"main_domain": {
"description": "root domain name",
"type": [
"string",
"null"
]
},
"name": {
"description": "domain name",
"type": [
"string",
"null"
]
},
"page_not_found_status_code": {
"description": "status code returned by a non-existent page
in most cases, it is recommended a server returns a 404 response code",
"type": [
"integer",
"null"
]
},
"server": {
"description": "website server
the version of the server detected on a website
the content of the server header
the information is taken from the first page which response code is 200",
"type": [
"string",
"null"
]
},
"ssl_info": {
"description": "ssl certificate info
information about the Secure Sockets Layer protocol detected on a website",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SslInfo"
}
],
"type": [
"object",
"null"
]
},
"total_pages": {
"description": "total crawled pages
the total number of crawled pages",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_uncrawlable_resources": {
"description": "total uncrawlable resources
the total number of resources that could not be crawled;
the resource is considered uncrawlable when the actual content type of the resource doesn't match the content type expected by the crawler",
"format": "int64",
"type": [
"integer",
"null"
]
},
"www_redirect_status_code": {
"description": "redirect status code
the status code of the www to non-www redirect
in most cases, it is recommended that redirect returns a 301 status code",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_DuplicatePageInfo": {
"properties": {
"page": {
"description": "information about the page with duplicate content",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageHtmlResourceItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"similarity": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_EventsElement": {
"properties": {
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_EventsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_EventsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ExploreBrandsElement": {
"properties": {
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "元素的 XPath",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ExploreBrandsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ExploreBrandsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_FaqBox": {
"deprecated": true,
"properties": {
"items": {
"description": "contains arrays of specific images",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FaqBoxElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_FaqBoxElement": {
"deprecated": true,
"properties": {
"description": {
"description": "description of the hotel booking element",
"type": [
"string",
"null"
]
},
"links": {
"description": "link of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the link",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_FeaturedSnippetSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"breadcrumb": {
"description": "breadcrumb of the ad element in SERP",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the ad element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the ad element in SERP",
"type": [
"string",
"null"
]
},
"featured_title": {
"description": "title",
"type": [
"string",
"null"
]
},
"images": {
"description": "images of the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements found in SERPnote values are returned in the ascending order, with values corresponding to advanced SERP features omitted from the results;
to get all items (including SERP features and rich snippets) with their positions, please refer to the Google Organiс Advanced SERP endpoint",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"table": {
"description": "table present in the element
the header and content of the table present in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the ad element in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL of the ad element in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_FetchTiming": {
"properties": {
"duration_time": {
"description": "浏览器从服务器接收到完整响应所需的总时间（以毫秒为单位）",
"type": [
"integer",
"null"
]
},
"fetch_end": {
"description": "time to complete downloading the HTML resourcethe amount of time the browser needs to complete downloading a page",
"type": [
"integer",
"null"
]
},
"fetch_start": {
"description": "time to start downloading the HTML resourcethe amount of time the browser needs to start downloading a page",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_FindResultsOnElement": {
"properties": {
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_FindResultsOnSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FindResultsOnElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_FormatsElement": {
"properties": {
"format": {
"description": "type of file format of the dataset
for example: zip, html, csv",
"type": [
"string",
"null"
]
},
"size": {
"description": "file size in bytes",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_FoundOnWebElement": {
"properties": {
"image": {
"description": "image of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"subtitle": {
"description": "subtitle of the element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_FoundOnWebSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FoundOnWebElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"related_searches": {
"description": "search queries related to the elment",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_GeminiImagesElement": {
"properties": {
"alt": {
"description": "alt tag of the image",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GeminiImagesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseGeminiLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "elements of Gemini results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GeminiImagesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GeminiTableElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseGeminiLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"original_text": {
"description": "unformatted text content of the element",
"type": [
"string",
"null"
]
},
"table": {
"description": "table present in the element
the header and content of the table present in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GeminiTextElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseGeminiLlmScraperElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"original_text": {
"description": "unformatted text content of the element",
"type": [
"string",
"null"
]
},
"sources": {
"description": "array of sources",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleBusinessAnswerElement": {
"properties": {
"answer_id": {
"description": "ID of the answer",
"type": [
"string",
"null"
]
},
"answer_text": {
"description": "current text of the answer",
"type": [
"string",
"null"
]
},
"original_answer_text": {
"description": "original text of the answer",
"type": [
"string",
"null"
]
},
"profile_image_url": {
"description": "URL of the user's profile image",
"type": [
"string",
"null"
]
},
"profile_name": {
"description": "displayed name of the user",
"type": [
"string",
"null"
]
},
"profile_url": {
"description": "URL of the user's profile",
"type": [
"string",
"null"
]
},
"time_ago": {
"description": "estimated time when the answer was posted",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "exact time when the answer was posted",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleBusinessInfo": {
"properties": {
"additional_categories": {
"description": "additional business categories
additional Google My Business categories that describe the services provided by the business entity in more detail",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"address": {
"description": "address of the business entity",
"type": [
"string",
"null"
]
},
"address_info": {
"description": "object containing address components of the business entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AddressInfo"
}
],
"type": [
"object",
"null"
]
},
"attributes": {
"description": "service details in a form of user-reviewed checks;
service details of a business entity displayed in a form of checks and based on user feedback and business category",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataAttributesInfo"
}
],
"type": [
"object",
"null"
]
},
"book_online_url": {
"description": "URL in the 'book online' button of the element
URL directing users to the online booking or order page of the business entity",
"type": [
"string",
"null"
]
},
"category": {
"description": "business category
Google My Business general category that best describes the services provided by the business entity",
"type": [
"string",
"null"
]
},
"category_ids": {
"description": "global category IDs
universal category IDs that do not change based on the selected country",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment;
can be used with Google Reviews API to get a full list of reviews
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"contact_url": {
"description": "URL of the preferred contact page",
"type": [
"string",
"null"
]
},
"contributor_url": {
"description": "URL of the user's or entity's Local Guides profile, if available",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the element in SERP
the description of the business entity for which the results are collected",
"type": [
"string",
"null"
]
},
"directory": {
"description": "items of the directory
includes information about businesses that are located within the target business establishment and have the same address",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDirectoryInfo"
}
],
"type": [
"object",
"null"
]
},
"domain": {
"description": "domain of the business entity",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"hotel_rating": {
"description": "hotel class rating
class ratings range between 1-5 stars, learn more
if there is no hotel class rating information, the value will be null",
"type": [
"number",
"null"
]
},
"is_claimed": {
"description": "shows whether the entity is verified by its owner on Google Maps",
"type": [
"boolean",
"null"
]
},
"is_directory_item": {
"description": "business establishment is a part of the directory
indicates whether the business establishment is a part of the directory;
if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);
note: if the business establishment is a parent item in the directory, the value will be null",
"type": [
"boolean",
"null"
]
},
"latitude": {
"description": "latitude coordinate of the local establishments in google maps
example:\"latitude\": 51.584091",
"type": [
"number",
"null"
]
},
"local_business_links": {
"description": "available interactions with the business
list of options to interact with the business directly from search results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseLocalBusinessLink"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"logo": {
"description": "URL of the logo featured in Google My Business profile",
"type": [
"string",
"null"
]
},
"longitude": {
"description": "longitude coordinate of the local establishment in google maps
example:\"longitude\": -0.31365919999999997",
"type": [
"number",
"null"
]
},
"main_image": {
"description": "URL of the main image featured in Google My Business profile",
"type": [
"string",
"null"
]
},
"original_title": {
"description": "original title of the element
original title not translated by Google",
"type": [
"string",
"null"
]
},
"people_also_search": {
"description": "related business entities",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PeopleAlsoSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"phone": {
"description": "phone number of the business entity",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "unique place identifier
place id of the local establishment featured in the element
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"place_topics": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "keywords mentioned in customer reviews
contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword
example:
\"place_topics\": {
\"egg roll\": 48,
\"birthday\": 33
}
information related to busy hours of the business entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PopularTimes"
}
],
"type": [
"object",
"null"
]
},
"position": {
"description": "the alignment in SERP",
"type": [
"string",
"null"
]
},
"price_level": {
"description": "property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null",
"type": [
"string",
"null"
]
},
"questions_and_answers_count": {
"type": [
"integer",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the elements",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"rating_distribution": {
"additionalProperties": {
"format": "Int64",
"type": [
"integer",
"null"
]
},
"description": "the distribution of ratings of the business entity
the object displays the number of 1-star to 5-star ratings, as reviewed by users",
"type": [
"object",
"null"
]
},
"services": {
"description": "list of services offered by the business",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataServiceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"snippet": {
"description": "additional information on the business entity",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in SERP
the name of the business entity for which the results are collected",
"type": [
"string",
"null"
]
},
"total_photos": {
"description": "total count of images featured in Google My Business profile",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "absolute url of the business entity",
"type": [
"string",
"null"
]
},
"work_time": {
"description": "work time details
information related to operational hours of the business entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessWorkHoursInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleBusinessPost": {
"properties": {
"author": {
"description": "author of the post",
"type": [
"string",
"null"
]
},
"images_url": {
"description": "url of an image included in the post",
"type": [
"string",
"null"
]
},
"links": {
"description": "links included in the post",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values: right",
"type": [
"string",
"null"
]
},
"post_date": {
"description": "date when a post was published
in the following format:\"mm/dd/yyyy hh:mm:ss\"",
"type": [
"string",
"null"
]
},
"post_text": {
"description": "main content of a post",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed updates
absolute position among all present elements",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"snippet": {
"description": "additional content of a post",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "time when a post was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "url of a post",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleBusinessQuestionItem": {
"properties": {
"items": {
"description": "array of items
items within google_business_question_item",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleBusinessAnswerElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"original_question_text": {
"description": "original text of the question",
"type": [
"string",
"null"
]
},
"profile_image_url": {
"description": "URL of the user's profile image",
"type": [
"string",
"null"
]
},
"profile_name": {
"description": "displayed name of the user",
"type": [
"string",
"null"
]
},
"profile_url": {
"description": "URL of the user's profile",
"type": [
"string",
"null"
]
},
"question_id": {
"description": "ID of the question",
"type": [
"string",
"null"
]
},
"question_text": {
"description": "current text of the question",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the elements",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"time_ago": {
"description": "estimated time when the question was posted",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "exact time when the question was posted",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the question",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleExtendedReviewsSearch": {
"properties": {
"images": {
"description": "images submitted by the reviewer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"local_guide": {
"description": "indicates whether the reviewer has a 'local guide' status",
"type": [
"boolean",
"null"
]
},
"original_owner_answer": {
"description": "original text of the owner's response
the original response to the review, no auto-translate applied",
"type": [
"string",
"null"
]
},
"original_review_text": {
"description": "original content of the review
the original content of the review, no auto-translate applied",
"type": [
"string",
"null"
]
},
"owner_answer": {
"description": "text of the owner's response
the owner's response to the review",
"type": [
"string",
"null"
]
},
"owner_time_ago": {
"description": "publication time
indicates the time (in the 'time ago' format) when the owner submitted the response to the review",
"type": [
"string",
"null"
]
},
"owner_timestamp": {
"description": "date and time of the owner's reply to the review
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"photos_count": {
"description": "total number of photos submitted by the reviewer",
"format": "int64",
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the review in SERP
can take the following values: right",
"type": [
"string",
"null"
]
},
"profile_image_url": {
"description": "URL of the reviewer's profile image",
"type": [
"string",
"null"
]
},
"profile_name": {
"description": "profile name of the reviewer",
"type": [
"string",
"null"
]
},
"profile_url": {
"description": "URL of the reviewer's profile",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score submitted by the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"review_highlights": {
"description": "review highlights
contains highlighted review criteria and assessments",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ReviewHighlights"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"review_id": {
"description": "the unique identifier of a review on Google
example:ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE",
"type": [
"string",
"null"
]
},
"review_text": {
"description": "the content of the review",
"type": [
"string",
"null"
]
},
"review_url": {
"description": "the URL of the review",
"type": [
"string",
"null"
]
},
"reviews_count": {
"description": "total number of reviews submitted by the reviewer",
"format": "int64",
"type": [
"integer",
"null"
]
},
"source": {
"description": "source of the review
contains information about the source where the review was posted",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Source"
}
],
"type": [
"object",
"null"
]
},
"time_ago": {
"description": "the time of publication
indicates the time (in the 'time ago' format) when the review was listed",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when a review was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the review",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleFinanceEarningsCalendarElement": {
"properties": {
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the news article",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the page of the market index on Google Finance",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleFinanceFuturesChainElement": {
"properties": {
"expiration_timestamp": {
"description": "futures' date and time of expiration
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"percentage_delta": {
"description": "percentage of change in value of the market index",
"type": [
"number",
"null"
]
},
"price": {
"description": "price of the market instrument
price of the market instrument at a given timestamp",
"type": [
"number",
"null"
]
},
"price_currency": {
"description": "currency of the price value",
"type": [
"string",
"null"
]
},
"price_delta": {
"description": "change in price of the market instrument
change in price at a given timestamp",
"type": [
"number",
"null"
]
},
"symbol": {
"description": "futures' symbol",
"type": [
"string",
"null"
]
},
"trend": {
"description": "growth trend of the market index
possible values: up, down, stable",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleFinanceMarketTrendsElement": {
"properties": {
"news": {
"description": "array of items
array contains the following type of items: google_finance_news_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceNewsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"quote": {
"description": "object of items
array contains the following type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleFinanceMetricsBundleInfo": {
"properties": {
"cash_and_short_term_investments": {
"description": "cash and short-term investments value",
"type": [
"number",
"null"
]
},
"cash_and_short_term_investments_delta": {
"description": "change in cash and short-term investments",
"type": [
"number",
"null"
]
},
"cash_from_financing": {
"description": "cash from financing/em>",
"type": [
"number",
"null"
]
},
"cash_from_financing_delta": {
"description": "change in cash from financing",
"type": [
"number",
"null"
]
},
"cash_from_investing": {
"description": "cash from investing",
"type": [
"number",
"null"
]
},
"cash_from_investing_delta": {
"description": "change in cash from investing",
"type": [
"number",
"null"
]
},
"cash_from_operations": {
"description": "cash from operations",
"type": [
"number",
"null"
]
},
"cash_from_operations_delta": {
"description": "change in cash from operations",
"type": [
"number",
"null"
]
},
"earnings_per_share": {
"description": "earnings per share value",
"type": [
"number",
"null"
]
},
"earnings_per_share_delta": {
"description": "change in earnings per share",
"type": [
"number",
"null"
]
},
"ebitda": {
"description": "earnings before interest, taxes, deprecation, amortisation",
"type": [
"number",
"null"
]
},
"ebitda_delta": {
"description": "change in ebitda",
"type": [
"number",
"null"
]
},
"effective_tax_rate": {
"description": "effective tax rate value",
"type": [
"number",
"null"
]
},
"free_cash_flow": {
"description": "free cash flow value",
"type": [
"number",
"null"
]
},
"free_cash_flow_delta": {
"description": "change in free cash flow",
"type": [
"number",
"null"
]
},
"net_change_in_cash": {
"description": "net change in cash",
"type": [
"number",
"null"
]
},
"net_change_in_cash_delta": {
"description": "change in net change in cash",
"type": [
"number",
"null"
]
},
"net_income": {
"description": "net income value",
"type": [
"number",
"null"
]
},
"net_income_delta": {
"description": "change in net income",
"type": [
"number",
"null"
]
},
"net_profit_margin": {
"description": "net profit margin value",
"type": [
"number",
"null"
]
},
"net_profit_margin_delta": {
"description": "change in net profit margin",
"type": [
"number",
"null"
]
},
"operating_expense": {
"description": "operating expense value",
"type": [
"number",
"null"
]
},
"operating_expense_delta": {
"description": "change in operating expense",
"type": [
"number",
"null"
]
},
"price_to_book": {
"description": "price to book",
"type": [
"number",
"null"
]
},
"return_on_assets": {
"description": "return on assets",
"type": [
"number",
"null"
]
},
"return_on_capital": {
"description": "return on capital",
"type": [
"number",
"null"
]
},
"revenue": {
"description": "revenue value",
"type": [
"number",
"null"
]
},
"revenue_delta": {
"description": "change in revenue",
"type": [
"number",
"null"
]
},
"shares_outstanding": {
"description": "outstanding shares value",
"type": [
"number",
"null"
]
},
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"total_assets": {
"description": "total assets value",
"type": [
"number",
"null"
]
},
"total_assets_delta": {
"description": "change in total assets",
"type": [
"number",
"null"
]
},
"total_equity": {
"description": "total equity value",
"type": [
"number",
"null"
]
},
"total_liabilities": {
"description": "total liabilities value",
"type": [
"number",
"null"
]
},
"total_liabilities_delta": {
"description": "change in total liabilities",
"type": [
"number",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleFinanceNewsElement": {
"properties": {
"image_url": {
"description": "featured image URL
URL of the news article's featured image",
"type": [
"string",
"null"
]
},
"quotes": {
"description": "market indexes quoted in the news article
information about market indexes quoted in the google_finance_news_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"source": {
"description": "name of the news source
name of the website where the news article is published",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the news article",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the page of the market index on Google Finance",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleFlightsElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleFlightsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFlightsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleHotelsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"cid": {
"description": "google-defined client id",
"type": [
"string",
"null"
]
},
"hotel_identifier": {
"description": "unique hotel identifier
unique hotel identifier assigned by Google;
example: \"CgoIjaeSlI6CnNpVEAE\"",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleJobsItem": {
"properties": {
"contract_type": {
"description": "employment contract type",
"type": [
"string",
"null"
]
},
"employer_image_url": {
"description": "URL to the image used in the job posting",
"type": [
"string",
"null"
]
},
"employer_name": {
"description": "name of the employer",
"type": [
"string",
"null"
]
},
"employer_url": {
"description": "URL to the employer's website",
"type": [
"string",
"null"
]
},
"job_id": {
"description": "ID of the job on Google Jobs",
"type": [
"string",
"null"
]
},
"location": {
"description": "location for which the job vacancy is posted",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result's snippet in SERP;
in this case, will equal null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"salary": {
"description": "the salary indicated in the job vacancy
if the salary isn't indicated, this field will equal null",
"type": [
"string",
"null"
]
},
"source_name": {
"description": "original source of the job vacancy",
"type": [
"string",
"null"
]
},
"source_url": {
"description": "URL to the original source of the job vacancy",
"type": [
"string",
"null"
]
},
"time_ago": {
"description": "indicates how long ago the job vacancy was posted",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GooglePlayInfoOrganic": {
"properties": {
"app_id": {
"description": "ID of the app",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the app",
"type": [
"string",
"null"
]
},
"developer": {
"description": "name of the app developer",
"type": [
"string",
"null"
]
},
"developer_address": {
"description": "physical address of the developer",
"type": [
"string",
"null"
]
},
"developer_email": {
"description": "email address of the developer",
"type": [
"string",
"null"
]
},
"developer_id": {
"description": "ID of the app developer",
"type": [
"string",
"null"
]
},
"developer_url": {
"description": "URL to the developer page on Google Play",
"type": [
"string",
"null"
]
},
"developer_website": {
"description": "official website of the developer",
"type": [
"string",
"null"
]
},
"genres": {
"description": "app genres
contains relevant app categories",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"icon": {
"description": "URL to the app icon",
"type": [
"string",
"null"
]
},
"images": {
"description": "app images
contains URLs to the images published on the app page on Google Play",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"installs": {
"description": "number of installs of the app
approximate number of installs as displayed on the app page",
"type": [
"string",
"null"
]
},
"installs_count": {
"description": "number of installs of the app
the exact number of installs of the app",
"format": "int64",
"type": [
"integer",
"null"
]
},
"is_free": {
"description": "indicates whether the app is free",
"type": [
"boolean",
"null"
]
},
"last_update_date": {
"description": "date and time when the app was last updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"main_category": {
"description": "main category of the app",
"type": [
"string",
"null"
]
},
"minimum_os_version": {
"description": "minimum OS version required to install the app",
"type": [
"string",
"null"
]
},
"more_apps_by_developer": {
"description": "similar apps
information about apps built by the same developer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values: left",
"type": [
"string",
"null"
]
},
"price": {
"description": "price of the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed apps
absolute position among all apps on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "average rating of the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"released_date": {
"description": "date and time when the app was released
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews the app has",
"format": "int64",
"type": [
"integer",
"null"
]
},
"similar_apps": {
"description": "similar apps
displays apps similar to the app in a POST request",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"size": {
"description": "size of the app",
"type": [
"string",
"null"
]
},
"tags": {
"description": "app tags
contains relevant app tags",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the app",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"update_notes": {
"description": "update notes
contains the latest update notes from the developer",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the app page on Google Play",
"type": [
"string",
"null"
]
},
"version": {
"description": "current version of the app",
"type": [
"string",
"null"
]
},
"videos": {
"description": "app videos
contains URLs to the video published on the app page on Google Play",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GooglePlayRankedSerpElementInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"previous_updated_time": {
"description": "previous to the most recent date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-10-15 12:57:46 +00:00;
in this case, will equal null",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "number of search results for the returned keyword",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"serp_item": {
"description": "contains data on the SERP element
the list of supported SERP elements can be found below",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GooglePlaySearchOrganic"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GooglePlayReviewsSearch": {
"properties": {
"helpful_count": {
"description": "number of helpful votes
indicates how many users considered the review helpful and voted with the thumbs up icon",
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"description": "id of the review",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the review in SERP
can take the following values: left",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score submitted by the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"responses": {
"description": "response from the developer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ResponseDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"review_text": {
"description": "content of the review",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the review was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the review
Google Play doesn't provide an option to title reviews, so this parameter will always equal null",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"user_profile": {
"description": "user profile of the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppUserProfileInfo"
}
],
"type": [
"object",
"null"
]
},
"version": {
"description": "version of the app
version of the app for which the review is submitted",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GooglePlaySearchOrganic": {
"properties": {
"app_id": {
"description": "id of the app in a POST array",
"type": [
"string",
"null"
]
},
"developer": {
"description": "name of the app developer",
"type": [
"string",
"null"
]
},
"developer_url": {
"description": "URL to the developer page on Google Play",
"type": [
"string",
"null"
]
},
"icon": {
"description": "URL to the app icon",
"type": [
"string",
"null"
]
},
"is_free": {
"type": [
"boolean",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "average rating of the app",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews of the app",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the app",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the app page on Google Play",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GooglePostsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"cid": {
"description": "google-defined client id",
"type": [
"string",
"null"
]
},
"feature": {
"description": "the additional feature of the review",
"type": [
"string",
"null"
]
},
"posts_id": {
"description": "the identifier of the google_posts feature",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_GoogleReviewsSearch": {
"properties": {
"images": {
"description": "images submitted by the reviewer",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"local_guide": {
"description": "indicates whether the reviewer has a 'local guide' status",
"type": [
"boolean",
"null"
]
},
"original_language": {
"description": "original language of the review text",
"type": [
"string",
"null"
]
},
"original_owner_answer": {
"description": "original text of the owner's response
the original response to the review, no auto-translate applied",
"type": [
"string",
"null"
]
},
"original_review_text": {
"description": "original content of the review
the original content of the review, no auto-translate applied",
"type": [
"string",
"null"
]
},
"owner_answer": {
"description": "text of the owner's response
the owner's response to the review",
"type": [
"string",
"null"
]
},
"owner_time_ago": {
"description": "publication time
indicates the time (in the 'time ago' format) when the owner submitted the response to the review",
"type": [
"string",
"null"
]
},
"owner_timestamp": {
"description": "date and time of the owner's reply to the review
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"photos_count": {
"description": "total number of photos submitted by the reviewer",
"format": "int64",
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the review in SERP
can take the following values: right",
"type": [
"string",
"null"
]
},
"profile_image_url": {
"description": "URL of the reviewer's profile image",
"type": [
"string",
"null"
]
},
"profile_name": {
"description": "profile name of the reviewer",
"type": [
"string",
"null"
]
},
"profile_url": {
"description": "URL of the reviewer's profile",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score submitted by the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"review_highlights": {
"description": "review highlights
contains highlighted review criteria and assessments",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ReviewHighlights"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"review_id": {
"description": "the unique identifier of a review on Google
example:ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE",
"type": [
"string",
"null"
]
},
"review_text": {
"description": "the content of the review",
"type": [
"string",
"null"
]
},
"review_url": {
"description": "the URL of the review",
"type": [
"string",
"null"
]
},
"reviews_count": {
"description": "total number of reviews submitted by the reviewer",
"format": "int64",
"type": [
"integer",
"null"
]
},
"time_ago": {
"description": "the time of publication
indicates the time (in the 'time ago' format) when the review was listed",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when a review was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the review",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleReviewsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"cid": {
"description": "google-defined client id",
"type": [
"string",
"null"
]
},
"feature": {
"description": "the additional feature of the review",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "the identifier of a place",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleShoppingCarouselElement": {
"properties": {
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"data_docid": {
"description": "unique identifier of the SERP data element
note that there is no full list of possible values as the data_docid is a dynamic value assigned by Google
example:17363035694596624076",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"gid": {
"description": "global product identifier on Google Shopping
note that there is no full list of possible values as the gid is a dynamic value assigned by Google
if there are no values, you will get null
example:4702526954592161872
learn more about gid parameter in this help center guide",
"type": [
"string",
"null"
]
},
"price": {
"description": "product price
example:384.99",
"type": [
"number",
"null"
]
},
"product_id": {
"description": "unique product identifier on Google Shopping
note that there is no full list of possible values as the product_id is a dynamic value assigned by Google
if there are no values, you will get null
example:4485466949985702538
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"product_images": {
"description": "URLs to the images of the product
the first URL in the array is the featured image of the product",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"product_rating": {
"description": "product rating
the product popularity rate based on product reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"seller": {
"description": "name of the seller
the name of the company that placed a corresponding product on Google Shopping",
"type": [
"string",
"null"
]
},
"shopping_url": {
"description": "URL to the product page on Google Shopping",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "additional information about the result",
"type": [
"string",
"null"
]
},
"special_offer_info": {
"description": "special offer from the seller
information on the special offer from the seller, including discount and coupon info",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpecialOfferInfo"
}
],
"type": [
"object",
"null"
]
},
"tags": {
"description": "tags assigned to the product",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleShoppingCarouselElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingProductsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleShoppingCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the special offer",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleShoppingPaidElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingProductsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"description": {
"description": "description of the product in Google Shopping SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the URL
domain of the URL where a special offer is posted
Note: this field is deprecated and will return null",
"type": [
"string",
"null"
]
},
"shop_ad_aclk": {
"description": "unique ad click referral parameter
using this parameter you can get a URL of the advertisement in Google Shopping Sellers Ad URL",
"type": [
"string",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL pointing at special offer page
URL where a special offer is posted
Note: this field is deprecated and will return null",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleShoppingSellersBuyOnGoogleElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingSellersElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"rating": {
"description": "shop rating
the shop popularity rate based on product reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleShoppingSellersShopsListElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingSellersElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"displayed_payment_breakdown": {
"description": "installment details as displayed in the results
shows how the product price can be broken down into monthly payments, if applicable",
"type": [
"string",
"null"
]
},
"price_multiplier": {
"description": "monthly price multiplier
indicates the number of months covered by the monthly payment for the product",
"type": [
"integer",
"null"
]
},
"product_annotation": {
"description": "data from annotations and badges with special offers
if there is no annotation for this product, the value will be null
examples: LOW PRICE, SPECIAL OFFER, SALE, PRICE DROP",
"type": [
"string",
"null"
]
},
"product_availability": {
"description": "product availability information
product availability information
can take the following values: in_stock, limited_stock, out_of_stock, backordered, pre_order_available, on_display_to_order",
"type": [
"string",
"null"
]
},
"product_condition": {
"description": "indicated condition of the product
possible values: Used, Refurbished, New, Pre-owned, null",
"type": [
"string",
"null"
]
},
"rating": {
"description": "shop rating
the shop popularity rate based on product reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleShoppingSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingProductsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"additional_specifications": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "object containing additional url parameters
you can get more details about the product by using this object in the POST request to the Google Shopping Product Specification and Google Shopping Sellers endpoint",
"type": [
"object",
"null"
]
},
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"data_docid": {
"description": "unique identifier of the SERP data element
note that there is no full list of possible values as the data_docid is a dynamic value assigned by Google
example:17363035694596624076",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"description": {
"description": "description of the product in Google Shopping SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the URL
domain of the URL where a special offer is posted
Note: this field is deprecated and will return null",
"type": [
"string",
"null"
]
},
"gid": {
"description": "global product identifier on Google Shopping
note that there is no full list of possible values as the gid is a dynamic value assigned by Google
if there are no values, you will get null
example:4702526954592161872
learn more about gid parameter in this help center guide",
"type": [
"string",
"null"
]
},
"is_best_match": {
"description": "\"best match\" label
if the value is true, the product is marked with the \"best match\" label
if there are no values, you will get null",
"type": [
"boolean",
"null"
]
},
"old_price": {
"description": "product old price
displayed if the product price has been changed
example:499",
"type": [
"number",
"null"
]
},
"price": {
"description": "product price
example:384.99",
"type": [
"number",
"null"
]
},
"price_multiplier": {
"description": "price multiplier for instalment plan
indicates the number of months covered by the monthly payment for the product",
"type": [
"integer",
"null"
]
},
"product_id": {
"description": "unique product identifier on Google Shopping
note that there is no full list of possible values as the product_id is a dynamic value assigned by Google
if there are no values, you will get null
example:4485466949985702538
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"product_images": {
"description": "URLs to the images of the product
the first URL in the array is the featured image of the product",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"product_rating": {
"description": "product rating
the product popularity rate based on product reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "number of product reviews
indicates the number of reviews left by users on Google Shopping
if there are no values, you will get null",
"format": "int64",
"type": [
"integer",
"null"
]
},
"seller": {
"description": "name of the seller
the name of the company that placed a corresponding product on Google Shopping",
"type": [
"string",
"null"
]
},
"shop_ad_aclk": {
"description": "unique ad click referral parameter
using this parameter you can get a URL of the advertisement in Google Shopping Sellers Ad URL",
"type": [
"string",
"null"
]
},
"shop_rating": {
"description": "shop rating
the popularity rate of the seller based on user reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"shopping_url": {
"description": "URL to the product page on Google Shopping",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "additional information about the result",
"type": [
"string",
"null"
]
},
"stores_count_info": {
"description": "stores count information
contains information about the number of stores that offer the same product",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_StoresCountInfo"
}
],
"type": [
"object",
"null"
]
},
"tags": {
"description": "tags assigned to the product",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL pointing at special offer page
URL where a special offer is posted
Note: this field is deprecated and will return null",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleShoppingSponsoredCarouselElement": {
"properties": {
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"price": {
"description": "product price
example:384.99",
"type": [
"number",
"null"
]
},
"product_images": {
"description": "URLs to the images of the product
the first URL in the array is the featured image of the product",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"product_rating": {
"description": "product rating
the product popularity rate based on product reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"seller": {
"description": "name of the seller
the name of the company that placed a corresponding product on Google Shopping",
"type": [
"string",
"null"
]
},
"shop_ad_aclk": {
"description": "unique ad click referral parameter
using this parameter you can get a URL of the advertisement in Google Shopping Sellers Ad URL",
"type": [
"string",
"null"
]
},
"special_offer_info": {
"description": "special offer from the seller
information on the special offer from the seller, including discount and coupon info",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpecialOfferInfo"
}
],
"type": [
"object",
"null"
]
},
"tags": {
"description": "tags assigned to the product",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GoogleShoppingSponsoredCarouselElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingProductsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleShoppingSponsoredCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the special offer",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleTrendsGoogleTrendsGraphElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataGoogleTrendsItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"averages": {
"items": {
"format": "double",
"type": [
"number",
"null"
]
},
"type": "array"
},
"data": {
"description": "Google Trends data for the specified parameters",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TrendsGraphDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleTrendsGoogleTrendsMapElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataGoogleTrendsItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data": {
"description": "Google Trends data from the corresponding item",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TrendsMapDataInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleTrendsGoogleTrendsQueriesListElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataGoogleTrendsItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data": {
"description": "Google Trends data from the corresponding item",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ListDataInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GoogleTrendsGoogleTrendsTopicsListElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataGoogleTrendsItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data": {
"description": "Google Trends data from the corresponding item",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ListDataInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_GpsCoordinatesLocationInfo": {
"properties": {
"latitude": {
"description": "latitude coordinate of the hotel in google maps
example:\"latitude\": 51.584091",
"type": [
"number",
"null"
]
},
"longitude": {
"description": "longitude coordinate of the hotel in google maps
example:\"longitude\": -0.31365919999999997",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Graph": {
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GraphElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"previous_items": {
"description": "previous close data
contains stock price data based on the preceding time period",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GraphElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GraphElement": {
"properties": {
"date": {
"description": "date when the video was published or indexed
example: Apr 26, 2024",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"value": {
"description": "the value of the rating",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_GraphItems": {
"properties": {
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"value": {
"description": "point value on graph",
"type": [
"number",
"null"
]
},
"volume": {
"description": "volume value on graph",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Groups": {
"properties": {
"categories": {
"description": "technology categories in this group",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TechnologyCategoryInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"id": {
"description": "id of the technology group
example:marketing, sales",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the technology group",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HistoricalMetricsBundleInfo": {
"properties": {
"featured_snippet": {
"description": "traffic data from the featured snippet results in Google SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HistoricalMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"local_pack": {
"description": "traffic data from the local pack results in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HistoricalMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"organic": {
"description": "traffic data from organic search",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HistoricalMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"paid": {
"description": "traffic data from paid search",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HistoricalMetricsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HistoricalMetricsInfo": {
"properties": {
"count": {
"description": "total count of organic SERPs that contain the domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"etv": {
"description": "estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"month": {
"description": "month for which the data is provided",
"type": [
"integer",
"null"
]
},
"year": {
"description": "year for which the data is provided",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_History": {
"properties": {
"keyword_info": {
"description": "historical data for the keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"month": {
"description": "month",
"type": [
"integer",
"null"
]
},
"year": {
"description": "year",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelAboutInfo": {
"properties": {
"amenities": {
"description": "hotel amenities
information about hotel amenities",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelAmenityInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"check_in_time": {
"description": "hotel check-in time
check-in time indicated in the hotel listing",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TimeInfo"
}
],
"type": [
"object",
"null"
]
},
"check_out_time": {
"description": "hotel check-out time
check-out time indicated in the hotel listing",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TimeInfo"
}
],
"type": [
"object",
"null"
]
},
"description": {
"description": "description of the hotel
the description of the hotel entity for which the results are collected",
"type": [
"string",
"null"
]
},
"domain": {
"description": "hotel domain
domain of the hotel's website",
"type": [
"string",
"null"
]
},
"full_address": {
"description": "full address of the hotel
address of the hotel indicated in the standardised format",
"type": [
"string",
"null"
]
},
"popular_amenities": {
"description": "hotel amenities
information about hotel amenities labelled as \"popular\"",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelAmenityItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sub_descriptions": {
"description": "additional description of the hotel
details about the hotel provided in addition to the description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"url": {
"description": "hotel url
URL to the hotel's website indicated in the listing",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelAmenityInfo": {
"properties": {
"category": {
"description": "standardised category of the ammenity",
"type": [
"string",
"null"
]
},
"category_label": {
"description": "label of the category",
"type": [
"string",
"null"
]
},
"items": {
"description": "specific amenities and details",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelAmenityItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelAmenityItemInfo": {
"properties": {
"amenity": {
"description": "standardised amenity name",
"type": [
"string",
"null"
]
},
"amenity_label": {
"description": "displayed amenity name",
"type": [
"string",
"null"
]
},
"hint": {
"description": "standardised details about the amenity",
"type": [
"string",
"null"
]
},
"hint_label": {
"description": "displayed details about the amenity",
"type": [
"string",
"null"
]
},
"is_available": {
"description": "indicates whether the amenity is available in the hotel",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelInfoPriceOffer": {
"description": "featured price offers",
"properties": {
"currency": {
"description": "price currencyUSD is applied by default, unless specified in the POST array",
"type": [
"string",
"null"
]
},
"free_cancellation_until": {
"description": "date until free cancellation is available\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nequals null if free cancellation is not available for the selected dates",
"type": [
"string",
"null"
]
},
"max_visitors": {
"description": "the maximal number of visitors\nthe maximum number of visitors for which the price offer is valid",
"type": [
"integer",
"null"
]
},
"offer_images": {
"description": "price offer images\nURLs of the images featured in the price offer",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"price": {
"description": "price per night",
"type": [
"number",
"null"
]
},
"title": {
"description": "title of the hotel",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "url of the price offer\nURL to the page of the website where price offer appears",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelLocationInfo": {
"properties": {
"latitude": {
"description": "hotel latitude
latitude coordinates of the hotel's location
example:39.4806397",
"type": [
"number",
"null"
]
},
"location_chain": {
"description": "elements of the location chain
additional parameters of each element of the location chain",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LocationChain"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"longitude": {
"description": "hotel longitude
latitude coordinates of the hotel's location
example:-106.0512973",
"type": [
"number",
"null"
]
},
"maps_url": {
"description": "url to the location of the hotel in google maps",
"type": [
"string",
"null"
]
},
"neighborhood": {
"description": "name of the neighborhood where the hotel is located",
"type": [
"string",
"null"
]
},
"neighborhood_description": {
"description": "description of the neighborhood where the hotel is located",
"type": [
"string",
"null"
]
},
"overall_score": {
"description": "overall score of the hotel location
indicates the overall score of the hotel's location in the range from 1 to 5;
calculated based on data from the hotel's proximity to nearby things to do and restaurants, transportation, and airports;
note that the criteria are not weighted equally in the overall score",
"type": [
"number",
"null"
]
},
"score_by_categories": {
"additionalProperties": {
"format": "double",
"type": [
"number",
"null"
]
},
"description": "category scores of the hotel location
the scores of the hotel's location tied to the categories that indicate the proximity to nearby things to do, restaurants, transportation, and airports;",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelPriceInfo": {
"properties": {
"check_in": {
"description": "check-in date and time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"check_out": {
"description": "check-out date and time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"currency": {
"description": "price currencyUSD is applied by default, unless specified in the POST array",
"type": [
"string",
"null"
]
},
"discount_text": {
"description": "text about a discount applied",
"type": [
"string",
"null"
]
},
"items": {
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: hotel_search_item",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelPriceItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"price": {
"description": "price per night",
"type": [
"number",
"null"
]
},
"price_without_discount": {
"description": "full price per night without a discount applied",
"format": "int64",
"type": [
"number",
"null"
]
},
"prices_by_dates": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PricesByDates"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"visitors": {
"description": "number of hotel visitors for this price",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelPriceItemInfo": {
"properties": {
"currency": {
"description": "price currencyUSD is applied by default, unless specified in the POST array",
"type": [
"string",
"null"
]
},
"domain": {
"description": "third-party domain\ndomain of the third-party website page with pricing information",
"type": [
"string",
"null"
]
},
"free_cancellation_until": {
"description": "date until which free cancellation is available\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nequals null if free cancellation is not available for the selected dates",
"type": [
"string",
"null"
]
},
"is_paid": {
"description": "indicates a paid hotel listing
if true, related hotel_search_item is a paid ad
if false, related hotel_search_item is an organic hotel listing",
"type": [
"boolean",
"null"
]
},
"offers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelInfoPriceOffer"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"official_site": {
"type": [
"boolean",
"null"
]
},
"price": {
"description": "price per night",
"type": [
"number",
"null"
]
},
"title": {
"description": "title of the hotel",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "third-party page url\nURL to the third-party website page with pricing information",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelReviewInfo": {
"properties": {
"mentions": {
"description": "hotel mentions
information about hotel reviews by criteria",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ReviewMentionInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"other_sites_reviews": {
"description": "reviews on third-party sites
reviews from third-party sites",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OtherSitesReviewsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rating_distribution": {
"additionalProperties": {
"format": "Int64",
"type": [
"integer",
"null"
]
},
"description": "rating distribution by votes
the distribution of votes across the rating in the range from 1 to 5",
"type": [
"object",
"null"
]
},
"value": {
"description": "overall hotel rating based on customer votes",
"type": [
"number",
"null"
]
},
"votes_count": {
"description": "number of customer votes
the number of customer votes included in the calculation of the hotel rating",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelsPackElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"hotel_identifier": {
"description": "unique hotel identifier
unique hotel identifier assigned by Google;
example: \"CgoIjaeSlI6CnNpVEAE\"",
"type": [
"string",
"null"
]
},
"is_paid": {
"description": "indicates whether the element is an ad",
"type": [
"boolean",
"null"
]
},
"price": {
"description": "price indicated in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HotelsPackSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"date_from": {
"description": "starting date of stay
in the format \"year-month-date\"
example:
2019-11-15",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of stay
in the format \"year-month-date\"
example:
2019-11-17",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HotelsPackElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_HtmlContentInfo": {
"properties": {
"automated_readability_index": {
"description": "自动可读性指数",
"type": [
"number",
"null"
]
},
"coleman_liau_readability_index": {
"description": "Coleman–Liau 指数",
"type": [
"number",
"null"
]
},
"dale_chall_readability_index": {
"description": "Dale–Chall 可读性指数",
"type": [
"number",
"null"
]
},
"description_to_content_consistency": {
"description": "consistency of the meta description tag with the page contentmeasured from 0 to 1",
"type": [
"number",
"null"
]
},
"flesch_kincaid_readability_index": {
"description": "Flesch–Kincaid 可读性指数",
"type": [
"number",
"null"
]
},
"meta_keywords_to_content_consistency": {
"description": "consistency of meta keywordstag with the page contentmeasured from 0 to 1",
"type": [
"number",
"null"
]
},
"plain_text_rate": {
"description": "plaintext rate value\nplain_text_size to size ratio",
"format": "double",
"type": [
"number",
"null"
]
},
"plain_text_size": {
"description": "页面文本的总大小，以字节为单位",
"type": [
"integer",
"null"
]
},
"plain_text_word_count": {
"description": "页面上的字数",
"type": [
"integer",
"null"
]
},
"smog_readability_index": {
"description": "SMOG 可读性指数",
"type": [
"number",
"null"
]
},
"title_to_content_consistency": {
"description": "consistency of the meta title tag with the page contentmeasured from 0 to 1",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HtmlItemInfo": {
"properties": {
"date": {
"description": "date and time when the HTML page was scanned
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"html": {
"description": "HTML page",
"type": [
"string",
"null"
]
},
"page": {
"description": "serial number of the returned HTML page",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HunspellInfo": {
"properties": {
"hunspell_language_code": {
"description": "拼写检查语言代码",
"type": [
"string",
"null"
]
},
"misspelled": {
"description": "拼写错误的单词数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HunspellMisspelledInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_HunspellMisspelledInfo": {
"properties": {
"word": {
"description": "拼写错误的单词",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ImageUrlInfo": {
"properties": {
"url": {
"description": "URL of the image used in the review",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ImagesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"related_image_searches": {
"deprecated": true,
"description": "contains keywords and images related to the specified search term
Note: this array is deprecated and always returns null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedImageSearchesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_IndexHistory": {
"properties": {
"date": {
"description": "date for which index volume data is provided
in the UTC format: \"yyyy-mm-dd\"
example:2021-10-01",
"type": [
"string",
"null"
]
},
"total_backlinks": {
"description": "total number of backlinks our database contained on the given date",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_pages": {
"description": "total number of pages our database contained on the given date",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_InterestsComparison": {
"properties": {
"absolute_items": {
"description": "keyword popularity rates across all locations
values in this array represent percentages relative to the maximum value across all locations",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AbsoluteItems"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "contains keyword popularity and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AbsoluteItems"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_IntersectionSummaryInfo": {
"properties": {
"intersections_count": {
"description": "total number of intersections",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_JobsElement": {
"properties": {
"author": {
"description": "author",
"type": [
"string",
"null"
]
},
"contract_type": {
"description": "contract type",
"type": [
"string",
"null"
]
},
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"job_posted_time": {
"description": "the time when the job was posted",
"type": [
"string",
"null"
]
},
"location": {
"description": "location for which the job vacancy is posted",
"type": [
"string",
"null"
]
},
"salary": {
"description": "salary",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_JobsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_JobsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordDataInfo": {
"properties": {
"avg_backlinks_info": {
"description": "backlink data for the returned keyword
this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvgBacklinksInfo"
}
],
"type": [
"object",
"null"
]
},
"clickstream_keyword_info": {
"description": "clickstream data for the returned keyword
to retrieve results for this field, the parameter include_clickstream_data must be set to true",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ClickstreamKeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword": {
"description": "returned keyword idea",
"type": [
"string",
"null"
]
},
"keyword_info": {
"description": "keyword data for the returned keyword idea",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_info_normalized_with_bing": {
"description": "contains keyword search volume normalized with Bing search volume",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfoNormalizedWithInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_info_normalized_with_clickstream": {
"description": "contains keyword search volume normalized with clickstream data
",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordInfoNormalizedWithInfo"
}
],
"type": [
"object",
"null"
]
},
"keyword_properties": {
"description": "additional information about the keyword",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordProperties"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"search_intent_info": {
"description": "search intent info for the returned keyword
learn about search intent in this help center article",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchIntentInfo"
}
],
"type": [
"object",
"null"
]
},
"serp_info": {
"description": "SERP data
the value will be null if you didn't set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordInfo": {
"properties": {
"categories": {
"description": "product and service categories
you can download the full list of possible categories",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive)",
"type": [
"number",
"null"
]
},
"competition_level": {
"description": "competition level
represents the relative level of competition associated with the given keyword in paid SERP only;
possible values: LOW, MEDIUM, HIGH
if competition level is unknown, the value is null;
learn more about the metric in this help center article",
"type": [
"string",
"null"
]
},
"cpc": {
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword",
"type": [
"number",
"null"
]
},
"high_top_of_page_bid": {
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"low_top_of_page_bid": {
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"search_volume": {
"description": "average monthly search volume rate
represents the (approximate) number of searches for the given keyword idea on google.com",
"format": "int64",
"type": [
"integer",
"null"
]
},
"search_volume_trend": {
"description": "search volume trend changes
represents search volume change in percent compared to the previous period",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchVolumeTrend"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordInfoNormalizedWithInfo": {
"properties": {
"is_normalized": {
"description": "keyword info is normalized\nif true, values are normalized with Bing data",
"type": [
"boolean",
"null"
]
},
"last_updated_time": {
"description": "date and time when the dataset was updated\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:\n2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"monthly_searches": {
"description": "monthly search volume rates\narray of objects with search volume rates in a certain month of a year",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_volume": {
"description": "关键词的当前搜索量比率",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordIntentInfo": {
"properties": {
"label": {
"description": "search intent name
possible values: informational, navigational, commercial, transactional",
"type": [
"string",
"null"
]
},
"probability": {
"description": "search intent probability1 indicates the highest probability",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordKpi": {
"properties": {
"desktop": {
"description": "keyword data aggregated for desktop devices
if there is no data, then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordKpiItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"mobile": {
"description": "keyword data aggregated for mobile devices
if there is no data, then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordKpiItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tablet": {
"description": "keyword data aggregated for tablet devices
if there is no data, then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordKpiItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordKpiItemInfo": {
"properties": {
"ad_position": {
"description": "represents the position of the relevant ad in SERP
can take the following values:FirstPage1: The first ad to appear on the right side of the first search results pageFirstPage2: The second ad to appear on the right side of the first search results pageFirstPage3: The third ad to appear on the right side of the first search results pageFirstPage4: The fourth ad to appear on the right side of the first search results pageFirstPage5: The fifth ad to appear on the right side of the first search results pageFirstPage6: The sixth ad to appear on the right side of the first search results pageFirstPage7: The seventh ad to appear on the right side of the first search results pageFirstPage8: The eighth ad to appear on the right side of the first search results pageFirstPage9: The ninth ad to appear on the right side of the first search results pageFirstPage10: The tenth ad to appear on the right side of the first search results pageMainLine1: The first ad to appear at the top of the search results pageMainLine2: The second ad to appear at the top of the search results pageMainLine3: The third ad to appear at the top of the search results pageMainLine4: The fourth ad to appear at the top of the search results page",
"type": [
"string",
"null"
]
},
"average_bid": {
"description": "average bid of the keyword",
"format": "double",
"type": [
"number",
"null"
]
},
"average_cpc": {
"description": "average cost per click, USD
calculated by dividing the cost of all clicks by the number of clicks",
"format": "double",
"type": [
"number",
"null"
]
},
"clicks": {
"description": "ad clicks
the number of clicks that the keyword and match type generated during the last month",
"type": [
"integer",
"null"
]
},
"ctr": {
"description": "click-through rate as a percentage
calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100",
"format": "double",
"type": [
"number",
"null"
]
},
"impressions": {
"description": "ad impressions
the number of impressions that the keyword and match type generated during the last month",
"type": [
"integer",
"null"
]
},
"total_cost": {
"description": "total cost of an ad, USD
the cost of using the specified keyword and match type during the last month",
"format": "int64",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordProperties": {
"properties": {
"core_keyword": {
"description": "main keyword in a group
contains the main keyword in a group determined by the synonym clustering algorithm
if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword",
"type": [
"string",
"null"
]
},
"detected_language": {
"description": "detected language of the keyword
indicates the language of the keyword as identified by our system",
"type": [
"string",
"null"
]
},
"is_another_language": {
"description": "detected language of the keyword is different from the set language
if true, the language set in the request does not match the language determined by our system for a given keyword",
"type": [
"boolean",
"null"
]
},
"keyword_difficulty": {
"description": "difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
learn more about the metric in this help center guide",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"synonym_clustering_algorithm": {
"description": "the algorithm used to identify synonyms
possible values:keyword_metrics - indicates the algorithm based on keyword_info parameterstext_processing - indicates the text-based algorithm
if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword",
"type": [
"string",
"null"
]
},
"words_count": {
"description": "number of words in the keyword
indicates how many words the keyword consists of",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationIndustriesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationIndustriesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationIndustriesResultInfo": {
"properties": {
"industry_id": {
"description": "ID of the industry",
"format": "int64",
"type": [
"integer",
"null"
]
},
"industry_name": {
"description": "name of the industry",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationIndustriesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationIndustriesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationJobFunctionsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationJobFunctionsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationJobFunctionsResultInfo": {
"properties": {
"job_function_id": {
"description": "ID of the job function",
"format": "int64",
"type": [
"integer",
"null"
]
},
"job_function_name": {
"description": "name of the job function",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationJobFunctionsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationJobFunctionsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationLiveResultInfo": {
"properties": {
"currency": {
"description": "currency nameUSDollar",
"type": [
"string",
"null"
]
},
"est_audience_size": {
"description": "monthly estimated reach user count range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_clicks": {
"description": "monthly estimated click count range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_cost_per_event": {
"description": "indicates the estimated cost per event with range result",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_ctr": {
"description": "estimated click-through rate range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_impressions": {
"description": "monthly estimated impressions range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_reach_audience_size": {
"description": "monthly estimated user count",
"format": "int64",
"type": [
"integer",
"null"
]
},
"est_reach_impressions": {
"description": "monthly estimated impressions",
"format": "int64",
"type": [
"integer",
"null"
]
},
"est_spend": {
"description": "monthly estimated spending range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"events_lost_to_bid": {
"description": "indicates event lost count due to insufficient input bid",
"format": "int64",
"type": [
"integer",
"null"
]
},
"events_lost_to_budget": {
"description": "indicates the event lost count due to insufficient input budget",
"type": [
"integer",
"null"
]
},
"suggested_bid": {
"description": "suggested bid value under the current targeting",
"type": [
"number",
"null"
]
},
"suggested_budget": {
"description": "suggested daily budget value under the current targeting and bid",
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskGetResultInfo": {
"properties": {
"currency": {
"description": "currency nameUSDollar",
"type": [
"string",
"null"
]
},
"est_audience_size": {
"description": "monthly estimated reach user count range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_clicks": {
"description": "monthly estimated click count range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_cost_per_event": {
"description": "indicates the estimated cost per event with range result",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_ctr": {
"description": "estimated click-through rate range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_impressions": {
"description": "monthly estimated impressions range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"est_reach_audience_size": {
"description": "monthly estimated user count",
"format": "int64",
"type": [
"integer",
"null"
]
},
"est_reach_impressions": {
"description": "monthly estimated impressions",
"format": "int64",
"type": [
"integer",
"null"
]
},
"est_spend": {
"description": "monthly estimated spending range",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AudienceEstimationInfo"
}
],
"type": [
"object",
"null"
]
},
"events_lost_to_bid": {
"description": "indicates event lost count due to insufficient input bid",
"format": "int64",
"type": [
"integer",
"null"
]
},
"events_lost_to_budget": {
"description": "indicates the event lost count due to insufficient input budget",
"type": [
"integer",
"null"
]
},
"suggested_bid": {
"description": "suggested bid value under the current targeting",
"type": [
"number",
"null"
]
},
"suggested_budget": {
"description": "suggested daily budget value under the current targeting and bid",
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint": {
"description": "URL for collecting the results of the task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingAudienceEstimationTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingAudienceEstimationTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordPerformanceLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceLiveResultInfo": {
"properties": {
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"keyword_kpi": {
"description": "object containing keyword metrics
if there is no data, then the value is_nulln",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordKpi"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"month": {
"description": "indicates the month for which the data is provided for
example:10",
"type": [
"integer",
"null"
]
},
"year": {
"description": "indicates the year for which the data is provided for
example:2020",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordPerformanceLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordPerformanceLocationsAndLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResultInfo": {
"properties": {
"available_locations": {
"description": "supported locations
contains locations supported in combination with a specific language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvailableLocations"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceLocationsAndLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskGetResultInfo": {
"properties": {
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"keyword_kpi": {
"description": "object containing keyword metrics
if there is no data, then the value is_nulln",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordKpi"
}
],
"type": [
"object",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"month": {
"type": [
"integer",
"null"
]
},
"year": {
"description": "indicates the year for which the data is provided for
example:2020monthn",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordPerformanceTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsLiveResultInfo": {
"properties": {
"categories": {
"description": "product and service categories
legacy field, the value will always be null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.
Possible values: 0.1, 0.5,0.90.1 - low competition,0.5 - medium competition,0.9 - high competition;
if there is no data the value is null",
"type": [
"number",
"null"
]
},
"cpc": {
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data, then the value is_nulln",
"type": [
"number",
"null"
]
},
"device": {
"description": "device type
indicates for what device type the data is provided;
possible values: all, mobile, desktop, tablet",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.
if there is no data, then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks is included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingsearch volume is rounded to the closest decimal valuesnulln",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskGetResultInfo": {
"properties": {
"categories": {
"description": "product and service categories
legacy field, the value will always be null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.
Possible values: 0.1, 0.5,0.9 0.1 - low competition,0.5 - medium competition, 0.9 - high competition;
if there is no data the value is null",
"type": [
"number",
"null"
]
},
"cpc": {
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data, then the value is_nulln",
"type": [
"number",
"null"
]
},
"device": {
"description": "device type
indicates for what device type the data is provided;
possible values: all, mobile, desktop, tablet",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"type": [
"string",
"null"
]
},
"location_code": {
"type": [
"integer",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.
if there is no data, then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingnulln",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForKeywordsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForSiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteLiveResultInfo": {
"properties": {
"categories": {
"description": "product and service categories
legacy field, the value will always be null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.
Possible values: 0.1, 0.5,0.90.1 - low competition,0.5 - medium competition,0.9 - high competition;
if there is no data the value is null",
"type": [
"number",
"null"
]
},
"cpc": {
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data, then the value is_nulln",
"type": [
"number",
"null"
]
},
"device": {
"description": "device type in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.
if there is no data, then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingsearch volume is rounded to the closest decimal valuesif there is no data, then the value is_nulln",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForSiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskGetResultInfo": {
"properties": {
"categories": {
"description": "product and service categories
legacy field, the value will always be null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.
Possible values: 0.1, 0.5,0.9 0.1 - low competition,0.5 - medium competition, 0.9 - high competition;
if there is no data the value is null",
"type": [
"number",
"null"
]
},
"cpc": {
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data the value is null",
"type": [
"number",
"null"
]
},
"device": {
"description": "device type in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data the value is null",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data the value is null",
"type": [
"integer",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locationsnull",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the given keyword idea on Bing search engine depending on the user’s targeting
if there is no data then the value is_nulln",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingKeywordsForSiteTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:\"location_code\": 9041134,where
\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",
\"location_code_parent\": 20044location_code_parent corresponds to:\"location_code\": 20044,",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLiveResultInfo": {
"properties": {
"device": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
\"location_name\": \"Lower Austria,Austria\"
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"period": {
"description": "time period
indicates if returned data is aggregated to a certain time period
default value monthly",
"type": [
"string",
"null"
]
},
"searches": {
"description": "contains results distributed by device type
if the device parameter is not specified, the data will be returned for all available device types",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchVolumeHistorySearchInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo": {
"properties": {
"available_locations": {
"description": "array of available locations for a certain language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvailableLocations"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo": {
"properties": {
"device": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"period": {
"type": [
"string",
"null"
]
},
"searches": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchVolumeHistorySearchInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeLiveResultInfo": {
"properties": {
"categories": {
"description": "product and service categories
our API doesn't return categories for this endpoint: the parameter will always equal null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.
Possible values: 0.1, 0.5,0.90.1 - low competition,0.5 - medium competition,0.9 - high competition;
if there is no data the value is null",
"type": [
"number",
"null"
]
},
"cpc": {
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data then the value is_nulln",
"type": [
"number",
"null"
]
},
"device": {
"description": "device type in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents either the (approximate) number of searches for the given keyword idea on bing search engine depending on the user’s targeting;
search volume is rounded to the nearest tens;
if there is no data, the value is_nulln",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeTaskGetResultInfo": {
"properties": {
"categories": {
"description": "product and service categories
our API doesn't return categories for this endpoint: the parameter will always equal null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.
Possible values: 0.1, 0.5,0.9 0.1 - low competition,0.5 - medium competition, 0.9 - high competition;
if there is no data the value is null",
"type": [
"number",
"null"
]
},
"cpc": {
"description": "cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data then the value is_nulln",
"type": [
"number",
"null"
]
},
"device": {
"description": "device type in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
search volume is rounded to the nearest tens",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataBingSearchVolumeTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataBingSearchVolumeTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataBulkSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataSearchVolumeLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo": {
"properties": {
"items": {
"description": "array of keywords
contains keywords and their search volume rates",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataSearchVolumeLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "ithe number of results returned in the items array",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array
Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;
we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is null",
"type": [
"integer",
"null"
]
},
"use_clickstream": {
"description": "indicates if the use_clickstream parameter is active
possible values: true, false",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem": {
"properties": {
"country_distribution": {
"description": "distribution of clickstream by countries
represents clickstream-based search volume in available countries, as well as its respective percentage of global search volume",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CountryDistribution"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"keyword": {
"description": "keyword
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"search_volume": {
"description": "clickstream-based average monthly search volume rate
represents the (approximate) number of searches for the given keyword idea based on clickstream
you can learn more about clickstream search volume in this Help Center article",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveResultInfo": {
"properties": {
"items": {
"description": "contains keywords and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataGlobalSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataLocationsAndLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataLocationsAndLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataLocationsAndLanguagesResultInfo": {
"properties": {
"available_languages": {
"description": "supported languages
contains the languages which are supported for a specific location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvailableLanguages"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
the value will be null as Country is the only supported location_type for this API",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
possible values:Country",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataLocationsAndLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataClickstreamDataLocationsAndLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataClickstreamDataSearchVolumeLiveItem": {
"properties": {
"keyword": {
"description": "keyword provided in the POST array",
"type": [
"string",
"null"
]
},
"monthly_searches": {
"description": "monthly search volume rates
array of objects with search volume rates in a certain month of a year",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_volume": {
"description": "current search volume rate of a keyword",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsDemographyLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsDemographyLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsDemographyLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains keyword popularity and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsDemographyElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keywords": {
"description": "keywords in a POST array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsDemographyLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsDemographyLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsExploreLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsExploreLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsExploreLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains keyword popularity and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsDataforseoTrendsGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keywords": {
"description": "keywords in a POST array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsExploreLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsExploreLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"geo_id": {
"description": "DataForSEO trends location identifier
you can use this field for matching obtained results with the location_code parameter specified in the request",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:\"location_code\": 9041134,
\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",
\"location_code_parent\": 20044
where location_code_parent corresponds to:\"location_code\": 20044,",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
\"location_name\": \"Lower Austria,Austria\"
possible values according to Google’s target types",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsMergedDataLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsMergedDataLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsMergedDataLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains keyword popularity and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataDataforseoTrendsItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keywords": {
"description": "keywords in a POST array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsMergedDataLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsMergedDataLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains keyword popularity and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DataforseoTrendsSubregionInterestsElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keywords": {
"description": "keywords in a POST array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResultInfo": {
"properties": {
"average_cpc": {
"description": "the average cost-per-click value
represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;
if there is no data, then the value is_nulln",
"format": "double",
"type": [
"number",
"null"
]
},
"bid": {
"description": "the maximum custom bid
the bid you have specified when setting the task
represents the price you are willing to pay for an ad
the higher value you have specified, the higher metrics and cost you receive in response
learn more in this help center article",
"format": "int64",
"type": [
"number",
"null"
]
},
"clicks": {
"description": "number of clicks on an ad
number of clicks an ad is projected to get within the specified time period
if there is no data, then the value is_nulln",
"type": [
"number",
"null"
]
},
"cost": {
"description": "total tasks cost, USD",
"type": [
"number",
"null"
]
},
"ctr": {
"description": "projected click through rate (CTR) of the advertisement
number of clicks an ad is projected to receive divided by the number of ad impressions; the CTR is projected for the specified time period
Note: parameter deprecated, the value is always null",
"format": "double",
"type": [
"number",
"null"
]
},
"date_interval": {
"description": "forecasting date interval in a POST array",
"type": [
"string",
"null"
]
},
"impressions": {
"description": "projected number of ad impressions
number of impressions an ad is projected to get within the specified time period
Note: parameter deprecated, the value is always null",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"match": {
"description": "keywords match-type
can take the following values: exact, broad, phrase",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners
the value you specified when setting the task
Note: parameter deprecated, the value is always false",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResultInfo": {
"properties": {
"average_cpc": {
"description": "the average cost-per-click value
represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;
if there is no data, then the value is_nulln",
"format": "double",
"type": [
"number",
"null"
]
},
"bid": {
"description": "the maximum custom bid
the bid you have specified when setting the task
represents the price you are willing to pay for an ad
the higher value you have specified, the higher metrics and cost you receive in response
learn more in this help center article",
"type": [
"number",
"null"
]
},
"clicks": {
"description": "number of clicks on an ad
number of clicks an ad is projected to get within the specified time period
if there is no data, then the value is_nulln",
"type": [
"number",
"null"
]
},
"cost": {
"description": "charge for an ad
amount that will be charged for running an ad within the specified time period
if there is no data, then the value is_nulln",
"type": [
"number",
"null"
]
},
"ctr": {
"description": "projected clickthrough rate (CTR) of the advertisement
number of clicks an ad is projected to receive divided by the number of ad impressions;
Note: parameter deprecated, the value is always null",
"format": "double",
"type": [
"number",
"null"
]
},
"date_interval": {
"description": "forecasting date interval in a POST array",
"type": [
"string",
"null"
]
},
"impressions": {
"description": "projected number of ad impressions
number of impressions an ad is projected to get within the specified time period
Note: parameter deprecated, the value is always_nulln",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword in a POST array
metrics are provided for all the keywords specified in the POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"match": {
"description": "keywords match-type
can take the following values: exact, broad, phrase",
"type": [
"string",
"null"
]
},
"search_partners": {
"description": "include Google search partners
the value is always false",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsLiveResultInfo": {
"properties": {
"competition": {
"description": "competition
represents the relative level of competition associated with the given keyword in paid SERP only
possible values: LOW, MEDIUM, HIGH
if competition level is unknown, the value is null;
learn more about the metric in this help center article",
"type": [
"string",
"null"
]
},
"competition_index": {
"description": "competition index
the competition index for the query indicating how competitive ad placement is for the keyword
can take values from 0 to 100
the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available
if not enough data is available, the value is null;
learn more about the metric in this help center article",
"type": [
"integer",
"null"
]
},
"cpc": {
"description": "cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword",
"type": [
"number",
"null"
]
},
"high_top_of_page_bid": {
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, the value is_nulln",
"type": [
"integer",
"null"
]
},
"low_top_of_page_bid": {
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data, the value is null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "include Google search partners
the value you specified when setting the task
if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
if false, the results are returned for Google search sites only",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting
if there is no data, the value is null",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResultInfo": {
"properties": {
"competition": {
"description": "competition
represents the relative level of competition associated with the given keyword in paid SERP only
possible values: LOW, MEDIUM, HIGH
if competition level is unknown, the value is null;
learn more about the metric in this help center article",
"type": [
"string",
"null"
]
},
"competition_index": {
"description": "competition index
the competition index for the query indicating how competitive ad placement is for the keyword
can take values from 0 to 100
the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available
if not enough data is available, the value is null;
learn more about the metric in this help center article",
"type": [
"integer",
"null"
]
},
"cpc": {
"description": "cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword",
"type": [
"number",
"null"
]
},
"high_top_of_page_bid": {
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, the value is_nulln",
"type": [
"integer",
"null"
]
},
"low_top_of_page_bid": {
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data, the value is null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "include Google search partners
the value you specified when setting the task
if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
if false, the results are returned for Google search sites only",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting
if there is no data, the value is null",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteLiveResultInfo": {
"properties": {
"competition": {
"description": "competition
represents the relative level of competition associated with the given keyword in paid SERP only
possible values: LOW, MEDIUM, HIGH
if competition level is unknown, the value is null;
learn more about the metric in this help center article",
"type": [
"string",
"null"
]
},
"competition_index": {
"description": "competition index
the competition index for the query indicating how competitive ad placement is for the keyword
can take values from 0 to 100
the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available
if not enough data is available, the value is null;
learn more about the metric in this help center article",
"type": [
"integer",
"null"
]
},
"cpc": {
"description": "cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword",
"type": [
"number",
"null"
]
},
"high_top_of_page_bid": {
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, the value is_nulln",
"type": [
"integer",
"null"
]
},
"low_top_of_page_bid": {
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data, the value is null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "include Google search partners
the value you specified when setting the task
if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
if false, the results are returned for Google search sites only",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting
if there is no data, the value is null",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskGetResultInfo": {
"properties": {
"competition": {
"description": "competition
represents the relative level of competition associated with the given keyword in paid SERP only
possible values: LOW, MEDIUM, HIGH
if competition level is unknown, the value is null;
learn more about the metric in this help center article",
"type": [
"string",
"null"
]
},
"competition_index": {
"description": "competition index
the competition index for the query indicating how competitive ad placement is for the keyword
can take values from 0 to 100
the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available
if not enough data is available, the value is null;
learn more about the metric in this help center article",
"type": [
"integer",
"null"
]
},
"cpc": {
"description": "cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword",
"type": [
"number",
"null"
]
},
"high_top_of_page_bid": {
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"keyword": {
"description": "keyword in a POST array",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, the value is_nulln",
"type": [
"integer",
"null"
]
},
"low_top_of_page_bid": {
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data, the value is null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "include Google search partners
the value you specified when setting the task
if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
if false, the results are returned for Google search sites only",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate
represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting
if there is no data, the value is null",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsKeywordsForSiteTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo": {
"properties": {
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only;
this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;
if there is no data the value is null;
learn more about the metric in this help center article",
"type": [
"string",
"null"
]
},
"competition_index": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only;
this value is based on Google Ads data and can be between 0 and 100 (inclusive);
if there is no data the value is null;
learn more about the metric in this help center article",
"type": [
"integer",
"null"
]
},
"cpc": {
"description": "cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword",
"type": [
"number",
"null"
]
},
"high_top_of_page_bid": {
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"keyword": {
"description": "keyword
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"low_top_of_page_bid": {
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations;
if there is no data then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate;
represents either the (approximate) number of searches for the given keyword idea on google.com or google.com and partners, depending on the user’s targeting;
if there is no data then the value is_nulln",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "correct spelling of the keyword
Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;
we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskGetResultInfo": {
"properties": {
"competition": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only;
this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;
if there is no data the value is null;
learn more about the metric in this help center article",
"type": [
"string",
"null"
]
},
"competition_index": {
"description": "competition
represents the relative amount of competition associated with the given keyword in paid SERP only;
this value is based on Google Ads data and can be between 0 and 100 (inclusive);
if there is no data the value is null;
learn more about the metric in this help center article",
"type": [
"integer",
"null"
]
},
"cpc": {
"description": "cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword",
"type": [
"number",
"null"
]
},
"high_top_of_page_bid": {
"description": "maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"keyword": {
"description": "keyword
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"low_top_of_page_bid": {
"description": "minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
the value may differ depending on the location specified in a POST request",
"type": [
"number",
"null"
]
},
"monthly_searches": {
"description": "monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations;
if there is no data then the value is_nulln",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MonthlySearchesInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_partners": {
"description": "indicates whether data from partner networks included in the response",
"type": [
"boolean",
"null"
]
},
"search_volume": {
"description": "monthly average search volume rate",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "correct spelling of the keyword
Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;
we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsSearchVolumeTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsStatusResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsStatusTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsStatusResultInfo": {
"properties": {
"actual_data": {
"description": "indicates whether Google updated keyword data for the previous month
generally, Google updates keyword data in the middle of the month
if the value is true, Google currently provides up-to-date data for the previous month
if the value is false, we are not able to provide data for the previous month",
"type": [
"boolean",
"null"
]
},
"date_update": {
"description": "date of the latest update of Google Ads data
indicates the latest date when Google updated search volume, CPC, and other keyword metrics
example:2020-05-15",
"type": [
"string",
"null"
]
},
"last_month_in_monthly_searches": {
"description": "the latest month for which search volume data is available",
"type": [
"integer",
"null"
]
},
"last_year_in_monthly_searches": {
"description": "the latest year for which search volume data is available",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleAdsStatusTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleAdsStatusResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsCategoriesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleTrendsCategoriesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsCategoriesResultInfo": {
"properties": {
"category_code": {
"description": "unique google trends category identifier",
"type": [
"integer",
"null"
]
},
"category_code_parent": {
"description": "the code of the superordinate category
example:\"category_code\": 1100,\"category_name\": \"Superhero Films\",\"category_code_parent\": 1097
where category_code_parent corresponds to: \"category_code\": 1097,\"category_name\": \"Action & Adventure Films\"",
"type": [
"integer",
"null"
]
},
"category_name": {
"description": "name of the google trends category",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsCategoriesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleTrendsCategoriesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleTrendsExploreLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreLiveResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to the Google Trends results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "items on the Google Trends page",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataGoogleTrendsItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keywords": {
"description": "keywords in a POST array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleTrendsExploreLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskGetResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskGetTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskGetResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to the Google Trends results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "items on the Google Trends page",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseKeywordDataGoogleTrendsItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keywords": {
"description": "keywords in a POST array",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code in a POST array
if there is no data, then the value is_nulln",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array
if there is no data, then the value is_nulln",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskGetTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskGetResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KeywordsDataGoogleTrendsExploreTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphAiOverviewItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"asynchronous_ai_overview": {
"description": "indicates whether the element is loaded asynchronously
if true, the ai_overview element is loaded asynchronously;
if false, the ai_overview element is loaded from cache",
"type": [
"boolean",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphCarouselItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphListElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphDescriptionItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"text": {
"description": "reference text
text snippet from the page that was used to generate the ai_overview_element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphExpandedElement": {
"properties": {
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"featured_title": {
"description": "title of a given element",
"type": [
"string",
"null"
]
},
"images": {
"description": "images of the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"table": {
"description": "table present in the element
the header and content of the table present in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL ",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphExpandedItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"expanded_element": {
"description": "expanded element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphExpandedElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphHotelsBookingElement": {
"properties": {
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "website domain",
"type": [
"string",
"null"
]
},
"is_paid": {
"description": "indicates whether the element is an ad",
"type": [
"boolean",
"null"
]
},
"price": {
"description": "pricing details
contains the pricing details of the product or service featured in the result",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"source": {
"description": "name of the source of the video",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "image source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphHotelsBookingItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"date_from": {
"description": "starting date of stay
in the format \"year-month-date\"
example:
2019-11-15",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of stay
in the format \"year-month-date\"
example:
2019-11-17",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphHotelsBookingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphImagesElement": {
"properties": {
"alt": {
"description": "alt tag of the image",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL of the Ad element in SERP",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphImagesItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphImagesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphLinkElementInfo": {
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphListElement": {
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"subtitle": {
"description": "subtitle of the item",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "sitelink URL",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphListItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphListElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphPartItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"text": {
"description": "reference text
text snippet from the page that was used to generate the ai_overview_element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphRowItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"text": {
"description": "reference text
text snippet from the page that was used to generate the ai_overview_element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"card_id": {
"description": "card id",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment;
can be used with Google Reviews API to get a full list of reviews",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"logo_url": {
"description": "URL of the logo from knowledge graph",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"subtitle": {
"description": "subtitle of the item",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphShoppingElement": {
"properties": {
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"marketplace": {
"description": "merchant account provider
ecommerce site that hosts products or websites of individual sellers under the same merchant account
example:by Google",
"type": [
"string",
"null"
]
},
"marketplace_url": {
"description": "URL to the merchant account provider
ecommerce site that hosts products or websites of individual sellers under the same merchant account",
"type": [
"string",
"null"
]
},
"price": {
"description": "pricing details
contains the pricing details of the product or service featured in the result;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_KnowledgeGraphShoppingItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphShoppingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_LastModified": {
"properties": {
"header": {
"description": "date and time when the header was last modifiedin the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null",
"type": [
"string",
"null"
]
},
"meta_tag": {
"description": "date and time when the meta tag was last modifiedin the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null",
"type": [
"string",
"null"
]
},
"sitemap": {
"description": "date and time when the sitemap was last modifiedin the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_LinkElement": {
"properties": {
"description": {
"description": "description of the results element",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "元素的 XPath",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ListDataInfo": {
"properties": {
"rising": {
"description": "emerging related topics
represents the list of related topics with the biggest increase in search frequency since the last time period",
"items": {
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"top": {
"description": "the most popular related topics
represents the list of the most popular related topics",
"items": {
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_LlmMentionsAggregatedMetricsInfo": {
"properties": {
"brand_entities_category": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity categories that appear in search results related to LLM queries
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"brand_entities_title": {
"description": "data on brand entities relevant to the target
array of objects containing data on brand entity titles that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"language": {
"description": "language-based grouping
array of objects containing mention metrics segmented by content language",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"location": {
"description": "location-based grouping
array of objects containing mention metrics segmented by geographical location",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "platform-based grouping
array of group elements containing mention metrics segmented by AI platform",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"search_results_domain": {
"description": "found top search results domains relevant to the target
array of objects containing data on top domains that appear in search results related to LLM queries;
Note: available only for chat_gpt",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"sources_domain": {
"description": "found top source domains relevant to the target
array of objects containing data on top domains that are cited as sources in LLM responses
learn more about the sources and how to retrieve LLM citation data at our Help Center",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total": {
"description": "aggregated mentions metrics summary
contains overall aggregated LLM mention metrics across all found domains",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AggregatedMetricsInfoTotalInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_LlmMessageSectionInfo": {
"properties": {
"annotations": {
"description": "array of references used to generate the response
equals null if the web_search parameter is not set to true
Note: annotations may return empty even when web_search is true, as the AI will attempt to retrieve web information but may not find relevant results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AnnotationInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "text of the reasoning chain section
text of the reasoning chain section summarizing the model's thought process",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_LocalBusinessDeliveryServiceInfo": {
"properties": {
"title": {
"description": "title of the element\ndomain of the online food ordering system",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to place an order",
"type": [
"string",
"null"
]
}
}
},
"Response0A3E90081762_LocalBusinessMenuLink": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseLocalBusinessLink"
},
{
"properties": {
"title": {
"description": "title of the element\ndomain of the online menu system",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to view the menu",
"type": [
"string",
"null"
]
}
}
}
]
},
"Response0A3E90081762_LocalBusinessOrderLink": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseLocalBusinessLink"
},
{
"properties": {
"delivery_services": {
"description": "lists available delivery services",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LocalBusinessDeliveryServiceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
}
}
]
},
"Response0A3E90081762_LocalBusinessReservationLink": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseLocalBusinessLink"
},
{
"properties": {
"title": {
"description": "title of the element\ndomain of the reservation software",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to make a reservation",
"type": [
"string",
"null"
]
}
}
}
]
},
"Response0A3E90081762_LocalJustificationInfo": {
"properties": {
"text": {
"description": "text snippet of local justification",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_LocalPackSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"booking_url": {
"description": "URL of the booking page",
"type": [
"string",
"null"
]
},
"cid": {
"description": "google-defined client id",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the link",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the website hosting the video",
"type": [
"string",
"null"
]
},
"is_paid": {
"description": "indicates whether the element is an ad",
"type": [
"boolean",
"null"
]
},
"phone": {
"description": "phone number",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_LocalServicesElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"profile_image_url": {
"description": "URL of the image featured in the element",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_LocalServicesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"domain": {
"description": "domain of the website hosting the video",
"type": [
"string",
"null"
]
},
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LocalServicesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_LocationChain": {
"properties": {
"card_id": {
"description": "card identifier",
"type": [
"string",
"null"
]
},
"cid": {
"description": "client id
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "feature identifier
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in the location chain",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MapSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MapsSearch": {
"properties": {
"additional_categories": {
"description": "additional business categories
additional Google My Business categories that describe the services provided by the business entity in more detail",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"address": {
"description": "address of the business entity",
"type": [
"string",
"null"
]
},
"address_info": {
"description": "object containing address components of the business entity",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AddressInfo"
}
],
"type": [
"object",
"null"
]
},
"category": {
"description": "business category
Google My Business general category that best describes the services provided by the business entity",
"type": [
"string",
"null"
]
},
"category_ids": {
"description": "global category IDs
universal category IDs that do not change based on the selected country",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment;
can be used with Google Reviews API to get a full list of reviews
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain of the business entity",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"hotel_rating": {
"description": "hotel class rating
class ratings range between 1-5 stars, learn more
if there is no hotel class rating information, the value will be null",
"type": [
"string",
"null"
]
},
"is_claimed": {
"description": "shows whether the entity is verified by its owner on Google Maps",
"type": [
"boolean",
"null"
]
},
"is_directory_item": {
"description": "business establishment is a part of the directory
indicates whether the business establishment is a part of the directory;
if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);
note: if the business establishment is a parent item in the directory, the value will be null",
"type": [
"boolean",
"null"
]
},
"latitude": {
"description": "latitude coordinate of the local establishments in google maps
example:\"latitude\": 51.584091",
"type": [
"number",
"null"
]
},
"local_justifications": {
"description": "Google local justifications
snippets of text that “justify” why the business is showing up for search query",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"longitude": {
"description": "longitude coordinate of the local establishment in google maps
example:\"longitude\": -0.31365919999999997",
"type": [
"number",
"null"
]
},
"main_image": {
"description": "URL of the main image featured in Google My Business profile",
"type": [
"string",
"null"
]
},
"phone": {
"description": "phone number of the business entity",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "unique place identifier
place id of the local establishment featured in the element
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"price_level": {
"description": "property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the elements",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from the rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"rating_distribution": {
"additionalProperties": {
"format": "Int64",
"type": [
"integer",
"null"
]
},
"description": "the distribution of ratings of the business entity\nthe object displays the number of 1-star to 5-star ratings, as reviewed by users",
"type": [
"object",
"null"
]
},
"snippet": {
"description": "additional information about the business entity",
"type": [
"string",
"null"
]
},
"title": {
"description": "directory title
can take the following values: At this place, Directory",
"type": [
"string",
"null"
]
},
"total_photos": {
"description": "total count of images featured in Google My Business profile",
"format": "int64",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to view the menu",
"type": [
"string",
"null"
]
},
"work_hours": {
"description": "open hours
information about work hours of the local establishment",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessWorkHoursInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Markets": {
"properties": {
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"market": {
"description": "financial market identifier
possible values: US, Europe, Asia, Currencies, Crypto, Futures",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MathSolverElement": {
"properties": {
"expanded_element": {
"description": "expanded element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MathSolverExpandedElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MathSolverExpandedElement": {
"properties": {
"solution": {
"description": "solution of the element
displays steps to solve the mathematical equation as specified in the element",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the carousel item",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MathSolverSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MathSolverElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"result": {
"description": "solution to the equation
solution to the mathematical equation specified in the keyword field when setting a task",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MentionCarouselElement": {
"properties": {
"mentioned_in": {
"description": "additional elements in the mention_carousel item",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"price": {
"description": "price of the app element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the element’s rating \nthe popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MentionCarouselSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MentionCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinLiveAdvancedResultInfo": {
"properties": {
"asin": {
"description": "ASIN received in a POST array
the unique product identifier in Amazon (ASIN) received in a POST array
learn more about the identified in this help center guide",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to Amazon results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found on Amazon
contains types of all search results (items) found in the returned SERP
possible item types:amazon_product_info",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "Amazon product info items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonProductInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "Amazon domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinLiveHtmlResultInfo": {
"properties": {
"asin": {
"description": "ASIN received in a POST array",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskGetAdvancedResultInfo": {
"properties": {
"asin": {
"description": "ASIN received in a POST array
the unique product identifier in Amazon (ASIN) received in a POST array
learn more about the identified in this help center guide",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to Amazon results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found on Amazon
contains types of all search results (items) found in the returned SERP
possible item types:amazon_product_info",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "Amazon product info items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonProductInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "Amazon domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskGetHtmlResultInfo": {
"properties": {
"asin": {
"description": "ASIN received in a POST array",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the Amazon ASIN Advanced task",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the Amazon ASIN HTML task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
can take the following values: shopping",
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonAsinTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonAsinTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_name_parent": {
"description": "the name of the superordinate location
example:\"location_code\": 9041134,",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonPaidSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"bought_past_month": {
"description": "number of product purchases in the past month",
"type": [
"integer",
"null"
]
},
"currency": {
"description": "currency in the ISO format
\"location_name\": \"90290,California,United States\",
\"location_name_parent\": \"California,United States\"
example:USD",
"type": [
"string",
"null"
]
},
"data_asin": {
"description": "unique product identifier on Amazon
note that there is no full list of possible values as the data_asin is a dynamic value assigned by Amazon
example:B07G82D89J",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonDeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"domain": {
"description": "Amazon domain",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the product image featured in the results",
"type": [
"string",
"null"
]
},
"is_amazon_choice": {
"description": "\"Amazon's choice\" label
if the value is true, the product is marked with the \"Amazon's choice\" label",
"type": [
"boolean",
"null"
]
},
"is_best_seller": {
"description": "\"Best Seller\" label
if the value is true, the product is marked with the \"Best Seller\" label",
"type": [
"boolean",
"null"
]
},
"labels": {
"description": "product labels
array containing an object with main Amazon labels’ information
if the product contains no labels, the value will be null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"price_from": {
"description": "the regular price of a product
example:49.98",
"type": [
"number",
"null"
]
},
"price_to": {
"description": "the upper limit of the product price range
example:384.99",
"type": [
"number",
"null"
]
},
"rating": {
"description": "product rating info",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"special_offers": {
"description": "special offer details
contains special offer details, including coupon and Subscribe & Save discounts",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"url": {
"description": "the URL of the product page",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsLiveAdvancedResultInfo": {
"properties": {
"categories": {
"description": "amazon product departments and subcategories",
"type": [
"object",
"null"
]
},
"check_url": {
"description": "direct URL to Amazon results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in Amazon SERP
contains types of all search results (items) found in the returned SERP
possible item types:amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "Amazon product items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "search engine results count",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskGetAdvancedResultInfo": {
"properties": {
"categories": {
"description": "amazon product departments and subcategories",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"check_url": {
"description": "direct URL to Amazon results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in Amazon SERP
contains types of all search results (items) found in the returned SERP
possible item types:amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "Amazon product items within the editorial_recommendations element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "search engine results count",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "HTML pages and related data",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the Amazon Products Advanced task",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the Amazon Products HTML task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
can take the following values: organic",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonProductsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonProductsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellerItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonSellersElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellerMainItemSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonSellersElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersLiveAdvancedResultInfo": {
"properties": {
"asin": {
"description": "asin received in a POST array
learn more about ASINs in this help center guide",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to Amazon results
you can use it to make sure the provided results are accurate",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"image": {
"description": "product image url
image URL of the product relevant to the asin received in a POST array",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in Amazon Sellers SERP
contains types of all search results (items) found in the returned SERP
possible item types:amazon_seller_main_item, amazon_seller_item",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonSellersElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code received in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code received in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain received in a POST array",
"type": [
"string",
"null"
]
},
"title": {
"description": "product title
title of the product relevant to the asin received in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersLiveHtmlResultInfo": {
"properties": {
"asin": {
"description": "ASIN received in a POST array ",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found on Amazon",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskGetAdvancedResultInfo": {
"properties": {
"asin": {
"description": "asin received in a POST array
learn more about ASINs in this help center guide",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to Amazon results
you can use it to make sure the provided results are accurate",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"image": {
"description": "product image url
image URL of the product relevant to the asin received in a POST array",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in Amazon Sellers SERP
contains types of all search results (items) found in the returned SERP
possible item types:amazon_seller_main_item, amazon_seller_item",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonSellersElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code received in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code received in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain received in a POST array",
"type": [
"string",
"null"
]
},
"title": {
"description": "product title
title of the product relevant to the asin received in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskGetHtmlResultInfo": {
"properties": {
"asin": {
"description": "ASIN received in a POST array ",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found on Amazon",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of Amazon Sellers Advanced task",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of Amazon Sellers HTML task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSellersTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantAmazonSellersTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantAmazonSerpSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"bought_past_month": {
"description": "number of product purchases in the past month",
"type": [
"integer",
"null"
]
},
"currency": {
"description": "currency in the ISO format
example:USD",
"type": [
"string",
"null"
]
},
"data_asin": {
"description": "unique product identifier on Amazon
note that there is no full list of possible values as the data_asin is a dynamic value assigned by Amazon
example:B07G82D89J",
"type": [
"string",
"null"
]
},
"delivery_info": {
"description": "delivery information
delivery information including free and fast delivery date ranges",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonDeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"domain": {
"description": "Amazon domain",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the product image featured in the results",
"type": [
"string",
"null"
]
},
"is_amazon_choice": {
"description": "\"Amazon's choice\" label
if the value is true, the product is marked with the \"Amazon's choice\" label",
"type": [
"boolean",
"null"
]
},
"is_best_seller": {
"description": "\"Best Seller\" label
if the value is true, the product is marked with the \"Best Seller\" label",
"type": [
"boolean",
"null"
]
},
"labels": {
"description": "product labels
array containing an object with main Amazon labels’ information
if the product contains no labels, the value will be null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"price_from": {
"description": "the regular price of a product
example:49.98",
"type": [
"number",
"null"
]
},
"price_to": {
"description": "the upper limit of the product price range
example:384.99",
"type": [
"number",
"null"
]
},
"rating": {
"description": "product rating info",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"special_offers": {
"description": "special offer details
contains special offer details, including coupon and Subscribe & Save discounts",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"url": {
"description": "the URL of the product page",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantEditorialRecommendationsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "Amazon product items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonSerpElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element in Amazon SERP
possible values:left, right",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_name_parent": {
"description": "the name of the superordinate location
example:
`\"location_name\": \"Arkansas,United States\"`,
`\"location_name_parent\": \"United States\"`",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductInfoTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of items found on the product specification page
possible item types:product_info_element",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items on the product page
contains all product attributes and related data listed on the product page",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ProductInfoElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"product_id": {
"description": "product ID in a POST array
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductInfoTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductInfoTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductInfoTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the Google Shopping Product Specifications Advanced task",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the Google Shopping Product Specifications HTML task
note: HTML is not available for this endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
can take the following values: shopping_specifications",
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductInfoTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductInfoTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to Google Shopping results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in Google Shopping SERP
contains types of all search results (items) found in the returned SERP
possible item types:google_shopping_sponsored_carousel, google_shopping_paid, google_shopping_serp, google_shopping_carousel, related_searches",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "additional items present in the element
contains a list of related keywords;
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingProductsElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductsTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found on Google Shopping",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductsTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of Google Shopping Products Advanced task",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of Google Shopping Products HTML task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: products",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleProductsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleProductsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleSellersTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to Google Shopping results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL to the product image",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in Google Shopping SERP
contains types of all search results (items) found in the returned SERP
possible item types:shops_list, buy_on_google",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingSellersElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"product_id": {
"description": "product_id received in a POST array
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"rating": {
"description": "product rating
the product popularity rate based on product reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the product",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the product page",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleSellersTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleSellersTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleSellersTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of Google Shopping Sellers Advanced task",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of Google Shopping Sellers HTML task",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
can take the following values: shopping",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MerchantGoogleSellersTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MerchantGoogleSellersTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantRelatedSearchesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "Amazon product items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedSearchesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element in Amazon SERP
possible values:left, right",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MerchantTopRatedFromOurBrandsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "Amazon product items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonSerpElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "the alignment of the element in Amazon SERP
possible values:left, right",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MessageAiOptimizationLlmResponseElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"sections": {
"description": "reasoning chain sections
array of objects containing the reasoning chain sections generated by the LLM",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LlmMessageSectionInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_MessageInfo": {
"properties": {
"level": {
"description": "level of error\ncan take the following values: fatal, error, warning, info",
"type": [
"string",
"null"
]
},
"message": {
"description": "message associated with an error\nmessage providing the details of the detected error",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MetricsBundleInfo": {
"properties": {
"organic": {
"description": "ranking and traffic data from organic search",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MetricsInfo"
}
],
"properties": {
"is_down": {
"description": "rank went down\nindicates how many ranked elements of this domain went down in Google Search",
"format": "int64",
"type": [
"integer",
"null"
]
},
"is_lost": {
"description": "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check",
"format": "int64",
"type": [
"integer",
"null"
]
},
"is_new": {
"description": "number of new ranked elements\nindicates how many new ranked elements were found for this domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"is_up": {
"description": "rank went up\nindicates how many ranked elements of this domain went up in Google Search",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"paid": {
"description": "ranking and traffic data from paid search",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MetricsInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MetricsInfo": {
"properties": {
"count": {
"description": "total count of organic SERPs that contain the domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"estimated_paid_traffic_cost": {
"description": "estimated cost of converting organic search traffic into paid
represents the estimated monthly cost of running ads (USD) for all keywords a domain ranks for
the 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 Search
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"etv": {
"description": "estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"is_down": {
"description": "rank went down\nindicates how many ranked elements of this domain went down in Google Search",
"format": "int64",
"type": [
"integer",
"null"
]
},
"is_lost": {
"description": "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check",
"format": "int64",
"type": [
"integer",
"null"
]
},
"is_new": {
"description": "number of new ranked elements\nindicates how many new ranked elements were found for this domain",
"format": "int64",
"type": [
"integer",
"null"
]
},
"is_up": {
"description": "rank went up\nindicates how many ranked elements of this domain went up in Google Search",
"format": "int64",
"type": [
"integer",
"null"
]
},
"pos_1": {
"description": "number of organic SERPs where the domain ranks #1",
"type": [
"integer",
"null"
]
},
"pos_11_20": {
"description": "number of organic SERPs where the domain ranks #11-20",
"type": [
"integer",
"null"
]
},
"pos_21_30": {
"description": "number of organic SERPs where the domain ranks #21-30",
"type": [
"integer",
"null"
]
},
"pos_2_3": {
"description": "number of organic SERPs where the domain ranks #2-3",
"type": [
"integer",
"null"
]
},
"pos_31_40": {
"description": "number of organic SERPs where the domain ranks #31-40",
"type": [
"integer",
"null"
]
},
"pos_41_50": {
"description": "number of organic SERPs where the domain ranks #41-50",
"type": [
"integer",
"null"
]
},
"pos_4_10": {
"description": "number of organic SERPs where the domain ranks #4-10",
"type": [
"integer",
"null"
]
},
"pos_51_60": {
"description": "number of organic SERPs where the domain ranks #51-60",
"type": [
"integer",
"null"
]
},
"pos_61_70": {
"description": "number of organic SERPs where the domain ranks #61-70",
"type": [
"integer",
"null"
]
},
"pos_71_80": {
"description": "number of organic SERPs where the domain ranks #71-80",
"type": [
"integer",
"null"
]
},
"pos_81_90": {
"description": "number of organic SERPs where the domain ranks #81-90",
"type": [
"integer",
"null"
]
},
"pos_91_100": {
"description": "number of organic SERPs where the domain ranks #91-100",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MicrodataFieldsInfo": {
"properties": {
"fields": {
"description": "microdata fields
an array of objects containing data fields related to the certain microdata type",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MicrodataFieldsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"name": {
"description": "field name
name of the data field",
"type": [
"string",
"null"
]
},
"test_results": {
"description": "microdata validation test results
sub-type microdata test results that contain detected errors and related messages",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MessageInfo"
}
],
"type": [
"object",
"null"
]
},
"types": {
"description": "list of microdata types",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"value": {
"description": "microdata value\nmicrodata value specified on a target web page",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MicrodataInspectionInfo": {
"properties": {
"fields": {
"description": "microdata fields
an array of objects containing data fields related to the certain microdata type",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MicrodataFieldsInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"types": {
"description": "parent microdata types
for a full list of available types, please visit schema.org",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MonthlySearchesInfo": {
"properties": {
"month": {
"description": "月",
"type": [
"integer",
"null"
]
},
"search_volume": {
"description": "月平均搜索量",
"type": [
"integer",
"null"
]
},
"year": {
"description": "年",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MultiCarouselElement": {
"properties": {
"multi_carousel_snippets": {
"description": "multi_carousel_snippet results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpApiCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_MultiCarouselSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MultiCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_NewerModel": {
"properties": {
"newer_model_asin": {
"description": "ASIN of the newer product model",
"type": [
"string",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageAlternateLinkItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"hreflang": {
"description": "hreflang attribute value
language and optional country code specified in the hreflang attribute
example: \"en-US\", \"fr\"",
"type": [
"string",
"null"
]
},
"is_valid_hreflang": {
"description": "hreflang validity status
indicates whether the hreflang attribute is correctly implemented",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageAnchorLinkItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"link_attribute": {
"description": "link attribute added to external link
indicates link attributes added to the link_to on the page_from
example:[\"ugc\",\"noopener\"]",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "anchor text",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageAvailableFiltersResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageAvailableFiltersTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageAvailableFiltersResultInfo": {
"properties": {
"keyword_density": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"links": {
"additionalProperties": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"non_indexable": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"pages": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"pages_by_resource": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"redirect_chains": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"resources": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
},
"uncrawlable_resources": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageAvailableFiltersTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
contains the full list of available parameters that can be used for data filtration
the parameters are grouped by the endpoint they can be used with",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageAvailableFiltersResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageBrokenResourceItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"accept_type": {
"description": "indicates the expected type of resource
for example, if \"resource_type\": \"broken\", accept_type will indicate the type of the broken resource
possible values: any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font",
"type": [
"string",
"null"
]
},
"fetch_timing": {
"description": "time range within which a result was fetched",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FetchTiming"
}
],
"type": [
"object",
"null"
]
},
"is_resource": {
"description": "指示页面是否为单一资源",
"type": [
"boolean",
"null"
]
},
"meta": {
"description": "resource properties
the value depends on the resource_type
note that if you do not indicate a url when setting a task, resource's meta is returned based on the data from the page where our crawler first saw the resource;
to obtain resource's meta from a particular url, specify that URL when setting a task",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageMetaInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageCanonicalLinkItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
{
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageContentParsingLiveResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageContentParsingLiveTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageContentParsingLiveResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentParsingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageContentParsingLiveTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageContentParsingLiveResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageContentParsingResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageContentParsingTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageContentParsingResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentParsingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array
",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageContentParsingTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageContentParsingResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateContentItem": {
"properties": {
"pages": {
"description": "pages with duplicate content",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DuplicatePageInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "total count of duplicate pages",
"format": "int64",
"type": [
"integer",
"null"
]
},
"url": {
"description": "URL of the specified page",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateContentResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageDuplicateContentTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateContentResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageDuplicateContentItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateContentTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageDuplicateContentResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateTagsItem": {
"properties": {
"accumulator": {
"description": "contains the value of duplicated tag",
"type": [
"string",
"null"
]
},
"pages": {
"description": "pages with duplicate tags",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageHtmlResourceItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"total_count": {
"description": "total count of duplicate pages",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateTagsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageDuplicateTagsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateTagsResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageDuplicateTagsItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "number of pages with duplicate tags in the response
displays the number of pages with duplicate tags returned in the response",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_pages_count": {
"description": "total number of pages with duplicate tags
displays the total number of pages with duplicate tags of the target website",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageDuplicateTagsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageDuplicateTagsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageForceStopResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageForceStopTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageForceStopTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageHtmlResourceItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"broken_links": {
"description": "指示页面是否包含失效链接",
"type": [
"boolean",
"null"
]
},
"broken_resources": {
"description": "表示页面是否包含损坏的资源",
"type": [
"boolean",
"null"
]
},
"click_depth": {
"description": "number of clicks it takes to get to the pageindicates the number of clicks from the homepage needed before landing at the target page",
"type": [
"integer",
"null"
]
},
"custom_js_client_exception": {
"description": "error when executing a custom jsif the error occurred when executing the script you specified in the custom_js field, the error message would be displayed here",
"type": [
"string",
"null"
]
},
"custom_js_response": {
"description": "the result of executing a specified JS scriptnote 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;you can also filter the results by this value specifying filters in the following way:[\"custom_js_response.url\", \"like\", \"pixel\"]",
"type": [
"object",
"null"
]
},
"duplicate_content": {
"description": "指示页面是否包含重复内容",
"type": [
"boolean",
"null"
]
},
"duplicate_description": {
"description": "表示页面是否存在重复描述",
"type": [
"boolean",
"null"
]
},
"duplicate_title": {
"description": "指示页面是否存在重复的标题标签",
"type": [
"boolean",
"null"
]
},
"is_resource": {
"description": "指示页面是否为单一资源",
"type": [
"boolean",
"null"
]
},
"meta": {
"description": "page propertiesthe value depends on the resource_type",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageMetaInfo"
}
],
"properties": {
"broken_html": {
"description": "资源错误和警告",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourceIssueInfo"
}
],
"type": [
"object",
"null"
]
},
"social_media_tags": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"onpage_score": {
"description": "shows how page is optimized on a 100-point scalethis field shows how page is optimized considering critical on-page issues and warnings detected;100 is the highest possible score that means the page does not have any critical on-page issues and important warnings;learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"page_timing": {
"description": "页面加载指标对象",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageTiming"
}
],
"type": [
"object",
"null"
]
},
"relative_url_length": {
"description": "relative URL length in characters",
"type": [
"integer",
"null"
]
},
"total_dom_size": {
"description": "页面的 DOM 总大小",
"format": "int64",
"type": [
"integer",
"null"
]
},
"url_length": {
"description": "page URL length in characters",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageImageLinkItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"image_alt": {
"description": "alternative text for the image",
"type": [
"string",
"null"
]
},
"image_src": {
"description": "url of the image",
"type": [
"string",
"null"
]
},
"link_attribute": {
"description": "link attribute added to external link
indicates link attributes added to the link_to on the page_from
example:[\"ugc\",\"noopener\"]",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "anchor text",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageImageResourceItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"accept_type": {
"description": "indicates the expected type of resourcefor example, if \"resource_type\": \"broken\", accept_type will indicate the type of the broken resourcepossible values:any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font",
"type": [
"string",
"null"
]
},
"fetch_timing": {
"description": "time range within which a result was fetched",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FetchTiming"
}
],
"type": [
"object",
"null"
]
},
"meta": {
"description": "page propertiesthe value depends on the resource_type",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ResourceMetaInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageInstantPagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageInstantPagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageInstantPagesResultInfo": {
"properties": {
"crawl_gateway_address": {
"description": "crawler ip addressdisplays the IP address used by the crawler to initiate the current crawling sessionyou can find the full list of IPs used by our crawler in the Overview section",
"type": [
"string",
"null"
]
},
"crawl_progress": {
"description": "status of the crawling sessionpossible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling sessionin this case the value will be null",
"type": [
"object",
"null"
]
},
"items": {
"description": "items 数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageHtmlResourceItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "results 数组中的项目数量",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageInstantPagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageInstantPagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageKeywordDensityItem": {
"properties": {
"density": {
"description": "keyword density
calculated as a ratio of frequency to the total count of keywords with the set keyword_length on the web page or website",
"type": [
"number",
"null"
]
},
"frequency": {
"description": "keyword frequency
number of times the keyword appears on the website (or webpage if you specified a url)",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "returned keyword",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageKeywordDensityResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageKeywordDensityTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageKeywordDensityResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageKeywordDensityItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_items_count": {
"description": "total number of relevant items
total number of keywords on the specified website or web page matching the set keyword_length and filters",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageKeywordDensityTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageKeywordDensityResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseAuditsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseAuditsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseAuditsResultInfo": {
"properties": {
"audits": {
"description": "the list of available lighthouse audits
an array containing the titles of available audits;
Note: the titles can change depending on if the audit passed or failed and may contain markdown code;
Note #2: if you're using the audit that contains a slash (/) in its name, search by the last word after the slash",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseAuditsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseAuditsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseLiveJsonResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseLiveJsonTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseLiveJsonTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "results of Lighthouse audit
this array will include data according to the parameters you specified when setting a task;
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseVersionsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseVersionsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseVersionsResultInfo": {
"properties": {
"availible_versions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AvailibleVersions"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageLighthouseVersionsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLighthouseVersionsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLinkLinkItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
{
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLinksResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLinksTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageLinksResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"current_offset": {
"type": [
"integer",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"search_after_token": {
"type": [
"string",
"null"
]
},
"total_items_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageLinksTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageLinksResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageMetaLinkItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
{
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageMicrodataInfoItem": {
"properties": {
"inspection_info": {
"description": "information related to microdata validation",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_MicrodataInspectionInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageMicrodataResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageMicrodataTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageMicrodataResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageMicrodataInfoItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"test_summary": {
"description": "microdata validation test results",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TestSummary"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageMicrodataTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageMicrodataResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageNonIndexableItem": {
"properties": {
"reason": {
"description": "the reason why the page is non-indexable
can take the following values: robots_txt, meta_tag, http_header, attribute, too_many_redirects",
"type": [
"string",
"null"
]
},
"url": {
"description": "url of the non-indexable page",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageNonIndexableResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageNonIndexableTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageNonIndexableResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageNonIndexableItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_items_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageNonIndexableTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageNonIndexableResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPagePageScreenshotResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPagePageScreenshotTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPagePageScreenshotResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"error_message": {
"description": "error message
if the url you indicated returns a 404 status code or is not a valid URL, you will obtain \"error_message\":\"Screenshot is empty\"
if no error is encountered, the value will be null",
"type": [
"string",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ScreenshotItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPagePageScreenshotTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPagePageScreenshotResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPagePagesByResourceResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPagePagesByResourceTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPagePagesByResourceResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageHtmlResourceItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_items_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPagePagesByResourceTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPagePagesByResourceResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPagePagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPagePagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPagePagesResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling sessionpossible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "抓取会话的详细信息",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"current_offset": {
"type": [
"integer",
"null"
]
},
"items": {
"description": "items 数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "results 数组中的项目数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"search_after_token": {
"type": [
"string",
"null"
]
},
"total_items_count": {
"description": "数据库中相关项目的总数",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPagePagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPagePagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageRawHtmlItem": {
"properties": {
"html": {
"description": "HTML_pagen",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageRawHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageRawHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageRawHtmlResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items object",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageRawHtmlItem"
}
],
"type": [
"object",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageRawHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageRawHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageRedirectChainsItem": {
"properties": {
"chain": {
"description": "contains links that form a chain",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageRedirectLinkItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_redirect_loop": {
"description": "indicates if redirects in chain start and end at the same URL
if true, the last URL from the chain redirects back to the original URL",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageRedirectChainsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageRedirectChainsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageRedirectChainsResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageRedirectChainsItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_items_count": {
"description": "total number of relevant items in the database",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageRedirectChainsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageRedirectChainsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageRedirectLinkItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageLinkItem"
}
],
"type": [
"object",
"null"
]
},
{
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageRedirectResourceItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"fetch_timing": {
"description": "time range within which a result was fetched",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FetchTiming"
}
],
"type": [
"object",
"null"
]
},
"is_resource": {
"description": "指示页面是否为单一资源",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageResourceIssueInfo": {
"description": "资源错误和警告",
"properties": {
"errors": {
"description": "资源错误",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourceIssueItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"warnings": {
"description": "资源警告",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourceIssueItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageResourceIssueItemInfo": {
"properties": {
"column": {
"description": "发现错误的列",
"type": [
"integer",
"null"
]
},
"line": {
"description": "发现错误的行",
"type": [
"integer",
"null"
]
},
"message": {
"description": "text message of the errorthe full list of possible HTML errors can be found here",
"type": [
"string",
"null"
]
},
"status_code": {
"description": "general status codeyou can find the full list of the response codes hereNote: we strongly recommend designing a necessary system for handling related exceptional or error conditions",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageResourceLocationInfo": {
"properties": {
"line": {
"description": "line number
the number of the line on which the resource is located",
"type": [
"integer",
"null"
]
},
"offset_left": {
"description": "position in line
the number of line characters before the resource;
sometimes referred to as column
Note: counts from 1, i.e. if the resource doesn't have any characters to the left, the value will be 1",
"type": [
"integer",
"null"
]
},
"offset_top": {
"description": "position in the document
the total number of characters between the resource and the top of HTML",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageResourcesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourcesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageResourcesResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"current_offset": {
"type": [
"integer",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"search_after_token": {
"type": [
"string",
"null"
]
},
"total_items_count": {
"description": "total number of relevant items crawled",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageResourcesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourcesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageScriptResourceItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"accept_type": {
"description": "indicates the expected type of resourcefor example, if \"resource_type\": \"broken\", accept_type will indicate the type of the broken resourcepossible values:any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font",
"type": [
"string",
"null"
]
},
"fetch_timing": {
"description": "time range within which a result was fetched",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FetchTiming"
}
],
"type": [
"object",
"null"
]
},
"meta": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ResourceMetaInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageStylesheetResourceItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseOnPageResourceItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"accept_type": {
"description": "indicates the expected type of resourcefor example, if \"resource_type\": \"broken\", accept_type will indicate the type of the broken resourcepossible values:any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font",
"type": [
"string",
"null"
]
},
"fetch_timing": {
"description": "time range within which a result was fetched",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FetchTiming"
}
],
"type": [
"object",
"null"
]
},
"meta": {
"description": "page propertiesthe value depends on the resource_type",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ResourceMetaInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageSummaryResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageSummaryTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageSummaryResultInfo": {
"properties": {
"crawl_gateway_address": {
"description": "crawler ip address
displays the IP address used by the crawler to initiate the current crawling session
you can find the full list of IPs used by our crawler in the Overview section",
"type": [
"string",
"null"
]
},
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"crawl_stop_reason": {
"description": "reason why the crawling stopped
information about the reason why the crawling process stopped;
possible values:limit_exceeded - the limit set in the max_crawl_pages was exceeded;empty_queue - all URLs in the queue were crawled;force_stopped - the crawling process was halted using the On Page API Force Stop function;unexpected_exception - an internal error was encountered while crawling the target, contact support for more info",
"type": [
"string",
"null"
]
},
"domain_info": {
"description": "domain-wide info
on-page information about the target domain and crawling process",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DomainInfo"
}
],
"type": [
"object",
"null"
]
},
"page_metrics": {
"description": "page-specific info
metrics information on the target website pages",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageMetrics"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageSummaryTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageSummaryResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
},
"target": {
"description": "target website specified when setting a task",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageUncrawlableResourcesItem": {
"properties": {
"fetch_time": {
"description": "date and time when the resource was fetched
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2026-03-09 18:20:32 +00:00",
"type": [
"string",
"null"
]
},
"meta": {
"description": "metadata of the uncrawlable resource",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_UncrawlableResourcesMeta"
}
],
"type": [
"object",
"null"
]
},
"reason": {
"description": "reason the resource is uncrawlable
can take the following values: content_type_inconsistency",
"type": [
"string",
"null"
]
},
"status_code": {
"description": "general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions",
"type": [
"integer",
"null"
]
},
"url": {
"description": "URL of the uncrawlable resource",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageUncrawlableResourcesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageUncrawlableResourcesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageUncrawlableResourcesResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"current_offset": {
"type": [
"integer",
"null"
]
},
"items": {
"description": "array of uncrawlable resources",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageUncrawlableResourcesItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of uncrawlable resources in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_items_count": {
"description": "total number of uncrawlable resources found
total number of uncrawlable resources found during the crawl of the target domain",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageUncrawlableResourcesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageUncrawlableResourcesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageWaterfallItem": {
"properties": {
"connection_time": {
"description": "time to connect to a server
the time it takes until the connection with a server is established (in milliseconds)",
"type": [
"integer",
"null"
]
},
"dom_complete": {
"description": "time to load resources
the time it takes until the page and all of its subresources are downloaded (in milliseconds)",
"type": [
"integer",
"null"
]
},
"download_time": {
"description": "time it takes for a browser to receive a response (in milliseconds)",
"type": [
"integer",
"null"
]
},
"duration_time": {
"description": "total time it takes until a browser receives a complete response from a server (in milliseconds)",
"type": [
"integer",
"null"
]
},
"fetch_end": {
"description": "time to complete downloading the HTML resource
the amount of time the browser needs to complete downloading a page",
"type": [
"integer",
"null"
]
},
"fetch_start": {
"description": "time to start downloading the HTML resource
the amount of time the browser needs to start downloading a page",
"type": [
"integer",
"null"
]
},
"page_url": {
"description": "URL of the page",
"type": [
"string",
"null"
]
},
"request_sent_time": {
"description": "time to send a request to a server
the time it takes until the request to a server is sent (in milliseconds)",
"type": [
"integer",
"null"
]
},
"resources": {
"description": "resource-specific timing
contains separate arrays with timing for each resource found on the page",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_WaterfallResourceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"time_to_interactive": {
"description": "Time To Interactive (TTI) metric
the time it takes until the user can interact with a page (in milliseconds)",
"type": [
"integer",
"null"
]
},
"time_to_secure_connection": {
"description": "time to establish a secure connection
the time it takes until the secure connection with a server is established (in milliseconds)",
"type": [
"integer",
"null"
]
},
"waiting_time": {
"description": "time to first byte (TTFB) in milliseconds",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageWaterfallResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageWaterfallTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OnPageWaterfallResultInfo": {
"properties": {
"crawl_progress": {
"description": "status of the crawling session
possible values: in_progress, finished",
"type": [
"string",
"null"
]
},
"crawl_status": {
"description": "details of the crawling session",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_CrawlStatusInfo"
}
],
"type": [
"object",
"null"
]
},
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageWaterfallItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_OnPageWaterfallTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageWaterfallResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OrganicSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"about_this_result": {
"deprecated": true,
"description": "contains information from the 'About this result' panel
Note: this object is deprecated and always returns null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AboutThisResultElement"
}
],
"type": [
"object",
"null"
]
},
"amp_version": {
"description": "Accelerated Mobile Pages
indicates whether an item has the Accelerated Mobile Page (AMP) version
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"cache_url": {
"description": "cached version of the page",
"type": [
"string",
"null"
]
},
"checks": {
"description": "array of properties detected for the SERP element
lists the properties that are true for this element
each value in the array represents a detected property
example:
if is_image is present in the array, the element contains an image
possible values in the array:is_image, is_video, is_featured_snippet, amp_version, is_malicious, is_web_story, is_highly_cited
equals null if none of the properties are detected for the element
learn more about the checks array in this Help Center article",
"items": {
"description": "indicates whether the element contains an_image
Note: this check no longer appears in SERP",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"extended_people_also_search": {
"description": "extension of the organic element
extension of the organic result containing related search queries
Note: extension appears in SERP upon clicking on the result and then bouncing back to search results",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"extended_snippet": {
"description": "includes additional information appended after the result description in SERP",
"type": [
"string",
"null"
]
},
"faq": {
"deprecated": true,
"description": "frequently asked questions
questions and answers extension shown below some of Google's search results
Note: this object is deprecated and always returns null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FaqBox"
}
],
"type": [
"object",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images": {
"description": "images of the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_featured_snippet": {
"description": "indicates whether the element is a featured_snippet
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_image": {
"description": "indicates whether the element contains an_image
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_malicious": {
"description": "indicates whether the element is marked as malicious
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_video": {
"description": "indicates whether the element contains a video
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_web_story": {
"description": "indicates whether the element is marked as Google web story
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"links": {
"description": "link of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"pre_snippet": {
"description": "includes additional information appended before the result description in SERP",
"type": [
"string",
"null"
]
},
"price": {
"description": "pricing details
contains the pricing details of the product or service featured in the result;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements found in SERPnote values are returned in the ascending order, with values corresponding to advanced SERP features omitted from the results;
to get all items (including SERP features and rich snippets) with their positions, please refer to the Google Organiс Advanced SERP endpoint",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"related_result": {
"description": "related result from the same domain
related result from the same domain appears as a part of the main result snippet;
you can derive the related_result snippets as \"type\": \"organic\" results by setting the group_organic_results parameter to false in the POST request",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedResult"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"related_search_url": {
"description": "URL to a similar search
URL to a new search for the same keyword(s) on related sites",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the results element in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "name of the website in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_OtherSitesReviewsInfo": {
"properties": {
"rating": {
"description": "rating in the review
information about the rating enclosed in the review on a third-party site",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"review_text": {
"description": "review text
text of the review",
"type": [
"string",
"null"
]
},
"title": {
"description": "review title
contains a name of the third-party site where review initially appeared",
"type": [
"string",
"null"
]
},
"url": {
"description": "review url
URL to the a third-party site where review initially appeared",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PageContentInfo": {
"properties": {
"comments": {
"description": "array of comments displayed on the page
contains objects with information on comments related to displayed products",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentCommentInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"contacts": {
"description": "contact information
contains contact information displayed on the page",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Contacts"
}
],
"type": [
"object",
"null"
]
},
"footer": {
"description": "content of the footer of the table
",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageSectionContentInfo"
}
],
"type": [
"object",
"null"
]
},
"header": {
"description": "parsed content of the header
",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PageSectionContentInfo"
}
],
"type": [
"object",
"null"
]
},
"main_topic": {
"description": "main topic on the page
you can find more information about topic priority calculation in this help center article
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopicInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"offers": {
"description": "array of products displayed on the page
contains objects with information on products displayed on the page",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentOfferInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"ratings": {
"description": "contains objects with rating information for the products displayed on the page
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContententRatingInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"secondary_topic": {
"description": "secondary topic on the page
you can find more information about topic priority calculation in this help center article
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopicInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PageMetaInfo": {
"properties": {
"broken_html": {
"description": "资源错误和警告",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourceIssueInfo"
}
],
"type": [
"object",
"null"
]
},
"canonical": {
"description": "规范页面",
"type": [
"string",
"null"
]
},
"charset": {
"description": "code pageexample: 65001",
"type": [
"integer",
"null"
]
},
"content": {
"description": "关于页面内容的总体信息",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlContentInfo"
}
],
"type": [
"object",
"null"
]
},
"cumulative_layout_shift": {
"description": "Core Web Vitals metric measuring the layout stability of the pagemeasures 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.",
"type": [
"number",
"null"
]
},
"deprecated_tags": {
"description": "页面上已弃用的标签",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "meta description 标签的内容",
"type": [
"string",
"null"
]
},
"description_length": {
"description": "description 标签的字符长度",
"type": [
"integer",
"null"
]
},
"duplicate_meta_tags": {
"description": "页面上重复的 meta 标签",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"external_links_count": {
"description": "页面上的外部链接数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"favicon": {
"description": "页面的 favicon",
"type": [
"string",
"null"
]
},
"follow": {
"description": "indicates whether a page's 'meta robots' allows crawlers to follow the links on the pageif false, the page's 'meta robots' tag contains \"nofollow\" parameter instructing crawlers not to follow the links on the page",
"type": [
"boolean",
"null"
]
},
"generator": {
"description": "meta 标签生成器",
"type": [
"string",
"null"
]
},
"htags": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"description": "HTML 标题标签",
"type": [
"object",
"null"
]
},
"images_count": {
"description": "页面上的图片数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"images_size": {
"description": "页面上图像的总大小，以字节为单位",
"type": [
"integer",
"null"
]
},
"inbound_links_count": {
"description": "指向该页面的内部链接数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"internal_links_count": {
"description": "页面上的内部链接数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"meta_keywords": {
"description": "keywords 元标签的内容",
"type": [
"string",
"null"
]
},
"meta_title": {
"description": "meta title of the pagemeta tag in the head section of an HTML document that defines the title of a page",
"type": [
"string",
"null"
]
},
"render_blocking_scripts_count": {
"description": "页面上阻塞页面渲染的脚本数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"render_blocking_stylesheets_count": {
"description": "页面上阻止页面渲染的 CSS 样式数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"scripts_count": {
"description": "页面上的脚本数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"scripts_size": {
"description": "页面上脚本的总大小，以字节为单位",
"type": [
"integer",
"null"
]
},
"social_media_tags": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "object of social media tags found on the pagecontains social media tags and their contentsupported tags include but are not limited to Open Graph and Twitter card",
"type": [
"object",
"null"
]
},
"spell": {
"description": "spellcheckhunspell spellcheck errors",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HunspellInfo"
}
],
"type": [
"object",
"null"
]
},
"stylesheets_count": {
"description": "页面上的样式表数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"stylesheets_size": {
"description": "页面上样式表的总大小，以字节为单位",
"type": [
"integer",
"null"
]
},
"title": {
"description": "页面标题",
"type": [
"string",
"null"
]
},
"title_length": {
"description": "title 标签的字符长度",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PageMetrics": {
"properties": {
"broken_links": {
"description": "number of broken links
number of broken links across all crawled pages on a target website",
"type": [
"integer",
"null"
]
},
"broken_resources": {
"description": "number of broken resources
the number of images and other resources with broken links",
"type": [
"integer",
"null"
]
},
"checks": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "page-specific on-page check-ups",
"type": [
"object",
"null"
]
},
"duplicate_content": {
"description": "number of pages with duplicate content",
"type": [
"integer",
"null"
]
},
"duplicate_description": {
"description": "number of pages with duplicate descriptions",
"type": [
"integer",
"null"
]
},
"duplicate_title": {
"description": "number of pages with duplicate titles",
"type": [
"integer",
"null"
]
},
"links_external": {
"description": "number of external links
the number of links pointing to other websites",
"type": [
"integer",
"null"
]
},
"links_internal": {
"description": "number of internal links
the number of links pointing to other pages within the target website",
"type": [
"integer",
"null"
]
},
"links_relation_conflict": {
"description": "number of links present on the target website that may have a conflict
for example, if \"links_relation_conflict\": 2, the target website is referring to the same source by at least one internal link with the rel=\"nofollow\" attribute and by at least one dofollow link",
"type": [
"integer",
"null"
]
},
"non_indexable": {
"description": "number of non-indexable pages
number of pages that are blocked from being indexed by Google and other search engines by robots.txt, HTTP headers, or meta tags settings;
you can receive a list of non-indexable URLs using this endpoint",
"type": [
"integer",
"null"
]
},
"onpage_score": {
"description": "shows how website is optimized on a 100-point scale
this field shows how website is optimized considering critical on-page issues and warnings detected;100 is the highest possible score that means website does not have any critical on-page issues and important warnings;
note that this value depends on the number of crawled pages;
learn more about how the metric is calculated in this help center article",
"type": [
"number",
"null"
]
},
"redirect_loop": {
"description": "number of redirect chains that start and end at the same URL
number of redirect chains where the destination URL redirects back to the original URL",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PageSectionContentInfo": {
"properties": {
"primary_content": {
"description": "primary content on the page
you can find more information about content priority calculation in this help center article
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SectionContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"secondary_content": {
"description": "secondary content on the page
you can find more information about content priority calculation in this help center article
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SectionContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"table_content": {
"description": "content of the table on the page
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TableContentInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PageSummary": {
"properties": {
"backlinks": {
"description": "indicates the number of backlinks",
"format": "int64",
"type": [
"integer",
"null"
]
},
"backlinks_spam_score": {
"description": "average spam score of the backlinks pointing to the page
learn more about how the metric is calculated on this help center page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_backlinks": {
"description": "number of broken backlinks
number of broken backlinks pointing to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"broken_pages": {
"description": "number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to",
"type": [
"integer",
"null"
]
},
"first_seen": {
"description": "date and time when our crawler found the backlink for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"lost_date": {
"description": "date and time when the last backlink for this page was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2017-01-24 13:20:59 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "page rank
rank of the pagerank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
},
"referring_domains": {
"description": "indicates the number of referring domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_domains_nofollow": {
"description": "number of domains pointing at least one nofollow link to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_ips": {
"description": "number of referring IP addresses
number of IP addresses pointing to this page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_links_attributes": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute",
"type": [
"object",
"null"
]
},
"referring_links_countries": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country",
"type": [
"object",
"null"
]
},
"referring_links_platform_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring platforms
indicates referring platform types and and link count per each platformcms, blogs, ecommerce, message-boards, wikis, news, organization",
"type": [
"object",
"null"
]
},
"referring_links_semantic_locations": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location
examples:article, section, summary",
"type": [
"object",
"null"
]
},
"referring_links_tld": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "top-level domains of the referring links
contains top level domains and referring link count per each",
"type": [
"object",
"null"
]
},
"referring_links_types": {
"additionalProperties": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": "types of referring links
indicates the types of the referring links and link count per each type
possible values:anchor, image, link, meta, canonical, alternate, redirect",
"type": [
"object",
"null"
]
},
"referring_main_domains": {
"description": "indicates the number of referring main domains",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_main_domains_nofollow": {
"description": "number of main domains pointing at least one nofollow link to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages": {
"description": "indicates the number of pages pointing to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_pages_nofollow": {
"description": "number of referring pages pointing at least one nofollow link to the page",
"format": "int64",
"type": [
"integer",
"null"
]
},
"referring_subnets": {
"description": "number of referring subnetworks",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PageTiming": {
"properties": {
"connection_time": {
"description": "time to connect to a serverthe time it takes until the connection with a server is established (in milliseconds)",
"type": [
"integer",
"null"
]
},
"dom_complete": {
"description": "time to load resourcesthe time it takes until the page and all of its subresources are downloaded (in milliseconds)",
"type": [
"integer",
"null"
]
},
"download_time": {
"description": "浏览器接收响应所需的时间（以毫秒为单位）",
"type": [
"integer",
"null"
]
},
"duration_time": {
"description": "浏览器从服务器接收到完整响应所需的总时间（以毫秒为单位）",
"type": [
"integer",
"null"
]
},
"fetch_end": {
"description": "time to complete downloading the HTML resourcethe amount of time the browser needs to complete downloading a page",
"type": [
"integer",
"null"
]
},
"fetch_start": {
"description": "time to start downloading the HTML resourcethe amount of time the browser needs to start downloading a page",
"type": [
"integer",
"null"
]
},
"first_input_delay": {
"description": "Core Web Vitals metric indicating the responsiveness of a pageThe time (in milliseconds) from when a user first interacts with your page to the time when the browser responds to that interaction. Learn more.",
"type": [
"number",
"null"
]
},
"largest_contentful_paint": {
"description": "Core Web Vitals metric measuring how fast the largest above-the-fold content element is displayedThe amount of time (in milliseconds) to render the largest content element visible in the viewport, from when the user requests the URL. Learn more.",
"type": [
"number",
"null"
]
},
"request_sent_time": {
"description": "time to send a request to a serverthe time it takes until the request to a server is sent (in milliseconds)",
"type": [
"integer",
"null"
]
},
"time_to_interactive": {
"description": "Time To Interactive (TTI) metricthe time it takes until the user can interact with a page (in milliseconds)",
"type": [
"integer",
"null"
]
},
"time_to_secure_connection": {
"description": "time to establish a secure connectionthe time it takes until the secure connection with a server is established (in milliseconds)",
"type": [
"integer",
"null"
]
},
"waiting_time": {
"description": "首字节时间（TTFB），单位为毫秒",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PaidSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"checks": {
"description": "array of properties detected for the SERP element
lists the properties that are true for this element
each value in the array represents a detected property
example:
if is_image is present in the array, the element contains an image
possible values in the array:is_image, is_video, is_featured_snippet, amp_version, is_malicious, is_web_story, is_highly_cited
equals null if none of the properties are detected for the element
learn more about the checks array in this Help Center article",
"items": {
"description": "indicates whether the element contains an_image
Note: this check no longer appears in SERP",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"description_rows": {
"description": "extended description
if there is none, equals null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"extra": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "additional information about the result",
"type": [
"object",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images": {
"description": "images of the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_image": {
"description": "indicates whether the element contains an_image
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_video": {
"description": "indicates whether the element contains a video
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"links": {
"description": "link of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AdLinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"price": {
"description": "pricing details
contains the pricing details of the product or service featured in the result;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP
absolute position among all the elements found in SERPnote values are returned in the ascending order, with values corresponding to advanced SERP features omitted from the results;
to get all items (including SERP features and rich snippets) with their positions, please refer to the Google Organiс Advanced SERP endpoint",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the results element in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": " relevant URL in SERP",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "name of the website in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_PeopleAlsoAskElement": {
"properties": {
"expanded_element": {
"description": "expanded element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiPeopleAlsoAskExpandedElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"seed_question": {
"description": "question that triggered additional expanded elements",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PeopleAlsoAskSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PeopleAlsoAskElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_PeopleAlsoSearch": {
"properties": {
"cid": {
"description": "google-defined client id
unique id of a local establishment
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the element in SERP
the name of the business entity for which the results are collected",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PeopleAlsoSearchSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_PeriodCovered": {
"properties": {
"displayed_date": {
"description": "period displayed in SERP
example:Mar 2, 2020 - Dec 9, 2022",
"type": [
"string",
"null"
]
},
"end_date": {
"description": "date and time when the period ends
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2022-12-09 02:00:00 +00:00",
"type": [
"string",
"null"
]
},
"start_date": {
"description": "date and time when the period starts
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2020-03-02 02:00:00 +00:00",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PerspectivesElement": {
"properties": {
"date": {
"description": "the date when the page source of the element was published",
"type": [
"string",
"null"
]
},
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PerspectivesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PerspectivesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_PodcastsElement": {
"properties": {
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"time_to_play": {
"description": "the total time it will take to play an episode",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:\n2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PodcastsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PodcastsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_PopularProductsElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"more_sellers": {
"description": "indicates whether the product is sold by multiple sellers",
"type": [
"boolean",
"null"
]
},
"price": {
"description": "price indicated in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"product_identifiers": {
"description": "identifiers of the product
can include the following identifiers: product_id, data_docid, gid",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ProductIdentifiers"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"seller": {
"description": "seller of the product",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PopularProductsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PopularProductsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_PopularTimes": {
"properties": {
"popular_times_by_days": {
"additionalProperties": {
"items": {
"description": "work hours on Sundays",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PopularWorkTimeInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "popular hours
information about busy hours of the local establishment on each day of the week",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PopularWorkTimeInfo": {
"properties": {
"popular_index": {
"description": "popularity index\nrelative time-bound popularity index measured from 0 to 100;\nhigher value corresponds to a busier time of a day",
"type": [
"integer",
"null"
]
},
"time": {
"description": "hours in the 24-hour format",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TimeInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PositiveConnotationDistribution": {
"properties": {
"negative": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"neutral": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"positive": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PreviewImage": {
"properties": {
"height": {
"description": "height of the preview image",
"type": [
"integer",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
},
"width": {
"description": "width of the preview image",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PreviewVideos": {
"properties": {
"duration_time": {
"description": "duration of the video",
"type": [
"string",
"null"
]
},
"duration_time_seconds": {
"description": "duration of the video in seconds",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the video",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PriceInfo": {
"properties": {
"currency": {
"description": "currency of the listed price\nISO code of the currency applied to the price",
"type": [
"string",
"null"
]
},
"current": {
"description": "current price\nindicates the current price of the product or service featured in the result",
"format": "double",
"type": [
"number",
"null"
]
},
"displayed_price": {
"description": "price string in the result\nraw price string as provided in the result",
"type": [
"string",
"null"
]
},
"is_price_range": {
"description": "price is provided as a range\nindicates whether a price is provided in a range",
"type": [
"boolean",
"null"
]
},
"max_value": {
"description": "the maximum price\nthe maximum price of the product or service as indicated in the result",
"format": "double",
"type": [
"number",
"null"
]
},
"regular": {
"description": "regular price\nindicates the regular price of the product or service with no discounts applied",
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_PricesByDates": {
"properties": {
"check_in_date": {
"type": [
"string",
"null"
]
},
"check_out_date": {
"type": [
"string",
"null"
]
},
"currency": {
"description": "price currencyUSD is applied by default, unless specified in the POST array",
"type": [
"string",
"null"
]
},
"price": {
"description": "price per night",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ProductConsiderationsElement": {
"properties": {
"consideration_category": {
"description": "category of the consideration element
the category is indicated just above the title fo the consideration element",
"type": [
"string",
"null"
]
},
"expanded_element": {
"description": "expanded element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiProductConsiderationExpandedElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ProductConsiderationsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ProductConsiderationsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ProductIdentifiers": {
"properties": {
"data_docid": {
"description": "unique identifier of the SERP data element
example:17363035694596624076",
"type": [
"string",
"null"
]
},
"gid": {
"description": "global product identifier on Google Shopping
example:4702526954592161872
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"product_id": {
"description": "unique product identifier on Google Shopping
example:4485466949985702538
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ProductInfoElement": {
"properties": {
"data_docid": {
"description": "unique identifier of the SERP data element
note that there is no full list of possible values as the data_docid is a dynamic value assigned by Google
example:17363035694596624076",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the product",
"type": [
"string",
"null"
]
},
"features": {
"description": "product features
contains snippets with the description of product features",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"gid": {
"description": "global product identifier on Google Shopping
note that there is no full list of possible values as the gid is a dynamic value assigned by Google
if there are no values, you will get null
example:4702526954592161872
learn more about gid in this help center guide",
"type": [
"string",
"null"
]
},
"images": {
"description": "product images
contains urls to product images",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"position": {
"description": "alignment of the element on the product specification page
can take the following values:right, left",
"type": [
"string",
"null"
]
},
"product_id": {
"description": "product_id received in a POST array
ilearn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank on the product specification page
absolute position among all the elements found on the product specification page",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "product rating
the popularity rate based on reviews",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"seller_reviews_count": {
"description": "number of seller reviews
number of reviews on the product seller's account",
"format": "int64",
"type": [
"integer",
"null"
]
},
"sellers": {
"description": "sellers of the product
number of reviews on the product seller's account",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ProductSeller"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"specifications": {
"description": "product specifications
contains all product attributes and related data listed on the product specification page",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ShoppingSpecification"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the product",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "product url
url of the product on Google Shopping",
"type": [
"string",
"null"
]
},
"variations": {
"description": "variations of the product
contains brief information about different product variations",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ProductVariation"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ProductInformationProductInformationDetailsItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonProductInformationElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"body": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "contains information specified about the product within the section_name",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ProductInformationProductInformationExtendedItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonProductInformationElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"contents": {
"description": "contains information specified about the product within the section_name",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ProductInformationRows"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ProductInformationProductInformationTextItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonProductInformationElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"text": {
"description": "text specified under the given title within the section_name",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ProductInformationRowProductInformationImageRowElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonProductInformationRowElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"alt": {
"description": "alternative text of the related product image",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the image",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ProductInformationRowProductInformationTextRowElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonProductInformationRowElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"text": {
"description": "text of the voucher",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ProductInformationRows": {
"properties": {
"rows": {
"description": "rows containing related product information",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantAmazonProductInformationRowElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title under which related product information appears on the Amazon product page",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ProductSeller": {
"properties": {
"delivery_info": {
"description": "delivery information
product delivery information",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_DeliveryInfo"
}
],
"type": [
"object",
"null"
]
},
"price": {
"description": "product price
product price details on the seller's website",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"product_availability": {
"description": "product availability information
can take the following values: in_stock, limited_stock, out_of_stock, backordered, pre_order_available, on_display_to_order",
"type": [
"string",
"null"
]
},
"seller_rating": {
"description": "rating of the seller",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingElement"
}
],
"type": [
"object",
"null"
]
},
"seller_review_count": {
"description": "number of seller reviews\nnumber of reviews on the product seller’s account",
"type": [
"integer",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "seller url
url of the page where the product is sold",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ProductVariation": {
"properties": {
"data_docid": {
"description": "unique identifier of the SERP data element in the POST array",
"type": [
"string",
"null"
]
},
"gid": {
"description": "GID ID in a POST array
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"product_id": {
"description": "product ID in a POST array
learn more about the parameter in this help center guide",
"type": [
"string",
"null"
]
},
"pvf": {
"description": "product variation filter
used in the product variation URL as the identifier of the specific product variation",
"type": [
"string",
"null"
]
},
"title": {
"description": "name of the product seller",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "product variation URL on Google Shopping",
"type": [
"string",
"null"
]
},
"variation_category": {
"description": "category of the product variation
example: \"Storage Capacity\"",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_QuestionsAndAnswersElement": {
"properties": {
"answer_text": {
"description": "answer included in the item",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"question_text": {
"description": "question included in the item",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
},
"votes": {
"description": "answer upvotes from the source",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_QuestionsAndAnswersSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_QuestionsAndAnswersElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_RankChanges": {
"properties": {
"is_down": {
"description": "rank went down
indicates how many ranked elements of this target went down in Google Search",
"type": [
"boolean",
"null"
]
},
"is_new": {
"description": "number of new ranked elements
indicates how many new ranked elements were found for this domain or webpage",
"type": [
"boolean",
"null"
]
},
"is_up": {
"description": "rank went up
indicates how many ranked elements of this target went up in Google Search",
"type": [
"boolean",
"null"
]
},
"previous_rank_absolute": {
"description": "previous absolute rank in SERP
indicates previous rank of the element in Google SERP;
if this element is new, the value will be null",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RankInfo": {
"properties": {
"main_domain_rank": {
"description": "average main domain rank
learn more about the metric and its calculation formula in this help center article",
"type": [
"integer",
"null"
]
},
"page_rank": {
"description": "page rank
page_rank is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm;
learn more about the metric and how it is calculated in this help center article",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RankedKeywordsInfo": {
"properties": {
"page_from_keywords_count_top_10": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"page_from_keywords_count_top_100": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"page_from_keywords_count_top_3": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RankedSerpElement": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"is_lost": {
"description": "lost ranked elements
indicates how many ranked elements of this target were previously presented in SERPs, but weren't found during the last check",
"type": [
"boolean",
"null"
]
},
"keyword_difficulty": {
"description": "difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
learn more about the metric in this help center guide",
"type": [
"integer",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"previous_updated_time": {
"description": "previous to the most recent date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-10-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "number of search results for the returned keyword",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"serp_item": {
"description": "contains data on the SERP element
the list of supported SERP elements can be found below",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseDataforseoLabsApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"serp_item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP
possible item types:
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses, ai_overview;
note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RatingElement": {
"properties": {
"position": {
"description": "the alignment of the element in Google Shopping SERP
possible values:left, right",
"type": [
"string",
"null"
]
},
"rating_max": {
"description": "rating_type 的最大值",
"type": [
"integer",
"null"
]
},
"rating_type": {
"description": "the type of rating
here you can find the following elements: Max5, Percents, CustomMax",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"value": {
"description": "value of the rating",
"type": [
"number",
"null"
]
},
"votes_count": {
"description": "the amount of feedback",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RatingInfo": {
"properties": {
"rating_max": {
"description": "rating_type 的最大值",
"type": [
"integer",
"null"
]
},
"rating_type": {
"description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax",
"type": [
"string",
"null"
]
},
"value": {
"description": "评级值",
"format": "double",
"type": [
"number",
"null"
]
},
"votes_count": {
"description": "反馈数量",
"format": "int64",
"type": [
"integer",
"null"
]
}
}
},
"Response0A3E90081762_ReasoningAiOptimizationLlmResponseElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseAiOptimizationLlmResponseElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"sections": {
"description": "reasoning chain sections
array of objects containing the reasoning chain sections generated by the LLM",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LocalJustificationInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_RecipesElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"time": {
"description": "the total time it takes to prepare the cook the dish",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RecipesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RecipesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_RefineProductsElement": {
"properties": {
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"keyword": {
"description": "keyword for the related refined search",
"type": [
"string",
"null"
]
},
"refine_type": {
"description": "type of search refinement",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RefineProductsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefineProductsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_RefinementChipsElement": {
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"options": {
"description": "further search refinement options",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "元素标题",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RefinementChipsInfo": {
"properties": {
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "元素的 XPath",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RelatedImageSearchesElement": {
"deprecated": true,
"properties": {
"alt": {
"description": "alt tag of the image",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RelatedResult": {
"properties": {
"about_this_result": {
"deprecated": true,
"description": "contains information from the 'About this result' panel
Note: this object is deprecated and always returns null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AboutThisResultElement"
}
],
"type": [
"object",
"null"
]
},
"amp_version": {
"description": "Accelerated Mobile Pages
indicates whether an item has the Accelerated Mobile Page (AMP) version
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"cache_url": {
"description": "cached version of the page",
"type": [
"string",
"null"
]
},
"checks": {
"description": "array of properties detected for the SERP element
lists the properties that are true for this element
each value in the array represents a detected property
example:
if is_image is present in the array, the element contains an image
possible values in the array:is_image, is_video, is_featured_snippet, amp_version, is_malicious, is_web_story, is_highly_cited
equals null if none of the properties are detected for the element
learn more about the checks array in this Help Center article",
"items": {
"description": "indicates whether the element contains an_image
Note: this check no longer appears in SERP",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "website domain",
"type": [
"string",
"null"
]
},
"extended_snippet": {
"description": "includes additional information appended after the result description in SERP",
"type": [
"string",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images": {
"description": "images of the component
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_image": {
"description": "indicates whether the element contains an_image
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"is_video": {
"description": "indicates whether the element contains a video
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"page": {
"description": "search results page number
indicates the number of the SERP page on which the element is located",
"type": [
"integer",
"null"
]
},
"pre_snippet": {
"description": "includes additional information appended before the result description in SERP",
"type": [
"string",
"null"
]
},
"price": {
"description": "price of booking a place for the specified dates of stay",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"related_search_url": {
"description": "URL to a similar search
URL to a new search for the same keyword(s) on related sites",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "name of the website in the ad element",
"type": [
"string",
"null"
]
},
"xpath": {
"description": "the XPath of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RelatedSearchesElement": {
"properties": {
"image_alt": {
"description": "结果中展示的产品图片的 alt 标签",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "结果中展示的产品图片 URL",
"type": [
"string",
"null"
]
},
"title": {
"description": "产品标题",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "产品页面的 URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RelatedSearchesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseMerchantGoogleShoppingProductsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_RelatedSearchesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ResourceMetaInfo": {
"properties": {
"alternative_text": {
"description": "content of the image alt attribute",
"type": [
"string",
"null"
]
},
"height": {
"description": "图像高度（px）",
"format": "double",
"type": [
"number",
"null"
]
},
"original_height": {
"description": "原始图像高度（单位：px）",
"format": "double",
"type": [
"number",
"null"
]
},
"original_width": {
"description": "原始图像宽度（px）",
"format": "double",
"type": [
"number",
"null"
]
},
"title": {
"description": "标题",
"type": [
"string",
"null"
]
},
"width": {
"description": "图片宽度（px）",
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ResponseDataInfo": {
"properties": {
"author": {
"description": "author of the response",
"type": [
"string",
"null"
]
},
"text": {
"description": "content of the response",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the response was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the response
in this case, will equal null",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ResultAvailableLanguages": {
"properties": {
"available_platforms": {
"description": "supported LLM platforms
contains the sources of data supported for a specific location and language combination
only google and chat_gpt are currently available",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
},
"responses_count": {
"description": "number of LLM responses
the number of LLM responses available in the database for the certain location and language parameters",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ReviewHighlights": {
"properties": {
"assessment": {
"description": "feature assessment",
"type": [
"string",
"null"
]
},
"feature": {
"description": "reviewed feature",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ReviewMentionInfo": {
"properties": {
"negative_count": {
"description": "count of negative reviews by criterion",
"format": "int64",
"type": [
"integer",
"null"
]
},
"positive_count": {
"description": "count of positive reviews by criterion",
"format": "int64",
"type": [
"integer",
"null"
]
},
"positive_score": {
"description": "positive score by criterion",
"type": [
"number",
"null"
]
},
"title": {
"description": "title of the evaluated criterion",
"type": [
"string",
"null"
]
},
"total_count": {
"description": "count of all reviews by criterion",
"format": "int64",
"type": [
"integer",
"null"
]
},
"visible_by_default": {
"description": "element is visible by default
indicates whether the review element is visible by default",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ReviewResponseItemInfo": {
"properties": {
"text": {
"description": "the content of response",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "the time of publication",
"type": [
"string",
"null"
]
},
"title": {
"description": "the title of response",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_RowCellInfo": {
"properties": {
"is_header": {
"description": "表头行单元格的内容",
"type": [
"boolean",
"null"
]
},
"text": {
"description": "表头行单元格的内容",
"type": [
"string",
"null"
]
},
"urls": {
"description": "包含在内容元素中找到的其他 URL 和锚文本",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentUrlInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ScholarlyArticlesElement": {
"properties": {
"author": {
"description": "author",
"type": [
"string",
"null"
]
},
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ScholarlyArticlesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ScholarlyArticlesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ScreenshotItem": {
"properties": {
"image": {
"description": "screenshot of the requested page
URL of the page screenshot on the DataForSEO storage
note: the page screenshot saved on the DataForSEO storage only remains accessible for one day after making the request",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SearchIntentInfo": {
"properties": {
"foreign_intent": {
"description": "supplementary search intents
possible values: informational, navigational, commercial, transactional",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"main_intent": {
"description": "main search intent
possible values: informational, navigational, commercial, transactional",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SearchResults": {
"properties": {
"breadcrumb": {
"description": "breadcrumb",
"type": [
"string",
"null"
]
},
"description": {
"description": "result description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "source domain",
"type": [
"string",
"null"
]
},
"publication_date": {
"description": "date and time when the result was published
in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "rank in the results",
"type": [
"integer",
"null"
]
},
"title": {
"description": "source title",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SearchVolumeHistoryItemInfo": {
"description": "device type = desktop\ncontains historical search volume data for searches made from desktop devices",
"properties": {
"day": {
"description": "day of the month",
"type": [
"integer",
"null"
]
},
"month": {
"description": "month",
"type": [
"integer",
"null"
]
},
"search_volume": {
"description": "search volume rate",
"format": "int64",
"type": [
"integer",
"null"
]
},
"year": {
"description": "year",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SearchVolumeHistorySearchInfo": {
"properties": {
"desktop": {
"description": "device type = desktop
contains historical search volume data for searches made from desktop devices",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchVolumeHistoryItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"mobile": {
"description": "device type = mobile
contains historical search volume data for searches made from mobile devices",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchVolumeHistoryItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"non_smartphones": {
"description": "device type = non-smartphones
contains historical search volume data for searches made from feature phones (non-smartphone mobile devices)",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchVolumeHistoryItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"tablet": {
"description": "device type = tablet
contains historical search volume data for searches made from tablets",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SearchVolumeHistoryItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SearchVolumeTrend": {
"properties": {
"monthly": {
"description": "search volume change in percent compared to the previous month",
"type": [
"integer",
"null"
]
},
"quarterly": {
"description": "search volume change in percent compared to the previous quarter",
"type": [
"integer",
"null"
]
},
"yearly": {
"description": "search volume change in percent compared to the previous year",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SectionContentItemInfo": {
"properties": {
"text": {
"description": "secondary content on the page\nyou can find more information about content priority calculation in this help center article",
"type": [
"string",
"null"
]
},
"url": {
"description": "page URL.\ndisplayed in case the text is a link anchor",
"type": [
"string",
"null"
]
},
"urls": {
"description": "包含在内容元素中找到的其他 URL 和锚文本",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentUrlInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SentimentConnotationDistribution": {
"properties": {
"anger": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"fun": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"happiness": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"love": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"sadness": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
},
"share": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ContentAnalysisSummaryInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpAiSummaryItem": {
"properties": {
"summary": {
"description": "generated summary
summary generated by the AI model according to the parameters specified in the request",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpAiSummaryResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpAiSummaryTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpAiSummaryResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpAiSummaryItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpAiSummaryTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpAiSummaryResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAdsAdvertiserElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAdsAdvertiserElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"advertiser_id": {
"description": "unique identifier of the advertiser account
can be used to obtain data on advertising campaigns from the Google Ads Search endpoint",
"type": [
"string",
"null"
]
},
"approx_ads_count": {
"description": "ads count
the approximate number of ads that are run by the advertiser across all available Google Ads platforms",
"format": "int64",
"type": [
"integer",
"null"
]
},
"location": {
"description": "advertiser location",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"verified": {
"description": "verified advertiser account
equals true if advertiser account is verified by Google Ads",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAdsDomainElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAdsAdvertiserElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAdsMultiAccountAdvertiserElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAdsAdvertiserElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"advertisers": {
"description": "associated advertiser accounts
contains objects with data on associated advertiser accounts",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Advertiser"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"approx_ads_count": {
"description": "ads count
the approximate number of ads that are run by the advertiser across all available Google Ads platforms",
"format": "int64",
"type": [
"integer",
"null"
]
},
"location": {
"description": "advertiser location",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiModeAiOverviewElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"images": {
"description": "images of the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "website links featured in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeLinkElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format",
"type": [
"string",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "text or description of the element in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiModeAiOverviewExpandedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"components": {
"description": "array of components of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewExpandedComponentInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"references": {
"description": "additional references relevant to the item
includes references to webpages that may have been used to generate the ai_overview",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "reference text
text snippet from the page that was used to generate the ai_overview_element",
"type": [
"string",
"null"
]
},
"title": {
"description": "link anchor text",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiModeAiOverviewPaidItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewPaidElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
the text of the ai_overview_paid formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"text": {
"description": "introductory text of the element in the response
text preceding the paid ad items",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiModeAiOverviewShoppingItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewShoppingElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
the text of the ai_overview formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the link",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiModeAiOverviewTableElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"markdown": {
"description": "text of the component in the markdwon format",
"type": [
"string",
"null"
]
},
"table": {
"description": "table present in the element
the header and content of the table present in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeTableInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiModeAiOverviewVideoElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiModeAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"date": {
"description": "date when the video was published or indexed
example: Apr 26, 2024",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain name of the reference",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "additional information for the video",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the video was published or indexed
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiOverviewElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"images": {
"description": "images of the element
if there is none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "website links featured in the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format",
"type": [
"string",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "additional text of the element in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiOverviewExpandedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"components": {
"description": "array of components of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOverviewExpandedComponent"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "additional text of the element in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiOverviewTableElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"markdown": {
"description": "content of the element in markdown format",
"type": [
"string",
"null"
]
},
"table": {
"description": "table element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiAiOverviewVideoElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"date": {
"description": "date when the video was published or indexed
example: Apr 26, 2024",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in link",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "additional information for the video",
"type": [
"string",
"null"
]
},
"source": {
"description": "web source of the shopping element
indicates the source of information included in the element",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the video was published or indexed
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
},
"url": {
"description": "reference page URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiBingAiOverviewElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiBingAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"images": {
"description": "images of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:
left, right",
"type": [
"string",
"null"
]
},
"references": {
"description": "references relevant to the element
includes references to webpages that were used to generate the ai_overview_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"text": {
"description": "text or description of the element in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiBingAiOverviewImagesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiBingAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items featured in the faq_box",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the link element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL link",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiBingAiOverviewOrganicElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiBingAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"links": {
"description": "links featured in the faq_box_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"snippet": {
"description": "text snippet from the organic result",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the link",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL ",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "website name in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiBingAiOverviewVideoElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiBingAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"date": {
"description": "the date when the page source of the element was published",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:
left, right",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "text snippet of the video",
"type": [
"string",
"null"
]
},
"source": {
"description": "source of the element
indicates the source of information included in the questions_and_answers_element",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "link anchor text",
"type": [
"string",
"null"
]
},
"url": {
"description": "link URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiBingAiOverviewVideosElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiBingAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_VideoElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiCarouselElement": {
"properties": {
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"subtitle": {
"description": "subtitle of the element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceAboutElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"ceo": {
"description": "Chief Executive Officer of the company",
"type": [
"string",
"null"
]
},
"description": {
"description": "company description",
"type": [
"string",
"null"
]
},
"description_source_url": {
"description": "source of information provided in description",
"type": [
"string",
"null"
]
},
"displayed_name": {
"description": "displayed name of the market index
example: E-mini Dow ($5)",
"type": [
"string",
"null"
]
},
"employees": {
"description": "number of company employees",
"type": [
"integer",
"null"
]
},
"founded": {
"description": "date when the company was founded
in the format: \"yyyy-mm-ddThh-mm-ssZ\"
example:1993-04-05T00:00:00Z",
"type": [
"string",
"null"
]
},
"headquarters": {
"description": "company headquarters",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"website": {
"description": "company website",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceAssetPairElementElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"base_display_name": {
"description": "full name of the base asset in a pair
example: Euro",
"type": [
"string",
"null"
]
},
"base_symbol": {
"description": "identifier of the base asset in a pair
example: EUR",
"type": [
"string",
"null"
]
},
"displayed_name": {
"description": "name of the market index as displayed on Google Finance
example: CAC 40",
"type": [
"string",
"null"
]
},
"identifier": {
"description": "identifier of the element
full identifier of the element that consists from ticker and market_identifier
example: PX1:INDEXDB",
"type": [
"string",
"null"
]
},
"location": {
"description": "location of the market index
example: Europe/Paris",
"type": [
"string",
"null"
]
},
"percentage_delta": {
"description": "percentage of change in value of the market index",
"type": [
"number",
"null"
]
},
"price": {
"description": "value of the base asset compared to the quote asset",
"type": [
"number",
"null"
]
},
"price_delta": {
"description": "change in price
change in price at a given timestamp",
"type": [
"number",
"null"
]
},
"quote_display_name": {
"description": "full name of the base asset in a pair
example: Euro",
"type": [
"string",
"null"
]
},
"quote_symbol": {
"description": "identifier of the quote asset in a pair
example: USD",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"trend": {
"description": "growth trend of the market index
possible values: up, down, stable",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the page of the market index on Google Finance",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceAssetPairElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceTickerSearchElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"base_display_name": {
"description": "full name of the base asset in a pair
example: Euro",
"type": [
"string",
"null"
]
},
"base_symbol": {
"description": "identifier of the base asset in a pair
example: EUR",
"type": [
"string",
"null"
]
},
"price": {
"description": "value of the base asset compared to the quote asset",
"type": [
"number",
"null"
]
},
"price_delta": {
"description": "change in price
change in price at a given timestamp",
"type": [
"number",
"null"
]
},
"quote_display_name": {
"description": "full name of the base asset in a pair
example: Euro",
"type": [
"string",
"null"
]
},
"quote_symbol": {
"description": "identifier of the quote asset in a pair
example: USD",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceCompareToElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceDetailsElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"avg_volume": {
"description": "average volume value",
"type": [
"number",
"null"
]
},
"badges": {
"description": "google finance badges relevant to the element
example: Futures Contract",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"category": {
"description": "category name",
"type": [
"string",
"null"
]
},
"cdp_climate_change_score": {
"description": "climate change score by carbon disclosure project methodology",
"type": [
"string",
"null"
]
},
"dividend_yield": {
"description": "dividend yield value",
"type": [
"number",
"null"
]
},
"end_day_range": {
"description": "value of the end day range",
"type": [
"number",
"null"
]
},
"end_year_range": {
"description": "value of the end year range",
"type": [
"number",
"null"
]
},
"expense_ratio": {
"description": "expense ratio value",
"type": [
"number",
"null"
]
},
"front_load": {
"description": "front load value",
"type": [
"number",
"null"
]
},
"market_cap": {
"description": "market cap value",
"type": [
"number",
"null"
]
},
"market_segment": {
"description": "name of the relevant market segment",
"type": [
"string",
"null"
]
},
"metrics_currency": {
"description": "currency of the metrics",
"type": [
"string",
"null"
]
},
"net_assets": {
"type": [
"number",
"null"
]
},
"open_interest": {
"description": "open interest value",
"type": [
"number",
"null"
]
},
"pe_ratio": {
"description": "price-earnings ratio",
"type": [
"number",
"null"
]
},
"previous_close": {
"description": "value of the previous close",
"type": [
"number",
"null"
]
},
"primary_exchange": {
"description": "primary exchange value",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"settlement_price": {
"description": "settlement price value",
"type": [
"number",
"null"
]
},
"start_day_range": {
"description": "value of the start day range",
"type": [
"number",
"null"
]
},
"start_year_range": {
"description": "value of the start year range",
"type": [
"number",
"null"
]
},
"volume": {
"description": "total volume value",
"type": [
"number",
"null"
]
},
"yield": {
"description": "yield value",
"type": [
"number",
"null"
]
},
"ytd_return": {
"description": "year-to-date return value",
"type": [
"number",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceEarningsCalendarElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceEarningsCalendarElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceExploreMarketTrendsElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"sub_title": {
"description": "sub-title of the market trends element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the market trends element
example: Europe, Middle East, and Africa",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to finance pair on Google Finance",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceFinancialElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"annual_metrics": {
"description": "annual google finance metrics",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceMetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"quarterly_metrics": {
"description": "quarterly google finance metrics",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceMetricsBundleInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceFuturesChainElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"markets": {
"description": "financial markets data
array of items containing market indexes and other financial information related to these indexes",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceFuturesChainElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceHeroGroupsElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"markets": {
"description": "financial markets data
array of items containing market indexes and other financial information related to these indexes",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Markets"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceInterestedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceMarketIndexElementElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"displayed_name": {
"description": "name of the market index as displayed on Google Finance
example: CAC 40",
"type": [
"string",
"null"
]
},
"identifier": {
"description": "identifier of the element
full identifier of the element that consists from ticker and market_identifier
example: PX1:INDEXDB",
"type": [
"string",
"null"
]
},
"index_value": {
"description": "value of the market index
numerical value of the index at a given timestamp",
"type": [
"number",
"null"
]
},
"index_value_delta": {
"description": "change in value of the market index
change in the index_value at a given timestamp",
"type": [
"number",
"null"
]
},
"location": {
"description": "location of the market index
example: Europe/Paris",
"type": [
"string",
"null"
]
},
"market_identifier": {
"description": "market identifier
example: INDEXDB",
"type": [
"string",
"null"
]
},
"percentage_delta": {
"description": "percentage of change in value of the market index",
"type": [
"number",
"null"
]
},
"ticker": {
"description": "ticker of the market index
example: DAX",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"trend": {
"description": "growth trend of the market index
possible values: up, down, stable",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the page of the market index on Google Finance",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceMarketIndexElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceTickerSearchElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"index_value": {
"description": "value of the market index
numerical value of the index at a given timestamp",
"type": [
"number",
"null"
]
},
"index_value_delta": {
"description": "change in value of the market index
change in the index_value at a given timestamp",
"type": [
"number",
"null"
]
},
"market_identifier": {
"description": "market identifier
example: INDEXDB",
"type": [
"string",
"null"
]
},
"ticker": {
"description": "ticker of the market index
example: DAX",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceMarketInstrumentElementElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"displayed_name": {
"description": "name of the market index as displayed on Google Finance
example: CAC 40",
"type": [
"string",
"null"
]
},
"identifier": {
"description": "identifier of the element
full identifier of the element that consists from ticker and market_identifier
example: PX1:INDEXDB",
"type": [
"string",
"null"
]
},
"location": {
"description": "location of the market index
example: Europe/Paris",
"type": [
"string",
"null"
]
},
"percentage_delta": {
"description": "percentage of change in value of the market index",
"type": [
"number",
"null"
]
},
"price": {
"description": "value of the base asset compared to the quote asset",
"type": [
"number",
"null"
]
},
"price_currency": {
"description": "price currency
example: USD",
"type": [
"string",
"null"
]
},
"price_delta": {
"description": "change in price
change in price at a given timestamp",
"type": [
"number",
"null"
]
},
"ticker": {
"description": "ticker of the market index
example: DAX",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time of the value readout
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2025-02-10 09:40:00 +00:00",
"type": [
"string",
"null"
]
},
"trend": {
"description": "growth trend of the market index
possible values: up, down, stable",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the page of the market index on Google Finance",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceMarketInstrumentElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceTickerSearchElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"price": {
"description": "value of the base asset compared to the quote asset",
"type": [
"number",
"null"
]
},
"price_currency": {
"description": "price currency
example: USD",
"type": [
"string",
"null"
]
},
"price_delta": {
"description": "change in price
change in price at a given timestamp",
"type": [
"number",
"null"
]
},
"ticker": {
"description": "ticker of the market index
example: DAX",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceMarketTrendsElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreAdvancedItem"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceMostFollowedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceNewsElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceNewsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"sub_title": {
"description": "sub-title of the news element
example: Based on Europe, Middle East, and Africa",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the news element
example: In the news",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinancePeopleAlsoSearchElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "market indexes data
array of items containing market indexes data;
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleFinanceQuoteElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"graph_items": {
"description": "values on graph",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GraphItems"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"quote": {
"description": "quoted market indexes",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleImagesCarouselElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpApiCarouselElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"page": {
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP
note: calculate_rectangles parameter is not yet available when setting tasks for this search engine type, that’s why rectangle always equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleImagesImagesSearchElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"alt": {
"description": "the alt tag of the image",
"type": [
"string",
"null"
]
},
"encoded_url": {
"description": "the URL of the cached version of the image stored on Google's servers",
"type": [
"string",
"null"
]
},
"source_url": {
"description": "the URL of the source image",
"type": [
"string",
"null"
]
},
"subtitle": {
"description": "subtitle of the result in SERP",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleImagesRelatedSearchesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items of the element",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"page": {
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left, right",
"type": [
"string",
"null"
]
},
"rectangle": {
"description": "rectangle parameters
contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP
note: calculate_rectangles parameter is not yet available when setting tasks for this search engine type, that’s why rectangle always equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeRectangleInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleNewsNewsSearchElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleNewsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "snippet of the result in SERP",
"type": [
"string",
"null"
]
},
"time_published": {
"description": "indicates the time the result was published",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the news was published
in the format “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"url": {
"description": "search URL with refinement parameters",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleNewsTopStoriesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleNewsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopStoriesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"page": {
"type": [
"integer",
"null"
]
},
"position": {
"description": "the alignment of the element in SERP
can take the following values:left",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleSearchByImagesImagesElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleSearchByImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"related_image_searches": {
"deprecated": true,
"description": "contains keywords and images related to the specified search term
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedImageSearchesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiGoogleSearchByImagesOrganicElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleSearchByImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"about_this_result": {
"deprecated": true,
"description": "contains information from the 'About this result' panel
'About this result' panel provides additional context about why Google returned this result for the given query;
this feature appears after clicking on the three dots next to most results",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AboutThisResultElement"
}
],
"type": [
"object",
"null"
]
},
"amp_version": {
"description": "Accelerated Mobile Pages
indicates whether an item has the Accelerated Mobile Page (AMP) version",
"type": [
"boolean",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb in SERP",
"type": [
"string",
"null"
]
},
"cache_url": {
"description": "cached version of the page",
"type": [
"string",
"null"
]
},
"checks": {
"items": {
"description": "indicates whether the element contains a video",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": {
"description": "description of the results element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"extended_people_also_search": {
"description": "extension of the organic element
extension of the organic result containing related search queries
Note: extension appears in SERP upon clicking on the result and then bouncing back to search results",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"extended_snippet": {
"description": "includes additional information appended after the result description in SERP",
"type": [
"string",
"null"
]
},
"faq": {
"deprecated": true,
"description": "frequently asked questions
questions and answers extension shown below some of Google's search results
if there are none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_FaqBox"
}
],
"type": [
"object",
"null"
]
},
"highlighted": {
"description": "words highlighted in bold within the results description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"images": {
"description": "images of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_featured_snippet": {
"description": "indicates whether the element is a featured_snippet",
"type": [
"boolean",
"null"
]
},
"is_image": {
"description": "indicates whether the element contains an image",
"type": [
"boolean",
"null"
]
},
"is_malicious": {
"description": "indicates whether the element is marked as malicious",
"type": [
"boolean",
"null"
]
},
"is_video": {
"description": "indicates whether the element contains a video",
"type": [
"boolean",
"null"
]
},
"is_web_story": {
"description": "indicates whether the element is marked as Google web story",
"type": [
"boolean",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"pre_snippet": {
"description": "includes additional information appended before the result description in SERP",
"type": [
"string",
"null"
]
},
"price": {
"description": "pricing details
contains the pricing details of the product or service featured in the result",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"related_result": {
"description": "related result from the same domain
related result from the same domain appears as a part of the main result snippet;
you can derive the related_result snippets as \"type\": \"organic\" results by setting the group_organic_results parameter to false in the POST request",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RelatedResult"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"related_search_url": {
"description": "URL to a similar search
URL to a new search for the same keyword(s) on related sites",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"website_name": {
"description": "name of the website in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphAiOverviewItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"asynchronous_ai_overview": {
"description": "indicates whether the element is loaded asynchronously
if true, the ai_overview element is loaded asynchronously;
if false, the ai_overview element is loaded from cache;
to obtain the content of ai_overview elements, use the load_async_ai_overview parameter in the POST request",
"type": [
"boolean",
"null"
]
},
"items": {
"description": "contains results featured in the 'hotels_pack' element of SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"references": {
"description": "additional references relevant to the item
includes references to webpages that may have been used to generate the ai_overview",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphCarouselItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:action:listen_artist",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphListElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphDescriptionItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"text": {
"description": "text or description of the element in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphExpandedItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:kc:/local:place qa",
"type": [
"string",
"null"
]
},
"expanded_element": {
"description": "link of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphExpandedElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the result in SERP",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphHotelsBookingItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:kc:/local:hotel booking",
"type": [
"string",
"null"
]
},
"date_from": {
"description": "starting date of stay
in the format “year-month-date”
example:
2019-11-15",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "ending date of stay
in the format “year-month-date”
example:
2019-11-17",
"type": [
"string",
"null"
]
},
"items": {
"description": "popular keywords relevant to the initial search query
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphHotelsBookingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphImagesItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphImagesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphListItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:ss:/webfacts:net_worth",
"type": [
"string",
"null"
]
},
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphListElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"link": {
"description": "link of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the item",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphPartItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:kc:/local:place qa",
"type": [
"string",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"text": {
"description": "reference text
text snippet from the page that was used to generate the ai_overview_element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the place",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphRowItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:kc:/common/topic:social media presence",
"type": [
"string",
"null"
]
},
"links": {
"description": "sitelinks
the links shown below some of Google's search results
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LinkElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"text": {
"description": "reference text
text snippet from the page that was used to generate the ai_overview_element",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the link",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiKnowledgeGraphShoppingItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiKnowledgeGraphElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"data_attrid": {
"description": "google defined data attribute ID
example:kc:/shopping/gpc:organic-offers",
"type": [
"string",
"null"
]
},
"items": {
"description": "keywords relevant to the initial search query
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_KnowledgeGraphShoppingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiMapsPaidItemElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleMapsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiMapsSearchElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleMapsElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"additional_categories": {
"description": "additional business categories
additional Google My Business categories that describe the services provided by the business entity in more detail",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"address": {
"description": "address line
address of the local establishment featured in the element",
"type": [
"string",
"null"
]
},
"address_info": {
"description": "object containing address components of the local establishment",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AddressInfo"
}
],
"type": [
"object",
"null"
]
},
"book_online_url": {
"description": "URL in the 'book online' button of the element
URL directing users to the online booking or order page of the business entity",
"type": [
"string",
"null"
]
},
"category": {
"description": "business category
Google My Business general category that best describes the services provided by the business entity",
"type": [
"string",
"null"
]
},
"category_ids": {
"description": "global category IDs
universal category IDs that do not change based on the selected country",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"cid": {
"description": "google-defined client id
unique id of a local establishment;
can be used with Google Reviews API to get a full list of reviews",
"type": [
"string",
"null"
]
},
"contact_url": {
"description": "URL of the preferred contact page",
"type": [
"string",
"null"
]
},
"contributor_url": {
"description": "URL of the user's or entity's Local Guides profile, if available",
"type": [
"string",
"null"
]
},
"feature_id": {
"description": "the unique identifier of the element in SERP",
"type": [
"string",
"null"
]
},
"hotel_rating": {
"description": "hotel class rating
class ratings range between 1-5 stars, learn more
if there is no hotel class rating information, the value will be null",
"type": [
"number",
"null"
]
},
"is_claimed": {
"description": "indicates whether ownership of this local establishment is claimed",
"type": [
"boolean",
"null"
]
},
"is_directory_item": {
"description": "indicates whether this local establishment is a directory ",
"type": [
"boolean",
"null"
]
},
"latitude": {
"description": "latitude coordinate of the local establishments in google maps
example:\"latitude\": 51.584091",
"type": [
"number",
"null"
]
},
"local_justifications": {
"description": "Google local justifications
snippets of text that \"justify\" why the business is showing up for search query",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LocalJustificationInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"longitude": {
"description": "longitude coordinate of the local establishment in google maps
example:\"longitude\": -0.31365919999999997",
"type": [
"number",
"null"
]
},
"main_image": {
"description": "URL of the main image featured in Google My Business profile",
"type": [
"string",
"null"
]
},
"original_title": {
"description": "original title of the element
original title not translated by Google",
"type": [
"string",
"null"
]
},
"phone": {
"description": "phone number
phone number of the local establishment featured in the element",
"type": [
"string",
"null"
]
},
"place_id": {
"description": "unique place identifier
place id of the local establishment featured in the element",
"type": [
"string",
"null"
]
},
"price_level": {
"description": "property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "element snippet
contains the address and other information about the local establishment featured in the element",
"type": [
"string",
"null"
]
},
"total_photos": {
"description": "total count of images featured in Google My Business profile",
"format": "int64",
"type": [
"integer",
"null"
]
},
"work_hours": {
"description": "open hours
information about work hours of the local establishment",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_WorkHours"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiPeopleAlsoAskAiOverviewExpandedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiPeopleAlsoAskExpandedElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"asynchronous_ai_overview": {
"description": "indicates whether the element is loaded asynchronously
if true, the people_also_ask_ai_overview_expanded_element element is loaded asynchronously;
if false, the people_also_ask_ai_overview_expanded_element element is loaded from cache",
"type": [
"boolean",
"null"
]
},
"items": {
"description": "items present in the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAiOverviewElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"references": {
"description": "additional references relevant to the item
includes references to webpages that may have been used to generate the ai_overview",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiPeopleAlsoAskExpandedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiPeopleAlsoAskExpandedElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"description": {
"description": "description",
"type": [
"string",
"null"
]
},
"domain": {
"description": "source domain",
"type": [
"string",
"null"
]
},
"featured_title": {
"description": "the title of the featured snippets source page",
"type": [
"string",
"null"
]
},
"images": {
"description": "images of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeImagesElementInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"table": {
"description": "results table
if there are none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the carousel item",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiProductConsiderationsAiOverviewExpandedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiProductConsiderationExpandedElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "items present in the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOverviewElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"references": {
"description": "additional references relevant to the item
includes references to webpages that may have been used to generate the ai_overview",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewReferenceInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiProductConsiderationsExpandedElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiProductConsiderationExpandedElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"about_this_result": {
"deprecated": true,
"description": "contains information from the 'About this result' panel
Note: this object is deprecated and always returns null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AboutThisResultElement"
}
],
"type": [
"object",
"null"
]
},
"breadcrumb": {
"description": "breadcrumb of the Ad element in SERP",
"type": [
"string",
"null"
]
},
"domain": {
"description": "source domain",
"type": [
"string",
"null"
]
},
"featured_title": {
"description": "the title of the featured snippets source page",
"type": [
"string",
"null"
]
},
"related_searches": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the carousel item",
"type": [
"string",
"null"
]
},
"url": {
"description": "relevant URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiYoutubeChannelElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiYoutubeOrganicElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"description": {
"description": "description of the channel",
"type": [
"string",
"null"
]
},
"highlighted": {
"description": "highlighted keywords in the description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_verified": {
"description": "indicates whether the channel has a \"verified\" label",
"type": [
"boolean",
"null"
]
},
"logo": {
"description": "the URL of the page where the logo image is hosted",
"type": [
"string",
"null"
]
},
"name": {
"description": "name of the channel",
"type": [
"string",
"null"
]
},
"video_count": {
"description": "the number of videos counted on the channel",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiYoutubePlaylistElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiYoutubeOrganicElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"channel_logo": {
"description": "the URL of the page where the logo image of the channel is hosted",
"type": [
"string",
"null"
]
},
"channel_name": {
"description": "the name of the channel where the video is published",
"type": [
"string",
"null"
]
},
"channel_url": {
"description": "the URL of the channel where the video is published",
"type": [
"string",
"null"
]
},
"playlist_id": {
"description": "ID of the video",
"type": [
"string",
"null"
]
},
"preview_videos": {
"description": "information about preview videos
array of objects containing information about videos in the preview block of the playlist element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PreviewVideos"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"thumbnail_url": {
"description": "the URL of the page where the thumbnail is hosted",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"videos_count": {
"description": "the number of videos in playlist",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiYoutubeVideoElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiYoutubeOrganicElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"badges": {
"description": "video badges
example:
New, CC, 4K
",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"channel_logo": {
"description": "the URL of the page where the logo image of the channel is hosted",
"type": [
"string",
"null"
]
},
"channel_name": {
"description": "the name of the channel where the video is published",
"type": [
"string",
"null"
]
},
"channel_url": {
"description": "the URL of the channel where the video is published",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the channel",
"type": [
"string",
"null"
]
},
"duration_time": {
"description": "duration of the video",
"type": [
"string",
"null"
]
},
"duration_time_seconds": {
"description": "duration of the video in seconds",
"type": [
"integer",
"null"
]
},
"highlighted": {
"description": "highlighted keywords in the description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_live": {
"description": "indicates whether the video is a live broadcast",
"type": [
"boolean",
"null"
]
},
"is_movie": {
"description": "indicates whether the video is a movie",
"type": [
"boolean",
"null"
]
},
"is_shorts": {
"description": "indicates whether the video is shorts",
"type": [
"boolean",
"null"
]
},
"publication_date": {
"description": "the date when the video is published",
"type": [
"string",
"null"
]
},
"thumbnail_url": {
"description": "the URL of the page where the thumbnail is hosted",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result is published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2022-11-15 12:57:46 +00:00
",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video",
"type": [
"string",
"null"
]
},
"views_count": {
"description": "number of views of the video",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpApiYoutubeVideoPaidElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiYoutubeOrganicElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"badges": {
"description": "video badges
example:
New, CC, 4K
",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"channel_logo": {
"description": "the URL of the page where the logo image of the channel is hosted",
"type": [
"string",
"null"
]
},
"channel_name": {
"description": "the name of the channel where the video is published",
"type": [
"string",
"null"
]
},
"channel_url": {
"description": "the URL of the channel where the video is published",
"type": [
"string",
"null"
]
},
"description": {
"description": "description of the channel",
"type": [
"string",
"null"
]
},
"duration_time": {
"description": "duration of the video",
"type": [
"string",
"null"
]
},
"duration_time_seconds": {
"description": "duration of the video in seconds",
"type": [
"integer",
"null"
]
},
"highlighted": {
"description": "highlighted keywords in the description",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"is_live": {
"description": "indicates whether the video is a live broadcast",
"type": [
"boolean",
"null"
]
},
"is_movie": {
"description": "indicates whether the video is a movie",
"type": [
"boolean",
"null"
]
},
"is_shorts": {
"description": "indicates whether the video is shorts",
"type": [
"boolean",
"null"
]
},
"publication_date": {
"description": "the date when the video is published",
"type": [
"string",
"null"
]
},
"thumbnail_url": {
"description": "the URL of the page where the thumbnail is hosted",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result is published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2022-11-15 12:57:46 +00:00
",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video",
"type": [
"string",
"null"
]
},
"views_count": {
"description": "number of views of the video",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBaiduLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
only City location_type is supported for all countries except China (where Country is also supported);
don't match locations by location_code_parent because the results for Region and Country-level results for most countries are not supported by Baidu SERP API",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
only City is supported for all countries except China (where Country is also supported)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBaiduLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
images, local_pack, map, organic, paid, related_searches, video, stocks_box, dictionary, shopping",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTaskGetRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in SERP
contains types of all search results (items) found in the returned SERP
possible item types:organic, paid",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskGetRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTaskGetRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBaiduOrganicTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBaiduOrganicTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:
`\"location_code\": 9041134`,
`\"location_name\": \"Vienna International Airport,Lower Austria,Austria\"`,
`\"location_code_parent\": 20044`
`\"location_name\": \"Lower Austria,Austria\"`",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
indicates the geographic classification of the location
example:
`\"location_type\": \"Country\"`, or `\"location_type\": \"State\"`",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local_pack, map, organic, paid, people_also_ask, people_also_search, questions_and_answers,recipes, related_searches, shopping, top_stories, video, ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicLiveRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types: organic, paid",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicLiveRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicLiveRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local_pack, map, organic, paid, people_also_ask, people_also_search, questions_and_answers,recipes, related_searches, shopping, top_stories, video, ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTaskGetRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types: organic, paid",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items inside the element
array of 8 search queries related to the keyword",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseBingSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskGetRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTaskGetRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpBingOrganicTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpBingOrganicTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsAdvertisersLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:\"location_code\": 9041134,
\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",
\"location_code_parent\": 20044location_code_parent corresponds to:\"location_code\": 20044,",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsAdvertisersLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsAdvertisersTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
\"location_name\": \"Lower Austria,Austria\"
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:ads_muti_account_advertiser, ads_advertiser, ads_domain",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiAdsAdvertiserElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsAdvertisersTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsAdvertisersTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsAdvertisersTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsAdvertisersTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsAdvertisersTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsSearchLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:
`\"location_code\": 9041134`,
`\"location_name\": \"Vienna International Airport,Lower Austria,Austria\"`,
`\"location_code_parent\": 20044`
`\"location_name\": \"Lower Austria,Austria\"`",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsSearchLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsSearchTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
in this case, equals null",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:ads_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AdsSearch"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsSearchTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsSearchTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsSearchTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAdsSearchTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAdsSearchTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items present in the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiModeAiOverviewInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAiModeTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAiModeTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAutocompleteLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:autocomplete",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Autocomplete"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, will equal null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAutocompleteLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAutocompleteTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:autocomplete",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Autocomplete"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, will equal null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAutocompleteTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAutocompleteTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAutocompleteTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleAutocompleteTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleAutocompleteTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetInfoLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item type: dataset",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Dataset"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetInfoLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetInfoTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item type: dataset",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Dataset"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetInfoTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetInfoTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetInfoTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetInfoTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetInfoTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetSearchLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item type: dataset",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Dataset"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetSearchLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetSearchTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item type: dataset",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Dataset"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetSearchTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetSearchTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetSearchTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleDatasetSearchTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleDatasetSearchTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreAdvancedItem": {
"properties": {
"gainers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceMarketTrendsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"losers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceMarketTrendsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"most_active": {
"description": "array of items
this array can take the following names: most_active, gainers, losers",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleFinanceMarketTrendsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_hero_groups, google_finance_interested, google_finance_news, google_finance_earnings_calendar, google_finance_most_followed, google_finance_market_trends, google_finance_people_also_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_hero_groups, google_finance_interested, google_finance_news, google_finance_earnings_calendar, google_finance_most_followed, google_finance_market_trends, google_finance_people_also_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "market indexes related to the market trends element
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceExploreTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceExploreTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_hero_groups, google_finance_explore_market_trends, google_finance_news, google_finance_interested, google_finance_people_also_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_hero_groups, google_finance_explore_market_trends, google_finance_news, google_finance_interested, google_finance_people_also_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "market indexes related to the market trends element
possible type of items: google_finance_asset_pair_element, google_finance_market_instrument_element, google_finance_market_index_element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceMarketsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceMarketsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_hero_groups, google_finance_quote, google_finance_compare_to, google_finance_news, google_finance_financial, google_finance_futures_chain, google_finance_details, google_finance_about, google_finance_interested, google_finance_people_also_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_hero_groups, google_finance_quote, google_finance_compare_to, google_finance_news, google_finance_financial, google_finance_futures_chain, google_finance_details, google_finance_about, google_finance_interested, google_finance_people_also_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "market indexes related to the market trends element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceQuoteTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceQuoteTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of search results found in SERP
array of items containing market indexes data;
possible type of items: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceTickerSearchElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP;
possible item types: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of search results found in SERP
array of items containing market indexes data;
possible type of items: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleFinanceTickerSearchElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
in this case, the value will be null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceTickerSearchTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleFinanceTickerSearchTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleFinanceTickerSearchTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:carousel, images_search, related_searches",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:carousel, images_search, related_searches",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleImagesTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleImagesTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleJobsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:google_jobs_item",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_GoogleJobsItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
in this case, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleJobsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleJobsTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleJobsTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleJobsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleJobsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleJobsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleJobsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:local_pack",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LocalPackSerpElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array
",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:local_pack",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_LocalPackSerpElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocalFinderTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocalFinderTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:
`\"location_code\": 9041134`,
`\"location_name\": \"Vienna International Airport,Lower Austria,Austria\"`,
`\"location_code_parent\": 20044`
`\"location_name\": \"Lower Austria,Austria\"`",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
indicates the geographic classification of the location
example:
`\"location_type\": \"Country\"`, or `\"location_type\": \"State\"`",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleMapsLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results
Note: to check location-specific results, follow the provided check url, scroll up and down, then click the \"Search this area\" button",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:maps_search, maps_paid_item",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleMapsElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array
",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleMapsLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleMapsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results
Note: to check location-specific results, follow the provided check url, scroll up and down, then click the \"Search this area\" button",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:maps_search, maps_paid_item",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleMapsElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleMapsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleMapsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleMapsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleMapsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleMapsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"includes_non_news_search_results": {
"description": "indicates whether the response contains non-news search results in addition to news content",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:top_stories, news_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleNewsElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"includes_non_news_search_results": {
"description": "indicates whether the response contains non-news search results in addition to news content",
"type": [
"boolean",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:top_stories, news_search",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleNewsElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleNewsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleNewsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine resultsyou can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was receivedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERPcontains types of search results (items) found in SERP.possible item types:answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, recipes, top_sights, scholarly_articles, popular_products, questions_and_answers, find_results_on, stocks_box, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, short_videos, refine_products, perspectives, discussions_and_forums, compare_sites, ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "items 数组中返回的结果数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST arraythe keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total search results pages retrievedtotal number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "POST 数组中的搜索引擎域名",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engineif the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicLiveRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in SERP
contains types of all search results (items) found in the returned SERP
possible item types:answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, recipes, top_sights, scholarly_articles, popular_products, questions_and_answers, find_results_on, stocks_box, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, short_videos, refine_products, perspectives, discussions_and_forums, compare_sites, ai_overview
however, this endpoint provides data for featured_snippet, organic and paid types only
to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the Google Organiс Advanced SERP endpoint",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total search results pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicLiveRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicLiveRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, recipes, top_sights, scholarly_articles, popular_products, questions_and_answers, find_results_on, stocks_box, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, short_videos, refine_products, perspectives, discussions_and_forums, compare_sitesai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "link of the element",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total search results pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTaskGetRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in SERP
contains types of all search results (items) found in the returned SERP
possible item types:answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, recipes, top_sights, scholarly_articles, popular_products, questions_and_answers, find_results_on, stocks_box, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, short_videos, refine_products, perspectives, discussions_and_forums, compare_sites, ai_overview
however, this endpoint provides data for featured_snippet, organic and paid types only;
to get all items (including SERP features and rich snippets) found in the returned SERP, please refer to the Google Organiс Advanced SERP endpoint",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total search results pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
if there are none, the value is null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;
if there is none, the value is null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskGetRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTaskGetRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleOrganicTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleOrganicTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleSearchByImageTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL specified in a POST array",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
organic,
images",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items featured in the faq_box",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiGoogleSearchByImagesElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword Google associated with the specified image",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleSearchByImageTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleSearchByImageTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleSearchByImageTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
can take the following values: search_by_image",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpGoogleSearchByImageTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpGoogleSearchByImageTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"last_updated_time": {
"description": "date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"previous_updated_time": {
"description": "previous to the most recent date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-10-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "number of search results for the returned keyword",
"format": "int64",
"type": [
"integer",
"null"
]
},
"se_type": {
"description": "search engine type",
"type": [
"string",
"null"
]
},
"serp_item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP
possible item types:answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses, ai_overview;
note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:images, local_pack, map, organic, paid, related_searches, video",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTaskGetRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in SERP
contains types of all search results (items) found in the returned SERP
possible item types:images, local_pack, map, organic, paid, related_searches, video
however, this endpoint provides data for organic and paid types onlyitems array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskGetRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTaskGetRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpNaverOrganicTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpNaverOrganicTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpScreenshotResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpScreenshotTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpScreenshotResultInfo": {
"properties": {
"items": {
"description": "items array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ScreenshotItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "number of items in the results array",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpScreenshotTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpScreenshotResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpSeznamLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
only City location_type is supported for all countries except China (where Country is also supported);
don't match locations by location_code_parent because the results for Region and Country-level results for most countries are not supported by Baidu SERP API",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpSeznamLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:images, local_pack, organic, related_searches, top_stories, featured_snippet, video, shopping",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTaskGetRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in SERP
contains types of all search results (items) found in the returned SERP
possible item types:images, local_pack, organic, related_searches, top_stories, featured_snippet, video
however, this endpoint provides data for the organic type onlyitems array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskGetRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTaskGetRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpSeznamOrganicTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpSeznamOrganicTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:
`\"location_code\": 9041134`,
`\"location_name\": \"Vienna International Airport,Lower Austria,Austria\"`,
`\"location_code_parent\": 20044`
`\"location_name\": \"Lower Austria,Austria\"`",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
indicates the geographic classification of the location
example:
`\"location_type\": \"Country\"`, or `\"location_type\": \"State\"`",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_ask, related_searches, shopping, recipes, top_stories, video, ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicLiveHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicLiveHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicLiveRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
You can use it to make sure that we provided exact results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in SERP
contains types of all search results (items) found in the returned SERP
possible item types:featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_ask, related_searches, shopping, recipes, top_stories, video, ai_overview;
note that this array contains all types of search results found in the returned SERP;
however, this endpoint provides data for organic, paid, and featured_snippet types only;
to get all items (including SERP features and rich snippets) found in the returned SERP, please refer to the Yahoo Organiс Advanced SERP endpoint",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicLiveRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicLiveRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_ask, related_searches, shopping, recipes, top_stories, video, ai_overview",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "additional items present in the element
if there are none, equals null",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetHtmlResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTaskGetHtmlTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetHtmlResultInfo": {
"properties": {
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_HtmlItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetHtmlTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTaskGetHtmlResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetRegularResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTaskGetRegularTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetRegularResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results found in SERP
contains types of all search results (items) found in the returned SERP
possible item types:featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_ask, related_searches, shopping, recipes, top_stories, video, ai_overview;
note that this array contains all types of search results found in the returned SERP;
however, this endpoint provides data for organic, paid, and featured_snippet types only;
to get all items (including SERP features and rich snippets) found in the returned SERP, please refer to the Yahoo Organiс Advanced SERP endpoint",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "items in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"pages_count": {
"description": "total pages retrieved
total number of retrieved SERPs in the result",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refinement_chips": {
"description": "search refinement chips
equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RefinementChipsInfo"
}
],
"type": [
"object",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskGetRegularTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTaskGetRegularResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results
in this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYahooOrganicTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYahooOrganicTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeLanguagesResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeLanguagesTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeLanguagesResultInfo": {
"properties": {
"language_code": {
"description": "language code according to ISO 639-1",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "language name",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeLanguagesTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeLanguagesResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeLocationsResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeLocationsTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeLocationsResultInfo": {
"properties": {
"country_iso_code": {
"description": "ISO country code of the location",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code",
"type": [
"integer",
"null"
]
},
"location_code_parent": {
"description": "the code of the superordinate location
example:
`\"location_code\": 9041134`,
`\"location_name\": \"Vienna International Airport,Lower Austria,Austria\"`,
`\"location_code_parent\": 20044`
`\"location_name\": \"Lower Austria,Austria\"`",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of the location",
"type": [
"string",
"null"
]
},
"location_type": {
"description": "location type
indicates the geographic classification of the location
example:
`\"location_type\": \"Country\"`, or `\"location_type\": \"State\"`",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeLocationsTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeLocationsResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeOrganicLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP contains types of search results (items) found in SERP. possible item types: youtube_channel, youtube_video, youtube_video_paid, youtube_playlist",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiYoutubeOrganicElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "items 数组中返回的结果数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "POST 数组中的搜索引擎域名",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": "total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeOrganicLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeOrganicTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
youtube_channel, youtube_video, youtube_video_paid",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiYoutubeOrganicElementItem"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword received in a POST array
the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"se_results_count": {
"description": " total number of results in SERP",
"format": "int64",
"type": [
"integer",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeOrganicTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeOrganicTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of resultsin this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeOrganicTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeOrganicTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeOrganicTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoCommentsLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"comments_count": {
"description": "number of comments on the video",
"format": "int64",
"type": [
"integer",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item:youtube_comment",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_YoutubeComment"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video received in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoCommentsLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoCommentsTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"comments_count": {
"description": "number of comments on the video",
"format": "int64",
"type": [
"integer",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item:youtube_comment",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_YoutubeComment"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video received in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoCommentsTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoCommentsTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of resultsin this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoCommentsTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoCommentsTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoCommentsTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoInfoLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoLiveAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:\n2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP\ncontains types of search results (items) found in SERP.\npossible item:\nyoutube_video_info",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_YoutubeVideoInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "items 数组中返回的结果数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "POST 数组中的搜索引擎域名",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine\nif the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"video_id": {
"description": "ID of the video received in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoInfoLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoInfoTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTaskGetAdvancedResultInfo": {
"properties": {
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item:
youtube_video_info",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_YoutubeVideoInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"video_id": {
"description": "ID of the video received in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoInfoTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoInfoTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of resultsin this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoInfoTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoInfoTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoInfoTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesLiveAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoSubtitlesLiveAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesLiveAdvancedResultInfo": {
"properties": {
"category": {
"description": "the category the video belongs toNote: this field is deprecated and always returns null",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine resultsyou can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was receivedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERPcontains types of search results (items) found in SERP.possible item:youtube_subtitles",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_YoutubeSubtitles"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "items 数组中返回的结果数量",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "POST 数组中的语言代码",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "POST 数组中的位置代码",
"type": [
"integer",
"null"
]
},
"origin_language": {
"description": "language code of original text",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "POST 数组中的搜索引擎域名",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engineif the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"subtitles_count": {
"description": "number of subtitles in the video",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"translate_language": {
"description": "language code of translated text",
"type": [
"string",
"null"
]
},
"unsupported_language": {
"description": "indicates whether the language is unsupported by the system",
"type": [
"boolean",
"null"
]
},
"video_id": {
"description": "ID of the video received in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesLiveAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "结果数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoSubtitlesLiveAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskGetAdvancedResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskGetAdvancedTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskGetAdvancedResultInfo": {
"properties": {
"category": {
"description": "the category the video belongs to
Note: this field is deprecated and always returns null",
"type": [
"string",
"null"
]
},
"check_url": {
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results",
"type": [
"string",
"null"
]
},
"datetime": {
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"item_types": {
"description": "types of search results in SERP
contains types of search results (items) found in SERP.
possible item:youtube_subtitles",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"items": {
"description": "elements of search results found in SERP",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_YoutubeSubtitles"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"items_count": {
"description": "the number of results returned in the items array",
"format": "int64",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "language code in a POST array",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "location code in a POST array",
"type": [
"integer",
"null"
]
},
"origin_language": {
"description": "language code of original text",
"type": [
"string",
"null"
]
},
"se_domain": {
"description": "search engine domain in a POST array",
"type": [
"string",
"null"
]
},
"spell": {
"description": "autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SpellInfo"
}
],
"type": [
"object",
"null"
]
},
"subtitles_count": {
"description": "number of subtitles in the video",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"translate_language": {
"description": "language code of translated text",
"type": [
"string",
"null"
]
},
"unsupported_language": {
"description": "indicates whether the language is unsupported by the system",
"type": [
"boolean",
"null"
]
},
"video_id": {
"description": "ID of the video received in a POST array",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskGetAdvancedTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskGetAdvancedResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskPostResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "任务数组",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskPostTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTaskPostTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of resultsin this case, the value will be null",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTasksReadyResponseInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseInfo"
},
{
"properties": {
"tasks": {
"description": "array of tasks",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoSubtitlesTasksReadyTaskInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTasksReadyResultInfo": {
"properties": {
"date_posted": {
"description": "date when the task was posted (in the UTC format)",
"type": [
"string",
"null"
]
},
"endpoint_advanced": {
"description": "URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_html": {
"description": "URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"endpoint_regular": {
"description": "URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null",
"type": [
"string",
"null"
]
},
"id": {
"description": "task identifier of the completed task
unique task identifier in our system in the UUID format",
"type": [
"string",
"null"
]
},
"se": {
"description": "search engine specified when setting the task",
"type": [
"string",
"null"
]
},
"se_type": {
"description": "type of search engine
example: {{low_se_type_under}}",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SerpYoutubeVideoSubtitlesTasksReadyTaskInfo": {
"allOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseResponseTaskInfo"
},
{
"properties": {
"result": {
"description": "array of results",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SerpYoutubeVideoSubtitlesTasksReadyResultInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ShoppingElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"marketplace": {
"description": "merchant account provider
commerce site that hosts products or websites of individual sellers under the same merchant account
example:by Google",
"type": [
"string",
"null"
]
},
"marketplace_url": {
"description": "relevant marketplace URL
URL of the page on the marketplace website where the product is hosted",
"type": [
"string",
"null"
]
},
"price": {
"description": "price indicated in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ShoppingSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ShoppingElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_ShoppingSpecification": {
"properties": {
"block_name": {
"description": "name of the block of product attributes
indicates the name of the product specification section in which the related element is listed",
"type": [
"string",
"null"
]
},
"specification_name": {
"description": "product attribute
attribute name of the product data specification",
"type": [
"string",
"null"
]
},
"specification_value": {
"description": "content of the specification",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ShortVideosElement": {
"properties": {
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ShortVideosSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ShortVideosElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_SocialMetricsInfo": {
"properties": {
"like_count": {
"description": "likes count",
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
}
},
"Response0A3E90081762_Source": {
"properties": {
"domain": {
"description": "domain of the source where the review was posted",
"type": [
"string",
"null"
]
},
"image": {
"description": "featured image of the source",
"type": [
"string",
"null"
]
},
"title": {
"description": "name of the source where the review was posted",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SourceInfo": {
"properties": {
"domain": {
"description": "source domain in SERP",
"type": [
"string",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"publication_date": {
"description": "date and time when the result was published
in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"snippet": {
"description": "source description",
"type": [
"string",
"null"
]
},
"source_name": {
"description": "source name",
"type": [
"string",
"null"
]
},
"thumbnail": {
"description": "source thumbnail",
"type": [
"string",
"null"
]
},
"title": {
"description": "source title",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Sources": {
"properties": {
"domain": {
"description": "source domain",
"type": [
"string",
"null"
]
},
"markdown": {
"description": "content of the element in markdown format
content of the result formatted in the markdown markup language",
"type": [
"string",
"null"
]
},
"publication_date": {
"description": "date and time when the result was published
in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"rank": {
"description": "rank in the results",
"type": [
"integer",
"null"
]
},
"snippet": {
"description": "source description",
"type": [
"string",
"null"
]
},
"source_name": {
"description": "source name",
"type": [
"string",
"null"
]
},
"thumbnail": {
"description": "source thumbnail",
"type": [
"string",
"null"
]
},
"title": {
"description": "source title",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SpecialOfferInfo": {
"properties": {
"coupon_code": {
"description": "code of coupon discount",
"type": [
"string",
"null"
]
},
"coupon_info": {
"description": "information on coupon discount",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain in SERP",
"type": [
"string",
"null"
]
},
"fixed_discount": {
"description": "amount of the fixed discount",
"format": "int64",
"type": [
"number",
"null"
]
},
"fixed_discount_currency": {
"description": "currency of the fixed discount",
"type": [
"string",
"null"
]
},
"percentage_discount": {
"description": "percentage of the discount",
"format": "int64",
"type": [
"number",
"null"
]
},
"sub_title": {
"description": "subtitle of the special offer",
"type": [
"string",
"null"
]
},
"title": {
"description": "product title",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the product page on the seller's website
Note: this field is deprecated and will return null",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_SpellInfo": {
"properties": {
"keyword": {
"description": "keyword obtained as a result of search engine autocorrection\n the results will be provided for the corrected keyword",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of autocorrection\n possible values:\n did_you_mean, showing_results_for, no_results_found_for, including_results_for\n note: Yahoo and Yandex support only the following autocorrection type:\n including_results_for",
"type": [
"string",
"null"
]
}
}
},
"Response0A3E90081762_SslInfo": {
"properties": {
"certificate_expiration_date": {
"description": "ssl certificate expiration date
the date and time when the ssl certificate expires
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"certificate_hash": {
"description": "ssl certificate hash
the version of the ssl certificate's hash function",
"type": [
"string",
"null"
]
},
"certificate_issuer": {
"description": "ssl certificate authority
the entity that issued the detected ssl certificate",
"type": [
"string",
"null"
]
},
"certificate_subject": {
"description": "ssl certificate subject
the entity associated with the public key",
"type": [
"string",
"null"
]
},
"certificate_version": {
"description": "ssl certificate version
indicates the version of X.509 used by an ssl certificate",
"type": [
"integer",
"null"
]
},
"valid_certificate": {
"description": "ssl certificate validity
indicates whether the ssl certificate detected on a website is not expired, suspended, revoked or invalid",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_StocksBoxSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"domain": {
"description": "domain of the website hosting the video",
"type": [
"string",
"null"
]
},
"graph": {
"description": "contains data provided in the graph of the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Graph"
}
],
"type": [
"object",
"null"
]
},
"price": {
"description": "price indicated in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_PriceInfo"
}
],
"type": [
"object",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"snippet": {
"description": "text alongside the link title",
"type": [
"string",
"null"
]
},
"source": {
"description": "source of the element
indicates the source of information included in the recipes_element",
"type": [
"string",
"null"
]
},
"table": {
"description": "table present in the element
the header and content of the table present in the element",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Table"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_StoresCountInfo": {
"properties": {
"count": {
"description": "number of stores that offer the product",
"type": [
"integer",
"null"
]
},
"count_from_text": {
"description": "whether the number of stores is taken from text
indicates whether the number of stores is taken from displayed_text;
if the API finds the exact number of stores in the HTML code of the Google Shopping page, this parameter is false;
if the API cannot find the number of stores in the HTML code of the page, it takes the number from the displayed_text;
in this case, the parameter is true",
"type": [
"boolean",
"null"
]
},
"displayed_text": {
"description": "text displayed on the Google Shopping page",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_StreamingQualityElement": {
"properties": {
"bitrate": {
"description": "bit rate of the video",
"type": [
"integer",
"null"
]
},
"fps": {
"description": "frame rate of the video",
"type": [
"integer",
"null"
]
},
"height": {
"description": "video height in pixels",
"type": [
"integer",
"null"
]
},
"label": {
"description": "label of the quality element",
"type": [
"string",
"null"
]
},
"mime_type": {
"description": "media type of the video",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"width": {
"description": "video width in pixels",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Subtitles": {
"properties": {
"is_auto_generated": {
"description": "defines if subtitles are auto generated",
"type": [
"boolean",
"null"
]
},
"is_translatable": {
"description": "defines if subtitles are translatable",
"type": [
"boolean",
"null"
]
},
"language": {
"description": "language of subtitles",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_Table": {
"properties": {
"table_content": {
"description": "the content of the table\none line of the table in this element of the array",
"items": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"array",
"null"
]
},
"table_element": {
"description": "name assigned to the table element\npossible values:\ntable_element",
"type": [
"string",
"null"
]
},
"table_header": {
"description": "column names",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TableContentInfo": {
"properties": {
"body": {
"description": "表格主体内容",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TableContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"footer": {
"description": "表格页脚的内容",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TableContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"header": {
"description": "解析后的标头内容",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TableContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TableContentItemInfo": {
"properties": {
"row_cells": {
"description": "表头行单元格的内容",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RowCellInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TargetInfo": {
"properties": {
"cms": {
"description": "content management system",
"type": [
"string",
"null"
]
},
"country": {
"description": "country code that the target domain is determined to belong to",
"type": [
"string",
"null"
]
},
"ip_address": {
"description": "IP address of the target",
"type": [
"string",
"null"
]
},
"is_ip": {
"description": "indicates if the target is IP
if true, the domain, subdomain or webpage functions as an IP address and does not have a domain name",
"type": [
"boolean",
"null"
]
},
"platform_type": {
"description": "platform type",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"server": {
"description": "server",
"type": [
"string",
"null"
]
},
"target_spam_score": {
"description": "spam score of the target
if the target is a domain/subdomain, this fields indicates the average spam score of all pages of that domain/subdomain;
learn more about how the metric is calculated on this help center page",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TechnologiesInfo": {
"properties": {
"add_ons": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"analytics": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"booking": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"business_tools": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"communication": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"content": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"location": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"marketing": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"media": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"other": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"privacy": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"sales": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"security": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"servers": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"user_generated_content": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"utilities": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
},
"web_development": {
"additionalProperties": {
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TechnologyCategoryInfo": {
"properties": {
"id": {
"description": "id of the technology category
example:crm, cart_abandonment",
"type": [
"string",
"null"
]
},
"path": {
"description": "path to the technology category
example:user_generated_content.content_curation",
"type": [
"string",
"null"
]
},
"technologies": {
"description": "list of technologies in this category
example:\"Salesforce\", \"CareCart\"",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"title": {
"description": "title of the technology category",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TestSummary": {
"properties": {
"error": {
"description": "number of serious microdata errors",
"type": [
"integer",
"null"
]
},
"fatal": {
"description": "number of fatal microdata errors",
"type": [
"integer",
"null"
]
},
"info": {
"description": "number of microdata information flags",
"type": [
"integer",
"null"
]
},
"warning": {
"description": "number of microdata warnings",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_ThirdPartyReviewsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_TimeInfo": {
"properties": {
"hour": {
"description": "hours in the 24-hour format",
"type": [
"integer",
"null"
]
},
"minute": {
"description": "minutes",
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TopDomainInfo": {
"properties": {
"count": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
}
}
},
"Response0A3E90081762_TopSightsElement": {
"properties": {
"description": {
"description": "link description",
"type": [
"string",
"null"
]
},
"rating": {
"description": "the item's rating
the popularity rate based on reviews and displayed in SERP;
if there is none, equals null",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TopSightsSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopSightsElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_TopStoriesElement": {
"properties": {
"amp_version": {
"description": "Accelerated Mobile Pages
indicates whether an item has the Accelerated Mobile Page (AMP) version
Note: this check no longer appears in SERP",
"type": [
"boolean",
"null"
]
},
"badges": {
"description": "badges relevant to the element",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"date": {
"description": "the date when the page source of the element was published",
"type": [
"string",
"null"
]
},
"domain": {
"description": "domain where a link points",
"type": [
"string",
"null"
]
},
"image_url": {
"description": "URL of the image
the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)",
"type": [
"string",
"null"
]
},
"source": {
"description": "reference source name or title",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TopStoriesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TopStoriesElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_TopicInfo": {
"properties": {
"author": {
"description": "content author name
",
"type": [
"string",
"null"
]
},
"h_title": {
"description": "meta title
",
"type": [
"string",
"null"
]
},
"language": {
"description": "content language
",
"type": [
"string",
"null"
]
},
"level": {
"description": "HTML level
",
"type": [
"integer",
"null"
]
},
"main_title": {
"description": " main title of the block
",
"type": [
"string",
"null"
]
},
"primary_content": {
"description": "primary content on the page
you can find more information about content priority calculation in this help center article
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SectionContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"secondary_content": {
"description": "secondary content on the page
you can find more information about content priority calculation in this help center article
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_SectionContentItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"table_content": {
"description": "content of the table on the page
",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TableContentInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TrendsGraphDataInfo": {
"properties": {
"date_from": {
"description": "start date of the corresponding time range
in the UTC format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "end date of the corresponding time range
in the UTC format: \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"missing_data": {
"description": "indicates whether the data is unavailable
if true the data on the graph in the Google Trends interface is missing and thus labelled with a dotted line",
"type": [
"boolean",
"null"
]
},
"timestamp": {
"description": "a point in time in the Unix time format",
"type": [
"integer",
"null"
]
},
"values": {
"description": "relative keyword popularity rate at a specific timestamp
represents the keyword popularity rate over the given time range
if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords
a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term",
"items": {
"type": [
"number",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TrendsMapDataInfo": {
"properties": {
"geo_id": {
"description": "Google Trends location identifier
you can use this field for matching obtained results with location parameters specified in the request
example:US-NY",
"type": [
"string",
"null"
]
},
"geo_name": {
"description": "Google Trends location name
you can use this field for matching obtained results with location parameters specified in the request",
"type": [
"string",
"null"
]
},
"max_value_index": {
"description": "max value among comparable terms
represents the maximum value if you specified more than two keywords in a POST array
if you specified only one keyword, the value will be null",
"type": [
"integer",
"null"
]
},
"values": {
"description": "relative keyword popularity rate in a given location
represents the location-specific keyword popularity rate over the given time range
if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords
a value of 100 is the peak popularity for the term
a value of 50 means that the term is half as popular
a value of 0 means there was not enough data for this term",
"items": {
"type": [
"number",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TripadvisorReviewSearch": {
"properties": {
"date_of_visit": {
"description": "date of the reviewer's visit to the local establishment
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"language": {
"description": "language of the review text",
"type": [
"string",
"null"
]
},
"original_language": {
"description": "language of the untranslated review text",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the review in SERP
can take the following values: right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score submitted by the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"responses": {
"description": "contains information about the owner's response",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ReviewResponseItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"review_highlights": {
"description": "review highlights
contains highlighted review criteria and assessments",
"type": [
"object",
"null"
]
},
"review_id": {
"description": "ID of the review",
"type": [
"string",
"null"
]
},
"review_images": {
"description": "contains URLs of the images used in the review",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ImageUrlInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"review_text": {
"description": "content of the review",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the review was published
in the UTC format: \"yyyy-mm-dd hh-mm-ss +00:00\"
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the review",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the review",
"type": [
"string",
"null"
]
},
"user_profile": {
"description": "information from the reviewer's profile",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataUserProfileInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TripadvisorSearchOrganic": {
"properties": {
"category": {
"description": "place category",
"type": [
"string",
"null"
]
},
"is_sponsored": {
"description": "indicates a sponsored placement
if true, related tripadvisor_search_organic item is a paid advertising on Tripadvisor",
"type": [
"boolean",
"null"
]
},
"price_rate": {
"description": "average price rate",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed results
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score of the establishment submitted by the reviewers",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "name of the business entity",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url_path": {
"description": "URL path of the business entity
URL path to the Tripadvisor page of the business entity
you can use this identifier to collect reviews for the business entity using Tripadvisor Reviews",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TrustpilotReviewSearch": {
"properties": {
"language": {
"description": "the language of the review",
"type": [
"string",
"null"
]
},
"position": {
"description": "the alignment of the review in SERP
can take the following values: right",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score submitted by the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"responses": {
"description": "owner's response to the submitted review",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ReviewResponseItemInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"review_images": {
"description": "images submitted by the reviewer
displays URLs to the images provided by the author of the review;
please note that Trustpilot doesn't allow adding images to reviews, so the review_images parameter will always equal null",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"review_text": {
"description": "the content of the review",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when a review was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "the title of the review",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "the URL of the review",
"type": [
"string",
"null"
]
},
"user_profile": {
"description": "user profile of the reviewer",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BusinessDataUserProfileInfo"
}
],
"type": [
"object",
"null"
]
},
"verified": {
"description": "indicates whether the review has the \"Verified\" mark",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TrustpilotSearchOrganic": {
"properties": {
"domain": {
"description": "domain of the establishment",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": "absolute rank among all the listed reviews
absolute position among all reviews on the list",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "the rating score of the establishment submitted by reviewers",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_RatingInfo"
}
],
"type": [
"object",
"null"
]
},
"reviews_count": {
"description": "the total number of reviews",
"format": "int64",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the establishment",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL to the establishment",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TwitterElement": {
"properties": {
"date": {
"description": "the date when the page source of the element was published",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"tweet": {
"description": "tweet message",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_TwitterSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TwitterElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"title": {
"description": "title of the row",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the third-party review source",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_UncrawlableResourcesMeta": {
"properties": {
"content_type": {
"description": "actual content type of the resource",
"type": [
"string",
"null"
]
},
"expected_content_types": {
"description": "expected content types for the resource
list of content types that were expected by the crawler based on how the resource is referenced on the page",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_UserProfileInfo": {
"properties": {
"avatar": {
"type": [
"string",
"null"
]
},
"locations": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"reviews_count": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"url": {
"description": "relevant url",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_VideoElement": {
"properties": {
"preview": {
"description": "URL to the video preview image",
"type": [
"string",
"null"
]
},
"source": {
"description": "URL to the video source",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of a given link element",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "source URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_VideoSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_VideoElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP
absolute position among all the elements in SERP
always equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values;
positions of elements with different type values are omitted from rank_group;
always equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"type": "object"
},
"Response0A3E90081762_VisualStoriesSerpElementItem": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BaseSerpApiElementItem"
}
],
"type": [
"object",
"null"
]
},
{
"properties": {
"items": {
"description": "contains arrays of elements available in the list",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AmazonLabelElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"rank_absolute": {
"description": "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
],
"deprecated": true,
"type": "object"
},
"Response0A3E90081762_WaterfallResourceInfo": {
"properties": {
"duration_time": {
"description": "total time it takes until a browser receives a complete response from a server (in milliseconds)",
"type": [
"integer",
"null"
]
},
"fetch_end": {
"description": "time to complete downloading the HTML resource
the amount of time the browser needs to complete downloading a page",
"type": [
"integer",
"null"
]
},
"fetch_start": {
"description": "time to start downloading the HTML resource
the amount of time the browser needs to start downloading a page",
"type": [
"integer",
"null"
]
},
"initiator": {
"description": "resource initiator",
"type": [
"string",
"null"
]
},
"is_render_blocking": {
"description": "indicates whether the resource blocks rendering",
"type": [
"boolean",
"null"
]
},
"location": {
"description": "location of the resource in the document
parameters defining the location of the specific resource within the document's HTML",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_OnPageResourceLocationInfo"
}
],
"type": [
"object",
"null"
]
},
"resource_type": {
"type": [
"string",
"null"
]
},
"url": {
"description": "resource URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_WorkDayInfo": {
"properties": {
"close": {
"description": "closing time",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TimeInfo"
}
],
"type": [
"object",
"null"
]
},
"open": {
"description": "opening time",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_TimeInfo"
}
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_WorkHours": {
"properties": {
"current_status": {
"description": "current status of the establishment
indicates whether the establishment is opened or closed",
"type": [
"string",
"null"
]
},
"timetable": {
"additionalProperties": {
"items": {
"description": "work hours on Sundays",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_WorkDayInfo"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"description": "work hours timetable",
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_YoutubeComment": {
"properties": {
"author_name": {
"description": "name of the author of the comment",
"type": [
"string",
"null"
]
},
"author_thumbnail": {
"description": "the URL of the page where the author's channel logo is hosted",
"type": [
"string",
"null"
]
},
"author_url": {
"description": "URL of the author's channel",
"type": [
"string",
"null"
]
},
"likes_count": {
"description": "number of likes on the comment",
"format": "int64",
"type": [
"integer",
"null"
]
},
"publication_date": {
"description": "displayed publication date",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP for the target domain
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"reply_count": {
"description": "number of replies on the comment",
"format": "int64",
"type": [
"integer",
"null"
]
},
"text": {
"description": "text of the comment",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2022-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_YoutubeSubtitles": {
"properties": {
"duration_time": {
"description": "duration of subtitles in seconds",
"type": [
"number",
"null"
]
},
"end_time": {
"description": "the second subtitled text ends",
"type": [
"number",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP for the target domain
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"start_time": {
"description": "the second subtitled text starts",
"type": [
"number",
"null"
]
},
"text": {
"description": "text translated in subtitles",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Response0A3E90081762_YoutubeVideoInfo": {
"properties": {
"category": {
"description": "the category the video belongs to",
"type": [
"string",
"null"
]
},
"channel_id": {
"description": "the ID of the channel where the video is published",
"type": [
"string",
"null"
]
},
"channel_logo": {
"description": "the URL of the page where the logo image of the channel is hosted",
"type": [
"string",
"null"
]
},
"channel_name": {
"description": "the name of the channel where the video is published",
"type": [
"string",
"null"
]
},
"channel_subscribers_count": {
"description": "number of subscribers of the channel",
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_ChannelSubscribersCount"
}
],
"type": [
"object",
"null"
]
},
"channel_url": {
"description": "the URL of the channel where the video is published",
"type": [
"string",
"null"
]
},
"comments_count": {
"description": "number of comments on the video",
"format": "int64",
"type": [
"integer",
"null"
]
},
"description": {
"description": "description of the video",
"type": [
"string",
"null"
]
},
"duration_time": {
"description": "duration of the video",
"type": [
"string",
"null"
]
},
"duration_time_seconds": {
"description": "duration of the video in seconds",
"type": [
"integer",
"null"
]
},
"is_embeddable": {
"description": "indicates whether the video is embeddable",
"type": [
"boolean",
"null"
]
},
"is_live": {
"description": "indicates whether the video is on live",
"type": [
"boolean",
"null"
]
},
"keywords": {
"description": "keywords relevant to the video
also known as 'YouTube tags'",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"likes_count": {
"description": "number of likes on the video",
"format": "int64",
"type": [
"integer",
"null"
]
},
"publication_date": {
"description": "the date when the video is published",
"type": [
"string",
"null"
]
},
"rank_absolute": {
"description": " absolute rank in SERP for the target domain
absolute position among all the elements in SERP",
"type": [
"integer",
"null"
]
},
"rank_group": {
"description": "group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group",
"type": [
"integer",
"null"
]
},
"streaming_quality": {
"description": "array of elements that contain information about all possible streaming qualities of the video",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_StreamingQualityElement"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"subtitles": {
"description": "array of elements describing properties of subtitles in the video",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_Subtitles"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"thumbnail_url": {
"description": "the URL of the page where the thumbnail is hosted",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "date and time when the result is published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2022-11-15 12:57:46 +00:00",
"type": [
"string",
"null"
]
},
"title": {
"description": "title of the video",
"type": [
"string",
"null"
]
},
"type": {
"description": "type of element",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the video",
"type": [
"string",
"null"
]
},
"video_id": {
"description": "ID of the video received in a POST array",
"type": [
"string",
"null"
]
},
"views_count": {
"description": "number of views of the video",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
},
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"description": "",
"title": "DataForSEO",
"version": "1",
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
}
},
"x-aisa-catalogs": {
"dataforseo": {
"description": "",
"title": "DataForSEO",
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
}
},
"x-aisa-document": {
"facts_hash": "6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c",
"generator_version": "3",
"protocol_version": "1",
"schema_version": "1"
},
"x-aisa-plans": {
"builder": 1.0,
"display_plan": "payg",
"payg": 1.0,
"similarweb_payg": 1.0,
"team": 1.0,
"version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb"
}
}
},
"x-aisa-configured-paths": [
"/apis/v1/dataforseo/ai_optimization/ai_keyword_data/keywords_search_volume/live",
"/apis/v1/dataforseo/ai_optimization/ai_keyword_data/locations_and_languages",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/live",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/models",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_get/{id}",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_post",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/tasks_ready",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/advanced",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/html",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/{id}",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id}",
"/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_post",
"/apis/v1/dataforseo/ai_optimization/claude/llm_responses/live",
"/apis/v1/dataforseo/ai_optimization/claude/llm_responses/models",
"/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_get/{id}",
"/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_post",
"/apis/v1/dataforseo/ai_optimization/claude/llm_responses/tasks_ready",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/live",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/models",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_get/{id}",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_post",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/tasks_ready",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/languages",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/advanced",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/html",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/locations",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/advanced/{id}",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/html/{id}",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_post",
"/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/tasks_ready",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/aggregated_metrics/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/available_filters",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/cross_aggregated_metrics/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/historical/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/locations_and_languages",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/multi_target_metrics/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/search/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/search_mentions/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics_lite/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_delta/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_new_lost/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_domains/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands_lite/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains_lite/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages_lite/live",
"/apis/v1/dataforseo/ai_optimization/llm_mentions/top_pages/live",
"/apis/v1/dataforseo/ai_optimization/perplexity/llm_responses/live",
"/apis/v1/dataforseo/ai_optimization/perplexity/llm_responses/models",
"/apis/v1/dataforseo/app_data/apple/app_info/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/apple/app_info/task_post",
"/apis/v1/dataforseo/app_data/apple/app_list/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/apple/app_list/task_post",
"/apis/v1/dataforseo/app_data/apple/app_listings/categories",
"/apis/v1/dataforseo/app_data/apple/app_listings/search/live",
"/apis/v1/dataforseo/app_data/apple/app_reviews/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/apple/app_reviews/task_post",
"/apis/v1/dataforseo/app_data/apple/app_searches/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/apple/app_searches/task_post",
"/apis/v1/dataforseo/app_data/apple/categories",
"/apis/v1/dataforseo/app_data/apple/languages",
"/apis/v1/dataforseo/app_data/apple/locations",
"/apis/v1/dataforseo/app_data/google/app_info/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/google/app_info/task_get/html/{id}",
"/apis/v1/dataforseo/app_data/google/app_info/task_post",
"/apis/v1/dataforseo/app_data/google/app_list/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/google/app_list/task_get/html/{id}",
"/apis/v1/dataforseo/app_data/google/app_list/task_post",
"/apis/v1/dataforseo/app_data/google/app_listings/categories",
"/apis/v1/dataforseo/app_data/google/app_listings/search/live",
"/apis/v1/dataforseo/app_data/google/app_reviews/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/google/app_reviews/task_get/html/{id}",
"/apis/v1/dataforseo/app_data/google/app_reviews/task_post",
"/apis/v1/dataforseo/app_data/google/app_searches/task_get/advanced/{id}",
"/apis/v1/dataforseo/app_data/google/app_searches/task_get/html/{id}",
"/apis/v1/dataforseo/app_data/google/app_searches/task_post",
"/apis/v1/dataforseo/app_data/google/categories",
"/apis/v1/dataforseo/app_data/google/languages",
"/apis/v1/dataforseo/app_data/google/locations",
"/apis/v1/dataforseo/backlinks/anchors/live",
"/apis/v1/dataforseo/backlinks/backlinks/live",
"/apis/v1/dataforseo/backlinks/bulk_backlinks/live",
"/apis/v1/dataforseo/backlinks/bulk_new_lost_backlinks/live",
"/apis/v1/dataforseo/backlinks/bulk_new_lost_referring_domains/live",
"/apis/v1/dataforseo/backlinks/bulk_pages_summary/live",
"/apis/v1/dataforseo/backlinks/bulk_ranks/live",
"/apis/v1/dataforseo/backlinks/bulk_referring_domains/live",
"/apis/v1/dataforseo/backlinks/bulk_spam_score/live",
"/apis/v1/dataforseo/backlinks/competitors/live",
"/apis/v1/dataforseo/backlinks/domain_intersection/live",
"/apis/v1/dataforseo/backlinks/domain_pages/live",
"/apis/v1/dataforseo/backlinks/domain_pages_summary/live",
"/apis/v1/dataforseo/backlinks/history/live",
"/apis/v1/dataforseo/backlinks/index",
"/apis/v1/dataforseo/backlinks/page_intersection/live",
"/apis/v1/dataforseo/backlinks/referring_domains/live",
"/apis/v1/dataforseo/backlinks/referring_networks/live",
"/apis/v1/dataforseo/backlinks/summary/live",
"/apis/v1/dataforseo/backlinks/timeseries_new_lost_summary/live",
"/apis/v1/dataforseo/backlinks/timeseries_summary/live",
"/apis/v1/dataforseo/business_data/business_listings/search/live",
"/apis/v1/dataforseo/business_data/google/extended_reviews/task_get/{id}",
"/apis/v1/dataforseo/business_data/google/extended_reviews/task_post",
"/apis/v1/dataforseo/business_data/google/extended_reviews/tasks_ready",
"/apis/v1/dataforseo/business_data/google/hotel_info/live/advanced",
"/apis/v1/dataforseo/business_data/google/hotel_info/live/html",
"/apis/v1/dataforseo/business_data/google/hotel_info/task_get/advanced/{id}",
"/apis/v1/dataforseo/business_data/google/hotel_info/task_get/html/{id}",
"/apis/v1/dataforseo/business_data/google/hotel_info/task_post",
"/apis/v1/dataforseo/business_data/google/hotel_info/tasks_ready",
"/apis/v1/dataforseo/business_data/google/hotel_searches/live",
"/apis/v1/dataforseo/business_data/google/hotel_searches/task_get/{id}",
"/apis/v1/dataforseo/business_data/google/hotel_searches/task_post",
"/apis/v1/dataforseo/business_data/google/hotel_searches/tasks_ready",
"/apis/v1/dataforseo/business_data/google/my_business_info/live",
"/apis/v1/dataforseo/business_data/google/my_business_info/task_get/{id}",
"/apis/v1/dataforseo/business_data/google/my_business_info/task_post",
"/apis/v1/dataforseo/business_data/google/my_business_info/tasks_ready",
"/apis/v1/dataforseo/business_data/google/my_business_updates/task_get/{id}",
"/apis/v1/dataforseo/business_data/google/my_business_updates/task_post",
"/apis/v1/dataforseo/business_data/google/my_business_updates/tasks_ready",
"/apis/v1/dataforseo/business_data/google/questions_and_answers/live",
"/apis/v1/dataforseo/business_data/google/questions_and_answers/task_get/{id}",
"/apis/v1/dataforseo/business_data/google/questions_and_answers/task_post",
"/apis/v1/dataforseo/business_data/google/questions_and_answers/tasks_ready",
"/apis/v1/dataforseo/business_data/google/reviews/task_get/{id}",
"/apis/v1/dataforseo/business_data/google/reviews/task_post",
"/apis/v1/dataforseo/business_data/google/reviews/tasks_ready",
"/apis/v1/dataforseo/business_data/social_media/pinterest/live",
"/apis/v1/dataforseo/business_data/social_media/reddit/live",
"/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_get/{id}",
"/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post",
"/apis/v1/dataforseo/business_data/tripadvisor/reviews/tasks_ready",
"/apis/v1/dataforseo/business_data/tripadvisor/search/task_get/{id}",
"/apis/v1/dataforseo/business_data/tripadvisor/search/task_post",
"/apis/v1/dataforseo/business_data/tripadvisor/search/tasks_ready",
"/apis/v1/dataforseo/business_data/trustpilot/reviews/task_get/{id}",
"/apis/v1/dataforseo/business_data/trustpilot/reviews/task_post",
"/apis/v1/dataforseo/business_data/trustpilot/reviews/tasks_ready",
"/apis/v1/dataforseo/business_data/trustpilot/search/task_get/{id}",
"/apis/v1/dataforseo/business_data/trustpilot/search/task_post",
"/apis/v1/dataforseo/business_data/trustpilot/search/tasks_ready",
"/apis/v1/dataforseo/content_analysis/available_filters",
"/apis/v1/dataforseo/content_analysis/categories",
"/apis/v1/dataforseo/content_analysis/category_trends/live",
"/apis/v1/dataforseo/content_analysis/languages",
"/apis/v1/dataforseo/content_analysis/locations",
"/apis/v1/dataforseo/content_analysis/phrase_trends/live",
"/apis/v1/dataforseo/content_analysis/rating_distribution/live",
"/apis/v1/dataforseo/content_analysis/search/live",
"/apis/v1/dataforseo/content_analysis/sentiment_analysis/live",
"/apis/v1/dataforseo/content_analysis/summary/live",
"/apis/v1/dataforseo/dataforseo_labs/amazon/bulk_search_volume/live",
"/apis/v1/dataforseo/dataforseo_labs/amazon/product_competitors/live",
"/apis/v1/dataforseo/dataforseo_labs/amazon/product_keyword_intersections/live",
"/apis/v1/dataforseo/dataforseo_labs/amazon/product_rank_overview/live",
"/apis/v1/dataforseo/dataforseo_labs/amazon/ranked_keywords/live",
"/apis/v1/dataforseo/dataforseo_labs/amazon/related_keywords/live",
"/apis/v1/dataforseo/dataforseo_labs/apple/app_competitors/live",
"/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live",
"/apis/v1/dataforseo/dataforseo_labs/apple/bulk_app_metrics/live",
"/apis/v1/dataforseo/dataforseo_labs/apple/keywords_for_app/live",
"/apis/v1/dataforseo/dataforseo_labs/available_filters",
"/apis/v1/dataforseo/dataforseo_labs/google/app_competitors/live",
"/apis/v1/dataforseo/dataforseo_labs/google/app_intersection/live",
"/apis/v1/dataforseo/dataforseo_labs/google/available_history",
"/apis/v1/dataforseo/dataforseo_labs/google/bulk_app_metrics/live",
"/apis/v1/dataforseo/dataforseo_labs/google/bulk_keyword_difficulty/live",
"/apis/v1/dataforseo/dataforseo_labs/google/bulk_traffic_estimation/live",
"/apis/v1/dataforseo/dataforseo_labs/google/categories_for_domain/live",
"/apis/v1/dataforseo/dataforseo_labs/google/categories_for_keywords/languages",
"/apis/v1/dataforseo/dataforseo_labs/google/categories_for_keywords/live",
"/apis/v1/dataforseo/dataforseo_labs/google/competitors_domain/live",
"/apis/v1/dataforseo/dataforseo_labs/google/domain_intersection/live",
"/apis/v1/dataforseo/dataforseo_labs/google/domain_metrics_by_categories/live",
"/apis/v1/dataforseo/dataforseo_labs/google/domain_rank_overview/live",
"/apis/v1/dataforseo/dataforseo_labs/google/historical_bulk_traffic_estimation/live",
"/apis/v1/dataforseo/dataforseo_labs/google/historical_keyword_data/live",
"/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live",
"/apis/v1/dataforseo/dataforseo_labs/google/historical_search_volume/live",
"/apis/v1/dataforseo/dataforseo_labs/google/historical_serps/live",
"/apis/v1/dataforseo/dataforseo_labs/google/keyword_ideas/live",
"/apis/v1/dataforseo/dataforseo_labs/google/keyword_overview/live",
"/apis/v1/dataforseo/dataforseo_labs/google/keyword_suggestions/live",
"/apis/v1/dataforseo/dataforseo_labs/google/keywords_for_app/live",
"/apis/v1/dataforseo/dataforseo_labs/google/keywords_for_categories/live",
"/apis/v1/dataforseo/dataforseo_labs/google/keywords_for_site/live",
"/apis/v1/dataforseo/dataforseo_labs/google/page_intersection/live",
"/apis/v1/dataforseo/dataforseo_labs/google/ranked_keywords/live",
"/apis/v1/dataforseo/dataforseo_labs/google/related_keywords/live",
"/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live",
"/apis/v1/dataforseo/dataforseo_labs/google/search_intent/live",
"/apis/v1/dataforseo/dataforseo_labs/google/serp_competitors/live",
"/apis/v1/dataforseo/dataforseo_labs/google/subdomains/live",
"/apis/v1/dataforseo/dataforseo_labs/google/top_searches/live",
"/apis/v1/dataforseo/dataforseo_labs/status",
"/apis/v1/dataforseo/domain_analytics/technologies/aggregation_technologies/live",
"/apis/v1/dataforseo/domain_analytics/technologies/available_filters",
"/apis/v1/dataforseo/domain_analytics/technologies/domain_technologies/live",
"/apis/v1/dataforseo/domain_analytics/technologies/domains_by_html_terms/live",
"/apis/v1/dataforseo/domain_analytics/technologies/domains_by_technology/live",
"/apis/v1/dataforseo/domain_analytics/technologies/languages",
"/apis/v1/dataforseo/domain_analytics/technologies/locations",
"/apis/v1/dataforseo/domain_analytics/technologies/technologies",
"/apis/v1/dataforseo/domain_analytics/technologies/technologies_summary/live",
"/apis/v1/dataforseo/domain_analytics/technologies/technology_stats/live",
"/apis/v1/dataforseo/domain_analytics/whois/available_filters",
"/apis/v1/dataforseo/domain_analytics/whois/overview/live",
"/apis/v1/dataforseo/keywords_data/bing/audience_estimation/industries",
"/apis/v1/dataforseo/keywords_data/bing/audience_estimation/job_functions",
"/apis/v1/dataforseo/keywords_data/bing/audience_estimation/live",
"/apis/v1/dataforseo/keywords_data/bing/audience_estimation/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/bing/audience_estimation/task_post",
"/apis/v1/dataforseo/keywords_data/bing/audience_estimation/tasks_ready",
"/apis/v1/dataforseo/keywords_data/bing/keyword_performance/live",
"/apis/v1/dataforseo/keywords_data/bing/keyword_performance/locations_and_languages",
"/apis/v1/dataforseo/keywords_data/bing/keyword_performance/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/bing/keyword_performance/task_post",
"/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/languages",
"/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/live",
"/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/task_post",
"/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/tasks_ready",
"/apis/v1/dataforseo/keywords_data/bing/keywords_for_keywords/live",
"/apis/v1/dataforseo/keywords_data/bing/keywords_for_keywords/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/bing/keywords_for_keywords/task_post",
"/apis/v1/dataforseo/keywords_data/bing/keywords_for_site/live",
"/apis/v1/dataforseo/keywords_data/bing/keywords_for_site/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/bing/keywords_for_site/task_post",
"/apis/v1/dataforseo/keywords_data/bing/languages",
"/apis/v1/dataforseo/keywords_data/bing/locations",
"/apis/v1/dataforseo/keywords_data/bing/search_volume/live",
"/apis/v1/dataforseo/keywords_data/bing/search_volume/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/bing/search_volume/task_post",
"/apis/v1/dataforseo/keywords_data/bing/search_volume_history/live",
"/apis/v1/dataforseo/keywords_data/bing/search_volume_history/locations_and_languages",
"/apis/v1/dataforseo/keywords_data/bing/search_volume_history/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/bing/search_volume_history/task_post",
"/apis/v1/dataforseo/keywords_data/clickstream_data/bulk_search_volume/live",
"/apis/v1/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live",
"/apis/v1/dataforseo/keywords_data/clickstream_data/global_search_volume/live",
"/apis/v1/dataforseo/keywords_data/clickstream_data/locations_and_languages",
"/apis/v1/dataforseo/keywords_data/dataforseo_trends/demography/live",
"/apis/v1/dataforseo/keywords_data/dataforseo_trends/explore/live",
"/apis/v1/dataforseo/keywords_data/dataforseo_trends/locations",
"/apis/v1/dataforseo/keywords_data/dataforseo_trends/merged_data/live",
"/apis/v1/dataforseo/keywords_data/dataforseo_trends/subregion_interests/live",
"/apis/v1/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/live",
"/apis/v1/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_post",
"/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_keywords/live",
"/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_keywords/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_keywords/task_post",
"/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_site/live",
"/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_site/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_site/task_post",
"/apis/v1/dataforseo/keywords_data/google_ads/search_volume/live",
"/apis/v1/dataforseo/keywords_data/google_ads/search_volume/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/google_ads/search_volume/task_post",
"/apis/v1/dataforseo/keywords_data/google_ads/status",
"/apis/v1/dataforseo/keywords_data/google_trends/categories",
"/apis/v1/dataforseo/keywords_data/google_trends/explore/live",
"/apis/v1/dataforseo/keywords_data/google_trends/explore/task_get/{id}",
"/apis/v1/dataforseo/keywords_data/google_trends/explore/task_post",
"/apis/v1/dataforseo/merchant/amazon/asin/live/advanced",
"/apis/v1/dataforseo/merchant/amazon/asin/live/html",
"/apis/v1/dataforseo/merchant/amazon/asin/task_get/advanced/{id}",
"/apis/v1/dataforseo/merchant/amazon/asin/task_get/html/{id}",
"/apis/v1/dataforseo/merchant/amazon/asin/task_post",
"/apis/v1/dataforseo/merchant/amazon/asin/tasks_ready",
"/apis/v1/dataforseo/merchant/amazon/languages",
"/apis/v1/dataforseo/merchant/amazon/locations",
"/apis/v1/dataforseo/merchant/amazon/products/live/advanced",
"/apis/v1/dataforseo/merchant/amazon/products/live/html",
"/apis/v1/dataforseo/merchant/amazon/products/task_get/advanced/{id}",
"/apis/v1/dataforseo/merchant/amazon/products/task_get/html/{id}",
"/apis/v1/dataforseo/merchant/amazon/products/task_post",
"/apis/v1/dataforseo/merchant/amazon/products/tasks_ready",
"/apis/v1/dataforseo/merchant/amazon/sellers/live/advanced",
"/apis/v1/dataforseo/merchant/amazon/sellers/live/html",
"/apis/v1/dataforseo/merchant/amazon/sellers/task_get/advanced/{id}",
"/apis/v1/dataforseo/merchant/amazon/sellers/task_get/html/{id}",
"/apis/v1/dataforseo/merchant/amazon/sellers/task_post",
"/apis/v1/dataforseo/merchant/amazon/sellers/tasks_ready",
"/apis/v1/dataforseo/merchant/google/languages",
"/apis/v1/dataforseo/merchant/google/locations",
"/apis/v1/dataforseo/merchant/google/product_info/task_get/advanced/{id}",
"/apis/v1/dataforseo/merchant/google/product_info/task_post",
"/apis/v1/dataforseo/merchant/google/product_info/tasks_ready",
"/apis/v1/dataforseo/merchant/google/products/task_get/advanced/{id}",
"/apis/v1/dataforseo/merchant/google/products/task_get/html/{id}",
"/apis/v1/dataforseo/merchant/google/products/task_post",
"/apis/v1/dataforseo/merchant/google/products/tasks_ready",
"/apis/v1/dataforseo/merchant/google/reviews/task_get/advanced/{id}",
"/apis/v1/dataforseo/merchant/google/reviews/task_post",
"/apis/v1/dataforseo/merchant/google/reviews/tasks_ready",
"/apis/v1/dataforseo/merchant/google/sellers/ad_url",
"/apis/v1/dataforseo/merchant/google/sellers/task_get/advanced/{id}",
"/apis/v1/dataforseo/merchant/google/sellers/task_post",
"/apis/v1/dataforseo/merchant/google/sellers/tasks_ready",
"/apis/v1/dataforseo/on_page/available_filters",
"/apis/v1/dataforseo/on_page/content_parsing",
"/apis/v1/dataforseo/on_page/content_parsing/live",
"/apis/v1/dataforseo/on_page/duplicate_content",
"/apis/v1/dataforseo/on_page/duplicate_tags",
"/apis/v1/dataforseo/on_page/force_stop",
"/apis/v1/dataforseo/on_page/instant_pages",
"/apis/v1/dataforseo/on_page/keyword_density",
"/apis/v1/dataforseo/on_page/lighthouse/audits",
"/apis/v1/dataforseo/on_page/lighthouse/languages",
"/apis/v1/dataforseo/on_page/lighthouse/live/json",
"/apis/v1/dataforseo/on_page/lighthouse/task_get/json/{id}",
"/apis/v1/dataforseo/on_page/lighthouse/task_post",
"/apis/v1/dataforseo/on_page/lighthouse/tasks_ready",
"/apis/v1/dataforseo/on_page/lighthouse/versions",
"/apis/v1/dataforseo/on_page/links",
"/apis/v1/dataforseo/on_page/microdata",
"/apis/v1/dataforseo/on_page/non_indexable",
"/apis/v1/dataforseo/on_page/page_screenshot",
"/apis/v1/dataforseo/on_page/pages",
"/apis/v1/dataforseo/on_page/pages_by_resource",
"/apis/v1/dataforseo/on_page/raw_html",
"/apis/v1/dataforseo/on_page/redirect_chains",
"/apis/v1/dataforseo/on_page/resources",
"/apis/v1/dataforseo/on_page/summary/{id}",
"/apis/v1/dataforseo/on_page/task_post",
"/apis/v1/dataforseo/on_page/tasks_ready",
"/apis/v1/dataforseo/on_page/uncrawlable_resources",
"/apis/v1/dataforseo/on_page/waterfall",
"/apis/v1/dataforseo/serp/ai_summary",
"/apis/v1/dataforseo/serp/baidu/languages",
"/apis/v1/dataforseo/serp/baidu/locations",
"/apis/v1/dataforseo/serp/baidu/organic/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/baidu/organic/task_get/html/{id}",
"/apis/v1/dataforseo/serp/baidu/organic/task_get/regular/{id}",
"/apis/v1/dataforseo/serp/baidu/organic/task_post",
"/apis/v1/dataforseo/serp/baidu/organic/tasks_ready",
"/apis/v1/dataforseo/serp/bing/languages",
"/apis/v1/dataforseo/serp/bing/locations",
"/apis/v1/dataforseo/serp/bing/organic/live/advanced",
"/apis/v1/dataforseo/serp/bing/organic/live/html",
"/apis/v1/dataforseo/serp/bing/organic/live/regular",
"/apis/v1/dataforseo/serp/bing/organic/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/bing/organic/task_get/html/{id}",
"/apis/v1/dataforseo/serp/bing/organic/task_get/regular/{id}",
"/apis/v1/dataforseo/serp/bing/organic/task_post",
"/apis/v1/dataforseo/serp/bing/organic/tasks_ready",
"/apis/v1/dataforseo/serp/google/ads_advertisers/live/advanced",
"/apis/v1/dataforseo/serp/google/ads_advertisers/locations",
"/apis/v1/dataforseo/serp/google/ads_advertisers/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/ads_advertisers/task_post",
"/apis/v1/dataforseo/serp/google/ads_advertisers/tasks_ready",
"/apis/v1/dataforseo/serp/google/ads_search/live/advanced",
"/apis/v1/dataforseo/serp/google/ads_search/locations",
"/apis/v1/dataforseo/serp/google/ads_search/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/ads_search/task_post",
"/apis/v1/dataforseo/serp/google/ads_search/tasks_ready",
"/apis/v1/dataforseo/serp/google/ai_mode/languages",
"/apis/v1/dataforseo/serp/google/ai_mode/live/advanced",
"/apis/v1/dataforseo/serp/google/ai_mode/live/html",
"/apis/v1/dataforseo/serp/google/ai_mode/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/ai_mode/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/ai_mode/task_post",
"/apis/v1/dataforseo/serp/google/ai_mode/tasks_ready",
"/apis/v1/dataforseo/serp/google/autocomplete/live/advanced",
"/apis/v1/dataforseo/serp/google/autocomplete/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/autocomplete/task_post",
"/apis/v1/dataforseo/serp/google/autocomplete/tasks_ready",
"/apis/v1/dataforseo/serp/google/dataset_info/live/advanced",
"/apis/v1/dataforseo/serp/google/dataset_info/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/dataset_info/task_post",
"/apis/v1/dataforseo/serp/google/dataset_info/tasks_ready",
"/apis/v1/dataforseo/serp/google/dataset_search/live/advanced",
"/apis/v1/dataforseo/serp/google/dataset_search/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/dataset_search/task_post",
"/apis/v1/dataforseo/serp/google/dataset_search/tasks_ready",
"/apis/v1/dataforseo/serp/google/events/live/advanced",
"/apis/v1/dataforseo/serp/google/events/locations",
"/apis/v1/dataforseo/serp/google/events/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/events/task_post",
"/apis/v1/dataforseo/serp/google/events/tasks_ready",
"/apis/v1/dataforseo/serp/google/finance_explore/live/advanced",
"/apis/v1/dataforseo/serp/google/finance_explore/live/html",
"/apis/v1/dataforseo/serp/google/finance_explore/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/finance_explore/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/finance_explore/task_post",
"/apis/v1/dataforseo/serp/google/finance_explore/tasks_ready",
"/apis/v1/dataforseo/serp/google/finance_markets/live/advanced",
"/apis/v1/dataforseo/serp/google/finance_markets/live/html",
"/apis/v1/dataforseo/serp/google/finance_markets/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/finance_markets/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/finance_markets/task_post",
"/apis/v1/dataforseo/serp/google/finance_markets/tasks_ready",
"/apis/v1/dataforseo/serp/google/finance_quote/live/advanced",
"/apis/v1/dataforseo/serp/google/finance_quote/live/html",
"/apis/v1/dataforseo/serp/google/finance_quote/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/finance_quote/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/finance_quote/task_post",
"/apis/v1/dataforseo/serp/google/finance_quote/tasks_ready",
"/apis/v1/dataforseo/serp/google/finance_ticker_search/live/advanced",
"/apis/v1/dataforseo/serp/google/finance_ticker_search/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/finance_ticker_search/task_post",
"/apis/v1/dataforseo/serp/google/finance_ticker_search/tasks_ready",
"/apis/v1/dataforseo/serp/google/images/live/advanced",
"/apis/v1/dataforseo/serp/google/images/live/html",
"/apis/v1/dataforseo/serp/google/images/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/images/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/images/task_get/regular/{id}",
"/apis/v1/dataforseo/serp/google/images/task_post",
"/apis/v1/dataforseo/serp/google/images/tasks_ready",
"/apis/v1/dataforseo/serp/google/jobs/locations",
"/apis/v1/dataforseo/serp/google/jobs/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/jobs/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/jobs/task_post",
"/apis/v1/dataforseo/serp/google/jobs/tasks_ready",
"/apis/v1/dataforseo/serp/google/languages",
"/apis/v1/dataforseo/serp/google/local_finder/live/advanced",
"/apis/v1/dataforseo/serp/google/local_finder/live/html",
"/apis/v1/dataforseo/serp/google/local_finder/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/local_finder/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/local_finder/task_post",
"/apis/v1/dataforseo/serp/google/local_finder/tasks_ready",
"/apis/v1/dataforseo/serp/google/locations",
"/apis/v1/dataforseo/serp/google/maps/live/advanced",
"/apis/v1/dataforseo/serp/google/maps/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/maps/task_post",
"/apis/v1/dataforseo/serp/google/maps/tasks_ready",
"/apis/v1/dataforseo/serp/google/news/live/advanced",
"/apis/v1/dataforseo/serp/google/news/live/html",
"/apis/v1/dataforseo/serp/google/news/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/news/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/news/task_post",
"/apis/v1/dataforseo/serp/google/news/tasks_ready",
"/apis/v1/dataforseo/serp/google/organic/live/advanced",
"/apis/v1/dataforseo/serp/google/organic/live/html",
"/apis/v1/dataforseo/serp/google/organic/live/regular",
"/apis/v1/dataforseo/serp/google/organic/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/organic/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/organic/task_get/regular/{id}",
"/apis/v1/dataforseo/serp/google/organic/task_post",
"/apis/v1/dataforseo/serp/google/organic/tasks_ready",
"/apis/v1/dataforseo/serp/google/search_by_image/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/google/search_by_image/task_get/html/{id}",
"/apis/v1/dataforseo/serp/google/search_by_image/task_post",
"/apis/v1/dataforseo/serp/google/search_by_image/tasks_ready",
"/apis/v1/dataforseo/serp/naver/organic/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/naver/organic/task_get/html/{id}",
"/apis/v1/dataforseo/serp/naver/organic/task_get/regular/{id}",
"/apis/v1/dataforseo/serp/naver/organic/task_post",
"/apis/v1/dataforseo/serp/naver/organic/tasks_ready",
"/apis/v1/dataforseo/serp/screenshot",
"/apis/v1/dataforseo/serp/seznam/languages",
"/apis/v1/dataforseo/serp/seznam/locations",
"/apis/v1/dataforseo/serp/seznam/organic/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/seznam/organic/task_get/html/{id}",
"/apis/v1/dataforseo/serp/seznam/organic/task_get/regular/{id}",
"/apis/v1/dataforseo/serp/seznam/organic/task_post",
"/apis/v1/dataforseo/serp/seznam/organic/tasks_ready",
"/apis/v1/dataforseo/serp/yahoo/languages",
"/apis/v1/dataforseo/serp/yahoo/locations",
"/apis/v1/dataforseo/serp/yahoo/organic/live/advanced",
"/apis/v1/dataforseo/serp/yahoo/organic/live/html",
"/apis/v1/dataforseo/serp/yahoo/organic/live/regular",
"/apis/v1/dataforseo/serp/yahoo/organic/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/yahoo/organic/task_get/html/{id}",
"/apis/v1/dataforseo/serp/yahoo/organic/task_get/regular/{id}",
"/apis/v1/dataforseo/serp/yahoo/organic/task_post",
"/apis/v1/dataforseo/serp/yahoo/organic/tasks_ready",
"/apis/v1/dataforseo/serp/youtube/languages",
"/apis/v1/dataforseo/serp/youtube/locations",
"/apis/v1/dataforseo/serp/youtube/organic/live/advanced",
"/apis/v1/dataforseo/serp/youtube/organic/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/youtube/organic/task_post",
"/apis/v1/dataforseo/serp/youtube/organic/tasks_ready",
"/apis/v1/dataforseo/serp/youtube/video_comments/live/advanced",
"/apis/v1/dataforseo/serp/youtube/video_comments/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/youtube/video_comments/task_post",
"/apis/v1/dataforseo/serp/youtube/video_comments/tasks_ready",
"/apis/v1/dataforseo/serp/youtube/video_info/live/advanced",
"/apis/v1/dataforseo/serp/youtube/video_info/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/youtube/video_info/task_post",
"/apis/v1/dataforseo/serp/youtube/video_info/tasks_ready",
"/apis/v1/dataforseo/serp/youtube/video_subtitles/live/advanced",
"/apis/v1/dataforseo/serp/youtube/video_subtitles/task_get/advanced/{id}",
"/apis/v1/dataforseo/serp/youtube/video_subtitles/task_post",
"/apis/v1/dataforseo/serp/youtube/video_subtitles/tasks_ready"
],
"x-aisa-document": {
"composer_version": "26",
"document_hash": "sha256:1d99411e05ff4ccb1b79311cb808d0c86495c6d9938ea64f71032044ad6f8187",
"facts_hash": "6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c",
"generator_version": "3",
"protocol_version": "1",
"response_pending": [],
"schema_version": "1"
},
"x-aisa-plans": {
"builder": 1.0,
"display_plan": "payg",
"payg": 1.0,
"similarweb_payg": 1.0,
"team": 1.0,
"version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb"
},
"x-aisa-provider": "dataforseo"
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"openapi": "3.1.0",
"paths": {
"/apis/v1/dataforseo/ai_optimization/ai_keyword_data/keywords_search_volume/live": {
"post": {
"description": "\nThis endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools.\n\n\n按用量计费；默认请求预估费用：$0.011 USD（不是固定价格）。 最终费用以账户适用价格及实际结算为准。\n",
"operationId": "post_dataforseo_ai_keyword_volume_live",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"keywords": [
"iphone",
"seo"
],
"language_name": "English",
"location_code": 2840
}
],
"items": {
"oneOf": [
{
"properties": {
"keywords": {
"description": "keywords
required field
UTF-8 encoding
The maximum number of keywords you can specify: 1000;
The maximum number of characters in a single keyword: 250;
The keywords will be converted to lowercase format;keyword and keywords fields in DataForSEO APIs in this Help Center article",
"items": {
"type": "string"
},
"type": "array"
},
"language_code": {
"description": "language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of the language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:English",
"type": "string"
},
"location_code": {
"description": "unique location identifier
required field if you don't specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of the location
required field if you don't specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages
example:United Kingdom",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "AI 关键词数据关键词搜索量",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-ai-keyword-data-keywords-search-volume-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.011,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:4d55e9f4704e36adf1a91a915c4e00959378f8de4086637d1fd0255fd6712cbe",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "8e606c70f96c"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_keyword_volume_live",
"path": "/apis/v1/dataforseo/ai_optimization/ai_keyword_data/keywords_search_volume/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/ai_keyword_data/keywords_search_volume/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/ai_keyword_data/keywords_search_volume/live \\\n --header 'Authorization: Bearer
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
Note #2: not supported in reasoning models",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value for reasoning models (e.g., reasoning is true in the Models endpoint): 1024;
minimum value for non-reasoning models: 16;
maximum value: 4096;
default value: 2048
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gpt-4.1 is specified, the gpt-4.1-2025-04-14 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behaviour
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 2
default value: 0.94
Note: not supported in reasoning models",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: 0.92top_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search
optional field
when enabled, the AI model can access and cite current web information;
default value: false;
Note: refer to the Models endpoint for a list of models that support web_search;",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location
optional field
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model will search the web from the country you specify;
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 ChatGPT LLM 响应",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-chat-gpt-llm-responses-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0695,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:89ead7b7869e24eabb9b7639419562e1b74457ddcf1bb712e107e7ffc0ce7e3a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "9f8036ce16a5"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_chat_gpt_llm_responses_live",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_responses/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/live \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskGetResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 LLM Responses Chat GPT 结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-ai-optimization-chat-gpt-llm-responses-task-get-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:dc1ac35a71c097fc334b6b43bbb9646f699f5b826f85e818e6d7c2f29a19643f",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "7f404c4c2676"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_ai_chat_gpt_llm_responses_fetch",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_get/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_responses/task_get/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_get/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
Note #2: not supported in reasoning models",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value for reasoning models (e.g., reasoning is true in the Models endpoint): 1024;
minimum value for non-reasoning models: 16;
maximum value: 4096;
default value: 2048",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gpt-4.1 is specified, the gpt-4.1-2025-04-14 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special character in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special character in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
defines the AI's role, tone, or specific behavior;
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data array of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 2
default value: 0.94
Note: not supported in reasoning models",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: 0.92top_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search
optional field
when enabled, the AI model can access and cite current web information;
default value: false;
Note: refer to the Models endpoint for a list of models that support web_search;",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location
optional field
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model will search the web from the country you specify;
Note: not supported in o3-mini, o1-pro, o1 models",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmResponsesTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置“LLM Responses ChatGPT”任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-chat-gpt-llm-responses-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:a735df5ab2558146ae9a1ebb554a03c2483c06069d2c9e11f25ce48fbc2775e1",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "840bb1f542cb"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_chat_gpt_llm_responses_submit",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_responses/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_post \\\n --header 'Authorization: Bearer
optional field
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 ChatGPT LLM 抓取器",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-chat-gpt-llm-scraper-live-advanced",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.004,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:2b0b8257a44af5aa1c066f599bc8d033127f483ca9f7caf36f3ccd51dbd9e153",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "46b919a36735"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_chat_gpt_llm_scraper_live",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/advanced"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_scraper/live/advanced",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/advanced \\\n --header 'Authorization: Bearer
optional field
to enable this parameter, force_web_search must also be enabled;
when enabled, the endpoint will return HTML data from the expanded citation bar;
default value: false",
"type": [
"boolean",
"null"
]
},
"force_web_search": {
"description": "force AI agent to use web search
optional field
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/locations
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/locations
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperLiveHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 ChatGPT LLM 抓取工具 API HTML",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-chat-gpt-llm-scraper-live-html",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:83d0520756c39618680f1d3ba5e607219c8c4ec164798643f6c3019b13541494",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "1b922c9f14cd"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_chat_gpt_llm_scraper_live_html",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/html"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_scraper/live/html",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/html \\\n --header 'Authorization: Bearer
a universally unique identifier (UUID)
unique task identifier in our system
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 ChatGPT LLM Scraper 高级结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-ai-optimization-chat-gpt-llm-scraper-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:49c81f611c3638bdbc20c7996a9688057254d6d4b6e2cb048258360abd0759ff",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "2c5b9d413445"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_ai_chat_gpt_llm_scraper_fetch",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskGetHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Get Ai Optimization Chat Gpt Llm Scraper Html Results by id",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_a2f83f",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:4a8a995059482a21f9ae035f1315b7c79ed69ba5724316ad32c004d7559d1e9c",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "e35c4dcdefbe"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_a2f83f",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/html/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
to enable this parameter, force_web_search must also be enabled;
when enabled, the HTML endpoint will return data from the expanded citation bar;
default value: false",
"type": [
"boolean",
"null"
]
},
"force_web_search": {
"description": "force AI agent to use web search
optional field
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languagesn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations
example:United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationChatGptLlmScraperTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Setting Ai Optimization Chat Gpt Llm Scraper Tasks",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_410e81",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:bae829548ddf8321e7c39faef665dc9d3902b318f95ad266296644325e6a8def",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "611f42828a45"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_410e81",
"path": "/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/chat_gpt/llm_scraper/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_post \\\n --header 'Authorization: Bearer
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value: 1;
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1025",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if claude-opus-4-0 is specified, the claude-opus-4-20250514 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/claude/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behaviour
optional field
defines the AI's role, tone, or specific behavior;
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 1
default value: 0.7temperature cannot be used together with top_p in the same request",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: nulltop_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1025
Note #2: if set to true, force_web_search must be set to false
Note #3: if set to true, the temperature and top_p cannot be used",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location used for searching the web
optional field
",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location used for searching the web
optional field
possible values: 'AR','AT','AU','BE','BR','CA','CH','CL','CN','DE','DK','ES','FI','FR','GB','HK','ID','IN','IT','JP','KR','MX','MY','NL','NO','NZ','PH','PL','PT','RU','SA','SE','TR','TW','US','ZA'",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Claude LLM 实时响应",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-claude-llm-responses-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0567,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:b5254940463338c8415de81355b2516c6f906f0f56ac996e5f76a45a1a9410d6",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "eaeb4bc3f852"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_claude_llm_responses_live",
"path": "/apis/v1/dataforseo/ai_optimization/claude/llm_responses/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/claude/llm_responses/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/live \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskGetResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 LLM Responses Claude 结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-ai-optimization-claude-llm-responses-task-get-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:3bcd7888feeb9d42b4c38ff878b0ea9734848d4c9e4ec84390930970c3ff8e48",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "6428e8d54f33"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_ai_claude_llm_responses_fetch",
"path": "/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_get/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/claude/llm_responses/task_get/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_get/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
to enable this parameter, web_search must also be enabled;
when enabled, the AI model is forced to access and cite current web information;
default value: false;
Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
"type": [
"boolean",
"null"
]
},
"max_output_tokens": {
"description": "maximum number of tokens in the AI response
optional field
minimum value: 1;
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1025",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if claude-opus-4-0 is specified, the claude-opus-4-20250514 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/claude/llm_responses/models",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special character in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special character in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
defines the AI's role, tone, or specific behavior;
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse;
lower values make output more focused;
minimum value: 0
maximum value: 1
default value: 0.7temperature cannot be used together with top_p in the same request",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection;
minimum value: 0
maximum value: 1
default value: nulltop_p cannot be used together with temperature in the same request",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1025
Note #2: if set to true, force_web_search must be set to false
Note #3: if set to true, the temperature and top_p cannot be used",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
},
"web_search_city": {
"description": "city name of the location used for searching the web
optional field
",
"type": [
"string",
"null"
]
},
"web_search_country_iso_code": {
"description": "ISO country code of the location used for searching the web
optional field
possible values: 'AR','AT','AU','BE','BR','CA','CH','CL','CN','DE','DK','ES','FI','FR','GB','HK','ID','IN','IT','JP','KR','MX','MY','NL','NO','NZ','PH','PL','PT','RU','SA','SE','TR','TW','US','ZA'",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationClaudeLlmResponsesTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 LLM Responses Claude 任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-claude-llm-responses-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:9a07d5909cd530229b58b2f1b5ea1d9438e0d4a859f86c3419eb2576535037ef",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "6862d360a0ea"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_claude_llm_responses_submit",
"path": "/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/claude/llm_responses/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_post \\\n --header 'Authorization: Bearer
optional field
minimum value: 1
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1024",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gemini-1.5-pro is specified, the gemini-1.5-pro-002 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behavior
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse
lower values make output more focused
minimum value: 0
maximum value: 2
default value: 1.3",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection
minimum value: 0
maximum value: 1
default value: 0.9",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1024
Note #2: for Gemini Pro models, the use_reasoning will automatically be set to true",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 Gemini LLM 响应",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-gemini-llm-responses-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0707,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:964cf3ad422bdcf5be2d3fdfad9b137502bc2686c54498296d032afd45382fe1",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "8cde44df7c64"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_gemini_llm_responses_live",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_responses/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/live \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskGetResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 LLM Responses Gemini 结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-ai-optimization-gemini-llm-responses-task-get-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:bc302aef42d851cf8688ed643d35be771e9bffe08efb018d4dea75eccb363388",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "4b4ea183901e"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_ai_gemini_llm_responses_fetch",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_get/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_responses/task_get/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_get/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
minimum value: 1;
maximum value: 4096;
default value: 2048;
Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1024",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
for example, if gemini-1.5-pro is specified, the gemini-1.5-pro-002 will be set as model_name automatically;
you can receive the list of available LLM models by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special character in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special character in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse
lower values make output more focused
minimum value: 0
maximum value: 2
default value: 1.3",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection
minimum value: 0
maximum value: 1
default value: 0.9",
"type": [
"number",
"null"
]
},
"use_reasoning": {
"description": "enable reasoning for the AI model
optional field
when enabled, the model will perform reasoning before generating a response
refer to the Models endpoint for a list of models that support reasoning
default value: false
Note: if set to true, the minimum value for max_output_tokens is 1024
Note #2: for Gemini Pro models, the use_reasoning will automatically be set to true",
"type": [
"boolean",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search": {
"description": "enable web search for current information
optional field
when enabled, the AI model can access and cite current web information;
Note: refer to the Models endpoint for a list of models that support web_search;
default value: false;
The cost of the parameter can be calculated on the Pricing page",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmResponsesTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置“LLM Responses Gemini”任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-gemini-llm-responses-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:31af08cb9f0d53307a21cdcb66363be24cc133955f83ed7e571f60349afb4fc5",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "cbd60a8b80e4"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_gemini_llm_responses_submit",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_responses/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_post \\\n --header 'Authorization: Bearer
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example: enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example: English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 Gemini LLM 抓取器高级版",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-gemini-llm-scraper-live-advanced",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:4aee9ab06312536b6766a2a28be0b17df929c570973c5b52f080c28d9e96e2d1",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "e1aac135d605"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_gemini_llm_scraper_live",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/advanced"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_scraper/live/advanced",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/advanced \\\n --header 'Authorization: Bearer
optional field
when enabled, the endpoint will return HTML data from the expanded citation bar;
default value: false",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:United States",
"type": "string"
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperLiveHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 Gemini LLM 抓取工具 HTML",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-gemini-llm-scraper-live-html",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:ceb1da4e5ad9db93271425798d676f2050a9dab2e8a963d1d96a8a343c3c8f8d",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "ff8d8f0a964e"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_gemini_llm_scraper_live_html",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/html"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_scraper/live/html",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/html \\\n --header 'Authorization: Bearer
a universally unique identifier (UUID)
unique task identifier in our system
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "获取 Gemini LLM Scraper Advanced",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-ai-optimization-gemini-llm-scraper-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:efcf00ff422ac7ffd8ade5ba6c7a59fda941641bdf506659033cb2b6234cf0af",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "380402679bcd"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_ai_gemini_llm_scraper_fetch",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_scraper/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskGetHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "获取 Gemini LLM 抓取器 HTML",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-ai-optimization-gemini-llm-scraper-task-get-html-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:44571a996534c296adb43f0acdcdc4f90bd4510260b43362fd706730f3356ba3",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "014ab171a152"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_ai_gemini_llm_scraper_fetch_html",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/html/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_scraper/task_get/html/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/html/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
when enabled, the HTML endpoint will return data from the expanded citation bar;
default value: false",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 2000 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name;
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code;
if you use this field, you don't need to specify language_code;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:2840",
"type": "integer"
},
"location_coordinate": {
"description": "location_name or location_codelocation_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format53.476225,-2.243572,200
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations
example:United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationGeminiLlmScraperTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Gemini LLM 抓取器",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-gemini-llm-scraper-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.701,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:4e3dc7e3cf01f9eef4cc01887af18aa60fa3d728b788954a55728d6a401ceee6",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "d1b4220f0f0b"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_gemini_llm_scraper_submit",
"path": "/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/gemini/llm_scraper/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_post \\\n --header 'Authorization: Bearer
optional field
minimal value 2025-08-01
date format \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"date_to": {
"description": "end date of the time range
optional field
Note value specified in date_from cannot exceed the value in date_to
date format \"yyyy-mm-dd\"",
"type": [
"string",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsHistoricalLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Historical",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_e9ddb6",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:8c75027b7777f150971705018f60c50e48171e054c66aeecf14c246b940d25d0",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "103334b0d11e"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_e9ddb6",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/historical/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/historical/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/historical/live \\\n --header 'Authorization: Bearer
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domainsearch_results_domain
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned objects
optional field100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000, use the search_after_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"items": {
"oneOf": [
{
"properties": {
"key": {
"description": "key for grouping the results\nrequired field\ngroups results for comparison and serves as a label for the group;\nyou can specify up to 250 characters in the key field",
"type": [
"string",
"null"
]
},
"target": {
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsMultiTargetMetricsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Multi Target Metrics",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_5d5a92",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:cbcd2a9d50505bb9b7b4546db8f39c7b2cf8ccd8f9ffbe175a53ee937f8126e1",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "c5266bcffb43"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_5d5a92",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/multi_target_metrics/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/multi_target_metrics/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/multi_target_metrics/live \\\n --header 'Authorization: Bearer
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned objects
optional field100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000, use the search_after_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"search_after_token": {
"description": "token for subsequent requests
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 1000 results in a single request;
by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;
Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsSearchMentionsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Search Mentions",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_50bbc1",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:4dbdc8e2e7cc8803bbe65228e9f5781204e3037391995e53f9a46c8c9ff56bff",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "f806bd5c2069"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_50bbc1",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/search_mentions/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/search_mentions/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/search_mentions/live \\\n --header 'Authorization: Bearer
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domainsearch_results_domain
minimum value: 1
maximum value: 10
default value: 10",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Target Metrics",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_17238a",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:e9086e606c0970dcd0e657df90d6d4e20e0cc78eff3f3489b1daf5220760faf7",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "9097884ceb97"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_17238a",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/target_metrics/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics/live \\\n --header 'Authorization: Bearer
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTargetMetricsLiteLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Target Metrics Lite",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_a6d8ec",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:5c41e2a850ff0830a801c606ae8bba83b923d8f72b69243f15f763e22f47c449",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "2db176e32fcf"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_a6d8ec",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics_lite/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/target_metrics_lite/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics_lite/live \\\n --header 'Authorization: Bearer
required field
minimal value: 2025-08-01
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"date_to": {
"description": "end date of the time range
required field
Note:the value specified in date_from cannot exceed the value in date_to
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"group_range": {
"description": "timeseries delta range
required field
possible values:day, week, month, year",
"type": "string"
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesDeltaLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Timeseries Delta",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_f012d1",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:34412cc94604d5de09e70a2bdd0553ed525491e0da624c21e86025918d1b954b",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "3be8abcd15a6"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_f012d1",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_delta/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/timeseries_delta/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_delta/live \\\n --header 'Authorization: Bearer
required field
minimal value: 2025-08-01
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"date_to": {
"description": "end date of the time range
required field
Note:the value specified in date_from cannot exceed the value in date_to
date format: \"yyyy-mm-dd\"",
"type": "string"
},
"group_range": {
"description": "timeseries range
required field
possible values:day, week, month, year",
"type": "string"
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTimeseriesNewLostLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Timeseries New Lost",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_cec905",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:349bc1f47024c2c2a44d742b164c274cbdf4ddcaccfe653fe67b6e91bc73b205",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "b7edf34524e8"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_cec905",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_new_lost/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/timeseries_new_lost/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_new_lost/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed brand categories will be omitted from the items array
example:\"exclude_brand_categories\": [\"business\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed brand categories will be returned in the items array
example:\"include_brand_categories\": [\"business\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Brand Categories",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_340892",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:c25538df6a92e9cf3a3d376efbd8b9c58e4441a5bec576d0d10fb0a6ce54996e",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "ca1e079b9676"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_340892",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_brand_categories/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed brand categories will be omitted from the items array
example:[\"company\",\"insurance\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed brand categories will be returned in the items array
example:[\"company\",\"insurance\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Brand Categories Lite",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_e666b9",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:2b7826a4f685a3fdd88b11441836d112b13dd0c02e9f28caec42737cb24bf79d",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "db364de9cfef"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_e666b9",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed brands will be omitted from the items array
example:\"exclude_brands\": [\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed brands will be returned in the items array
example:\"include_brands\": [\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Brands",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_03dcdc",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:e68730d712ac5b0e0beba468d86b71a5b24f462dccf41d08f0cacfab44fc34fb",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "bb8afc8977ff"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_03dcdc",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_brands/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed brands will be omitted from the items array
example:[\"BMW\",\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\", 1000]
optional field
if specified, only the listed brands will be returned in the items array
example:[\"BMW\",\"Audi\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: data specific to brand entities is available for chat_gpt only;
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Brands Lite",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_eae988",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:3e7e53f7a7047ca6c06641d1c064ea3a6daf489676d53475298f0f17d9e99867",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "bca343f75741"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_eae988",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands_lite/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_brands_lite/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands_lite/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed domains will be omitted from the items array
example:\"exclude_domains\": [\"en.wikipedia.org\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed domains will be returned in the items array
example:\"include_domains\": [\"en.wikipedia.org\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources
Note:if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Domains",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_042f7c",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:12baf50f0526afd3e9398475f1a6b7f2a79d9e80210c4e9606e45c7e9f53c6ba",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "96da05423145"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_042f7c",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_domains/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed domains will be omitted from the items array
example:[\"google.com\",\"bing.com\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed domains will be returned in the items array
example:[\"dataforseo.com\",\"seoinsider.com\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en onlyn",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources;
Note: if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Domains Lite",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_9e961b",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:8434e9594e1e50a096c247c167c1fa50c5ce64fbdc8471930bb08defbb0375b7",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "4e89ec360f46"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_9e961b",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains_lite/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_domains_lite/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains_lite/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed pages will be omitted from the items array
example:\"exclude_pages\": [\"https://example.page/\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed pages will be returned in the items array
example:\"include_pages\": [\"https://example.page/\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources;
Note:if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Pages",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_7d8b87",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:915538925ee04aca414889adf98bfd99a03c8e667b2c06327df982a5b66402f6",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "a795635d2742"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_7d8b87",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_pages/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages/live \\\n --header 'Authorization: Bearer
optional field
if specified, the listed pages will be omitted from the items array
example:
`[\"https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api\", \"https://dataforseo.com/apis/ai-optimization-api\"]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
optional field
if specified, only the listed pages will be returned in the items array
example:
`[\"https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api\", \"https://dataforseo.com/apis/ai-optimization-api\"]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"initial_dataset_filters": {
"description": "array of filter expressions applied before aggregation
optional field
you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"ai_search_volume\",\">\",1000]
learn more about the initial dataset filters in this help center article.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:sources_domain, search_results_domain, brand_entities_title, brand_entities_category
minimum value: 1
maximum value: 10
default value: 5",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search language code
optional field
if you use this field, you don't need to specify language_name;
you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: en
Note: chat_gpt data is available for en only",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search language
optional field
if you use this field, you don't need to specify language_code;
if you don't specify this field, the language_code with en value will be used by default;
you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for English only",
"type": [
"string",
"null"
]
},
"limit": {
"description": "maximum number of results in the items array
optional field
you can use this parameter to limit the number of data objects you receive in the items array
minimum value: 1
maximum value: 1000
default value: 100",
"type": [
"integer",
"null"
]
},
"links_scope": {
"description": "links source scope
optional field
this parameter specifies which links will be used to extract domains and aggregation data
possible values: sources, search_results
default value: sources; ;
Note: if you specify search_results, the data will be available for chat_gpt only",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
default value: 2840
Note: chat_gpt data is available for 2840 only",
"type": [
"integer",
"null"
]
},
"location_name": {
"description": "full name of search location
optional field
if you use this field, you don't need to specify location_code
if you don't specify this field, the location_code with 2840 value will be used by default;
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages
Note: chat_gpt data is available for United States only",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned mentions data
optional field0
example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;
Note: the maximum value is 1000000",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"ai_search_volume,desc\"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"platform": {
"description": "target platform
optional field
possible values:chat_gpt, google
default value: google
Note: if the platform is not specified, the data is returned for both platforms
Note #2:chat_gpt data is available for the United States and English only",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity",
"items": {
"oneOf": [
{
"discriminator": {
"mapping": {
"domain": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsDomainElement",
"keyword": "#/components/schemas/Provider0A3E90081762_AiOptimizationLLmMentionsKeywordElement"
},
"propertyName": "type"
},
"properties": {
"search_filter": {
"description": "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include",
"type": [
"string",
"null"
]
},
"search_scope": {
"description": "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Live Ai Optimization Llm Mentions Top Mentioned Pages Lite",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_ai_optimization_7768e5",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.101,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:be4005a09d72d63a9c752b251eec31692d47612f5685c7928f82aa67c590687b",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "99f077523d18"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_ai_optimization_7768e5",
"path": "/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages_lite/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/llm_mentions/top_mentioned_pages_lite/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages_lite/live \\\n --header 'Authorization: Bearer
optional field
minimum value: 1
maximum value: 4096;
default value: 2048;
Note: if the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit",
"type": [
"integer",
"null"
]
},
"message_chain": {
"description": "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]",
"items": {
"oneOf": [
{
"properties": {
"message": {
"description": "message text",
"type": [
"string",
"null"
]
},
"role": {
"description": "role of the user from whom the message originates",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": [
"array",
"null"
]
},
"model_name": {
"description": "name of the AI model
required fieldmodel_nameconsists of the actual model name and version name;
if the basic model name is specified, its latest version will be set by default;
you can receive the list of available LLM models by making a separate request to the following endpoint: https://api.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/models",
"type": "string"
},
"system_message": {
"description": "instructions for the AI behavior
optional field
defines the AI's role, tone, or specific behavior
you can specify up to 500 characters in the system_message field",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"temperature": {
"description": "randomness of the AI response
optional field
higher values make output more diverse
lower values make output more focused
minimum value: 0
maximum value: 1.9
default value: 0.77",
"type": [
"number",
"null"
]
},
"top_p": {
"description": "diversity of the AI response
optional field
controls diversity of the response by limiting token selection
minimum value: 0
maximum value: 1
default value: 0.9",
"type": [
"number",
"null"
]
},
"user_prompt": {
"description": "prompt for the AI model
required field
the question or task you want to send to the AI model;
you can specify up to 500 characters in the user_prompt field",
"type": "string"
},
"web_search_country_iso_code": {
"description": "country code for web search localization
optional field
specify the country ISO code to get localized web search results
Note: available only for Perplexity Sonar models
example: US",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AiOptimizationPerplexityLlmResponsesLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 Perplexity LLM 响应",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-ai-optimization-perplexity-llm-responses-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0163,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:58f534b4b38a3c14f5c53f7edf66b5d73e19510adf2e2ce0e508dac28a8e47ba",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "18d58b8aaf11"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_ai_perplexity_llm_responses_live",
"path": "/apis/v1/dataforseo/ai_optimization/perplexity/llm_responses/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/ai_optimization/perplexity/llm_responses/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/ai_optimization/perplexity/llm_responses/live \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppInfoTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Apple 应用信息结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-apple-app-info-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:8564c7f488e367bcc3654e6fc5e0d46ee54a42915316e48930c7169f5adc2372",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "00d8fe846649"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_apple_app_info_fetch",
"path": "/apis/v1/dataforseo/app_data/apple/app_info/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_info/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_info/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
required field
ID of the mobile application on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL `https://apps.apple.com/us/app/id835599320`
the id is `835599320`",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:
`http://your-server.com/pingscript?id=$id`
`http://your-server.com/pingscript?id=$id&tag=$tag`
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:
`http://your-server.com/postbackscript?id=$id`
`http://your-server.com/postbackscript?id=$id&tag=$tag`
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priority You will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppInfoTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Apple 应用信息任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-apple-app-info-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:581f06ad833b4fa68ec2884682bbee825a5dc5458bec9d2e862965ea686edc3a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "34d8d078d71e"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_apple_app_info_submit",
"path": "/apis/v1/dataforseo/app_data/apple/app_info/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_info/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_info/task_post \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Apple App List 结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-apple-app-list-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:49634ab91a98daccd2f22d3d00756fe24b6271c6e737358d13193651ff2130e9",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "dfefbc3a4969"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_apple_app_list_fetch",
"path": "/apis/v1/dataforseo/app_data/apple/app_list/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_list/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_list/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
the categories you specify are used to search for app listings;
you can get the full list of available app listing categories by this link
you can specify up to 10 categories",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"description": {
"description": "keyword in the app's description
optional field
keywords that occur in the description of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"rating.value\",\">\",3]https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filtersn",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned apps
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned apps
optional field
default value: 0
if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"item.rating.value,desc\"]
you should use a comma to separate several sorting rules
example:[\"item.rating.value,desc\",\"item.rating.value,desc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"title": {
"description": "keyword in the app's title
optional field
keywords that occur in the title of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppListingsSearchLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 Apple App 列表搜索结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-apple-app-listings-search-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:6ebe48c80f14e57a0814c259bd63c6a7b3280b8a5277fdd6f29d5eb25a885732",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "4d74f3fff2c7"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_apple_app_listings_search_live",
"path": "/apis/v1/dataforseo/app_data/apple/app_listings/search/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_listings/search/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/live \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppReviewsTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Apple App 评论结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-apple-app-reviews-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:bc23510b680708bad75692b595accd7269a4dd284065e051cae065d50fc43ceb",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "a0d236ef4700"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_apple_app_reviews_fetch",
"path": "/apis/v1/dataforseo/app_data/apple/app_reviews/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_reviews/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_reviews/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
required field
ID of the mobile application on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL https://apps.apple.com/us/app/id835599320
the id is 835599320",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of reviews to be returned in the API response;
we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;
default value: 25;
maximum value: 500;
Setting depth above 25 may result in additional charges if the search engine returns more than 25 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results;
possible types of sorting:most_recent — sort by the most recent reviews;most_helpful — sort by the most relevant reviews;
default rule: most_helpful",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppReviewsTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Apple 应用评论任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-apple-app-reviews-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:77582f735d1d778f6c7f2af5864ea865c1d0ab89a22f0c64ccb585bb9ab0512a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "d38543256b77"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_apple_app_reviews_submit",
"path": "/apis/v1/dataforseo/app_data/apple/app_reviews/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_reviews/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_reviews/task_post \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppSearchesTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Apple App 搜索结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-apple-app-searches-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:2445a2b542df31ca4db416678a165db916dc4a84609335d5672e51b761af1c6b",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "2e7628ed89e4"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_apple_app_searches_fetch",
"path": "/apis/v1/dataforseo/app_data/apple/app_searches/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_searches/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_searches/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
number of results to be returned from the App Store SERP;
we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;
default value: 100
maximum value: 700
Your account will be billed per each SERP containing up to 100 results;
Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if language_name is not specified
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:enn",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if language_code is not specified
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataAppleAppSearchesTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Apple 应用搜索任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-apple-app-searches-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:3366ec414984180f7e4e03aab59dbde7cc5e472991478d336a71e3d2fe783e73",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "d166db6cb8c6"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_apple_app_searches_submit",
"path": "/apis/v1/dataforseo/app_data/apple/app_searches/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/apple/app_searches/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/apple/app_searches/task_post \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Google 应用信息结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-google-app-info-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:3b7b7763734e9d29f48ceefc666c0b3c7656db8c89c93119bf6441d31f9ef564",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "48016b61ef0d"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_google_app_info_fetch",
"path": "/apis/v1/dataforseo/app_data/google/app_info/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_info/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_info/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskGetHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Google 应用信息 HTML 结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-google-app-info-task-get-html-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:a3f3ed44856a4d98d3d99000dc0a9dcaf42104a64828e643523ed6208718fae0",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "2ee6b4f12a3d"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_google_app_info_fetch_html",
"path": "/apis/v1/dataforseo/app_data/google/app_info/task_get/html/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_info/task_get/html/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_info/task_get/html/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
required field
ID of the mobile application on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:
in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger
the id is org.telegram.messenger",
"type": "string"
},
"language_code": {
"description": "search engine language code
required field if language_name is not specified
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if language_code is not specified
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppInfoTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Google 应用信息任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-google-app-info-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:709393df357d63c16da887ce131e7aa4c332344b418863d6901de1de6e5aa803",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "3c87ae648e9b"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_google_app_info_submit",
"path": "/apis/v1/dataforseo/app_data/google/app_info/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_info/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_info/task_post \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Google 应用列表结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-google-app-list-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:1b7ca43829fe57f81696fbd3d3e0f11db1bfaf7ecb6364330742204c5423166d",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "7d3802e13f15"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_google_app_list_fetch",
"path": "/apis/v1/dataforseo/app_data/google/app_list/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_list/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_list/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskGetHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Google App 列表 HTML 结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-google-app-list-task-get-html-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:da18dca05a5ae6ab1f0f895fe2dcf4302eb9e868f0b41fc42a36e6838df347c1",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "ca8e7647599e"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_google_app_list_fetch_html",
"path": "/apis/v1/dataforseo/app_data/google/app_list/task_get/html/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_list/task_get/html/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_list/task_get/html/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
you can use this field to filter the results by age rating;
possible types of filtering:ages_up_to_5 — return apps approved for children up to 5 years old;ages_6_8 — return apps approved for children from 6 to 8 years old;ages_9_12 — return apps approved for children from 9 to 12 years old;
by default, the API returns apps for all ages;
Note: this filter works only in conjunction with the \"category\": \"family\" parameter",
"type": [
"string",
"null"
]
},
"app_category": {
"description": "application category on Google Play
optional field
you can filter the results by app category;
example:family;
you can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/google/categories
Note: app_category cannot be used if app_collection parameter is set to featured",
"type": [
"string",
"null"
]
},
"app_collection": {
"description": "app collection
required field
app collection on Google Play from which apps will be collected;
you can specify the following values:featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_shakers
Note: if featured is selected, the app_category parameter cannot be used",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of apps to be returned in the API response;
we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;
default value: 100;
maximum value: 200;
Your account will be billed per each SERP containing up to 100 results;
Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if language_name is not specified
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if language_code is not specified
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Google 应用列表任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-google-app-list-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:bb38975d893b712a7a19819e2a670134c3ec5538a08c3731cde2cf8b785f57ac",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "30f7bd8e3c7b"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_google_app_list_submit",
"path": "/apis/v1/dataforseo/app_data/google/app_list/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_list/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_list/task_post \\\n --header 'Authorization: Bearer
optional field
the categories you specify are used to search for app listings;
you can get the full list of available app listing categories by this link
you can specify up to 10 categories",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"description": {
"description": "keyword in the app's description
optional field
keywords that occur in the description of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"item.rating.value\",\">\",3]https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"limit": {
"description": "the maximum number of returned apps
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned apps
optional field
default value: 0
if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities
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.",
"type": [
"integer",
"null"
]
},
"offset_token": {
"description": "token for subsequent requests
optional field
provided 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 task
Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request
learn more about this parameter on our Help Center",
"type": [
"string",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:[\"item.installs_count,asc\"]
you should use a comma to separate several sorting rules
example:[\"item.rating.value,desc\",\"item.installs_count,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"title": {
"description": "keyword in the app's title
optional field
keywords that occur in the title of the app;
can contain up to 200 characters",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppListingsSearchLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "实时 Google 应用列表搜索结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-google-app-listings-search-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:9d514976905f23184f063acb085fe9d79848c3886f4736e7e0b7184f7da9d0bc",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "ae8e79603863"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_google_app_listings_search_live",
"path": "/apis/v1/dataforseo/app_data/google/app_listings/search/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_listings/search/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_listings/search/live \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Google 应用评论结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-google-app-reviews-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:95a69ead6571fde430d43d3fcf62389892d702c9383e014bbd1a0af58a8e41fc",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "86fcf2662e65"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_google_app_reviews_fetch",
"path": "/apis/v1/dataforseo/app_data/google/app_reviews/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_reviews/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_reviews/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskGetHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "Get App Data Google App Reviews Html Results by id",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/any_dataforseo_apis_v1_dataforseo_app_data_google_45547b",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:62d28082ba0085125808d8729a0cd990e405fd3d2bbd67b3e1df31810159de61",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "1c4ec9fdc3bd"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "any_dataforseo_apis_v1_dataforseo_app_data_google_45547b",
"path": "/apis/v1/dataforseo/app_data/google/app_reviews/task_get/html/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_reviews/task_get/html/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_reviews/task_get/html/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
required field
ID of the mobile application on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:https://play.google.com/store/apps/details?id=org.telegram.messenger",
"type": "string"
},
"depth": {
"description": "parsing depth
optional field
number of reviews to be returned in the API response;
we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;
default value: 150;
maximum value: 100000;
Your account will be billed per each SERP containing up to 150 results;
Setting depth above 150 may result in additional charges if the search engine returns more than 150 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"language_code": {
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": "string"
},
"language_name": {
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": "string"
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"rating": {
"description": "filter reviews by rating
optional field
you can use this field to filter the results;
possible types of filtering:5 — return reviews with five-star rating only;4 — return reviews with four-star rating only;3 — return reviews with three-star rating only;2 — return reviews with two-star rating only;1 — return reviews with one-star rating only;
by default, the API returns all reviews regardless of the number of stars",
"type": [
"integer",
"null"
]
},
"sort_by": {
"description": "results sorting parameters
optional field
you can use this field to sort the results;
possible types of sorting:newest — sort by the most recent reviews;most_relevant — sort by the most relevant reviews;
default rule: most_relevant",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppReviewsTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Google 应用评论任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-google-app-reviews-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:2f5a1e61ebc0057ef47dd534a6f6f94adf30c79c8a349ca6462943fc145fcaef",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "30cc690c7dca"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_google_app_reviews_submit",
"path": "/apis/v1/dataforseo/app_data/google/app_reviews/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_reviews/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_reviews/task_post \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskGetAdvancedResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Google 应用搜索结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-google-app-searches-task-get-advanced-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:e9859a6e4986cf2e3fac856a6bb30cd0bfda4ec2430a9309b04397db6103507a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "6f2f6d89f78c"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_google_app_searches_fetch",
"path": "/apis/v1/dataforseo/app_data/google/app_searches/task_get/advanced/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_searches/task_get/advanced/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_searches/task_get/advanced/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time",
"example": "00000000-0000-0000-0000-000000000000",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskGetHtmlResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "按 id 获取 Google App Searches HTML 结果",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-app-data-google-app-searches-task-get-html-id",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "explicit_zero",
"customer_pricing": "fixed_success",
"default_request_estimate_usd": 0.0,
"estimate_source": "customer_pricing_fixed",
"evidence_source": "request_snapshot"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:f9821292ffd1c6b99c3178340cb47f6dfb4c6a927ec84aaba15f88b9a3ddb51a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "997eb61c224f",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "2b0622bd50f1"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "get_dataforseo_app_google_app_searches_fetch_html",
"path": "/apis/v1/dataforseo/app_data/google/app_searches/task_get/html/{id}"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_searches/task_get/html/{id}",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_searches/task_get/html/00000000-0000-0000-0000-000000000000 \\\n --header 'Authorization: Bearer
optional field
number of results to be returned to be returned from the Google Play SERP;
we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;
default value: 30;
maximum value: 200;
Your account will be billed per each SERP containing up to 30 results;
Setting depth above 30 may result in additional charges if the search engine returns more than 30 results;
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "keyword
required field
you can specify up to 700 characters in the keyword field;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”keyword and keywords fields in DataForSEO APIs in this Help Center article",
"type": "string"
},
"language_code": {
"description": "search engine language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:en",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "full name of search engine language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages
example:English",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "search engine location code
required field if you don't specify location_name
if you use this field, you don't need to specify location_name
you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:9061121",
"type": "integer"
},
"location_name": {
"description": "full name of search engine location
required field if you don't specify location_code
if you use this field, you don't need to specify location_code
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations
example:West Los Angeles,California,United States",
"type": "string"
},
"pingback_url": {
"description": "notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
possible values:advanced, html",
"type": "string"
},
"postback_url": {
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23",
"type": [
"string",
"null"
]
},
"priority": {
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_AppDataGoogleAppSearchesTaskPostResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "设置 Google 应用搜索任务",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-app-data-google-app-searches-task-post",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.012,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:d38000cb6db29200d5075bb3395748e90179b48e6aba607e7e0d6b2144e76b0a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "06c19aa3f513"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_app_google_app_searches_submit",
"path": "/apis/v1/dataforseo/app_data/google/app_searches/task_post"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/app_data/google/app_searches/task_post",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/app_data/google/app_searches/task_post \\\n --header 'Authorization: Bearer target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [[\"dofollow\", \"=\", true]]",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"referring_links_types.anchors\",\">\",\"1\"][[\"broken_pages\",\">\",\"2\"],
\"and\",
[\"backlinks\",\">\",\"10\"]][[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"anchor\",\"like\",\"%seo%\"],\"or\",[\"referring_domains\",\">\",\"10\"]]]target will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"limit": {
"description": "the maximum number of returned anchors
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the results array of returned anchors
optional field
default value: 0
if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"backlinks,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get anchors for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksAnchorsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "锚点",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-anchors-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.033,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:a973fc05c6d1f7381e54b64b43734a7ab712b772e4ece19a9ec39aae171da34c",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "fd764c0f9c22"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_anchors_live",
"path": "/apis/v1/dataforseo/backlinks/anchors/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/anchors/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/anchors/live \\\n --header 'Authorization: Bearer
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"custom_mode": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "detailed results grouping type
optional field
use this object to get a specific number of backlinks per field
if you use custom_mode, then mode will be ignored
example:\"custom_mode\": {\"field\": \"domain\", \"value\": 100}",
"type": [
"object",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates if internal backlinks from subdomains to the target will be excluded from the results
optional field
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
if set to false, internal links will be included in the results
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"rank\",\">\",\"80\"][[\"page_from_rank\",\">\",\"55\"],
\"and\",
[\"dofollow\",\"=\",true]][[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"anchor\",\"like\",\"%seo%\"],\"or\",[\"text_pre\",\"like\",\"%seo%\"]]]target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"limit": {
"description": "the maximum number of returned backlinks
optional field100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"mode": {
"description": "results grouping type
optional field
possible grouping types:as_is - returns all backlinksone_per_domain - returns one backlink per domainone_per_anchor - returns one backlink per anchoras_is",
"type": [
"string",
"null"
]
},
"offset": {
"description": "offset in the results array of the returned backlinks
optional field0
if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks;
Note: the maximum value is 20,000, use the search_after_token if you would like to offset more results",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"rank,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"domain_from_rank,desc\",\"page_from_rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
provided in the identical filed of the response to each request;
use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;
by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;
Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get backlinks for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBacklinksLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "反向链接",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-backlinks-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.06,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:50f3bdb78faf9f561fd8e54029b4fe919f16fe534cd012897587d5e8cb9d15ab",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "166122f86788"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_backlinks_live",
"path": "/apis/v1/dataforseo/backlinks/backlinks/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/backlinks/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live \\\n --header 'Authorization: Bearer
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get the number of backlinks for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkBacklinksLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "批量反向链接",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-bulk-backlinks-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.024,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:81ac5af4da9fa9f7c98826cf6d7719f8cffdf8dfb8734730bf600c30cabbc675",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "63ec7fc0ff01"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_bulk_backlinks_live",
"path": "/apis/v1/dataforseo/backlinks/bulk_backlinks/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/bulk_backlinks/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/bulk_backlinks/live \\\n --header 'Authorization: Bearer
optional field
this field indicates the date which will be used as a threshold for new and lost backlinks;
the backlinks that appeared in our index after the specified date will be considered as new;
the backlinks that weren't found after the specified date, but were present before, will be considered as lost;
e.g. if today is 2021-10-13, default date_from will be 2021-09-13.
minimum value equals today's date -(minus) one year;
e.g. if today is 2021-10-13, minimum date_from will be 2020-10-13.\"yyyy-mm-dd\"
example:\"2021-01-01\"",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get new & lost backlinks for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without `https://` and `www.` the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostBacklinksLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "批量新增和丢失的反向链接",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-bulk-new-lost-backlinks-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.06,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:cf1fc8396f021d998b155d1a97f4475bbd7eba2df9ce67a3e7f009d5cf4f793a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "fdba802b3391"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_bulk_new_lost_backlinks_live",
"path": "/apis/v1/dataforseo/backlinks/bulk_new_lost_backlinks/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/bulk_new_lost_backlinks/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/bulk_new_lost_backlinks/live \\\n --header 'Authorization: Bearer
optional field
this field indicates the date which will be used as a threshold for new and lost referring domains;
the referring domains that appeared in our index after the specified date will be considered as new;
the referring domains that weren't found after the specified date, but were present before, will be considered as lost;
e.g. if today is 2021-10-13, default date_from will be 2021-09-13.
minimum value equals today's date -(minus) one year;
e.g. if today is 2021-10-13, minimum date_from will be 2020-10-13.\"yyyy-mm-dd\"
example:\"2021-01-01\"",
"type": [
"string",
"null"
]
},
"tag": {
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get new & lost referring domains for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkNewLostReferringDomainsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "批量新增和丢失的引荐域名",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-bulk-new-lost-referring-domains-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.06,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:ab9fbdd3eae9f0f2d9c78d5feb7f2478ccab443f27ae43b4bfa9bd2259f5cf3b",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "38d0b0dbef35"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_bulk_new_lost_ref_domains_live",
"path": "/apis/v1/dataforseo/backlinks/bulk_new_lost_referring_domains/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/bulk_new_lost_referring_domains/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/bulk_new_lost_referring_domains/live \\\n --header 'Authorization: Bearer target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get summary data for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)
you can specify up to 1000 pages, domains, or subdomains in each request.
note that the URLs you set in a single request cannot belong to more than 100 different domains.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkPagesSummaryLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "批量页面摘要",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-bulk-pages-summary-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0242,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:c4e8e341a16be47b0b08949699227504dda775778d376a381cb1f2718001aa68",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "dbfee0a329a2"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_bulk_pages_summary_live",
"path": "/apis/v1/dataforseo/backlinks/bulk_pages_summary/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/bulk_pages_summary/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/bulk_pages_summary/live \\\n --header 'Authorization: Bearer rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get rank for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkRanksLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "批量排名",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-bulk-ranks-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.025,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:be3ea2e33d29cfcc1146ae7a6724b410ca331c7d13f894c9cf1dfa5915a34ed5",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "088eae8ec98d"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_bulk_ranks_live",
"path": "/apis/v1/dataforseo/backlinks/bulk_ranks/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/bulk_ranks/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/bulk_ranks/live \\\n --header 'Authorization: Bearer
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get the number of referring domains for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkReferringDomainsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "批量引用域名",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-bulk-referring-domains-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0254,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:bc1d62d652bf765203cb239c0c9b2f68f1ec5d0d08afab74edb6a590e25f1176",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "8d8496b3f51f"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_bulk_referring_domains_live",
"path": "/apis/v1/dataforseo/backlinks/bulk_referring_domains/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/bulk_referring_domains/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/bulk_referring_domains/live \\\n --header 'Authorization: Bearer
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"description": "domains, subdomains or webpages to get rank for
required field
you can set up to 1000 domains, subdomains or webpages
the domain or subdomain should be specified without https:// and www.
the page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": [
\"forbes.com\",
\"cnn.com\",
\"bbc.com\",
\"yelp.com\",
\"https://www.apple.com/iphone/\",
\"https://ahrefs.com/blog/\",
\"ibm.com\",
\"https://variety.com/\",
\"https://stackoverflow.com/\",
\"www.trustpilot.com\"
]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksBulkSpamScoreLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "批量垃圾评分",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-bulk-spam-score-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.06,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:e6fd3f703d78be3860d978891c96fbc3395558cc408f4f762bffa35e42f6605a",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "a7816209b090"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_bulk_spam_score_live",
"path": "/apis/v1/dataforseo/backlinks/bulk_spam_score/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/bulk_spam_score/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/bulk_spam_score/live \\\n --header 'Authorization: Bearer target will be excluded from the results
optional field
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
if set to false, internal links will be included in the results
default value: true",
"type": [
"boolean",
"null"
]
},
"exclude_large_domains": {
"description": "indicates whether large domain will appear in results
optional field
if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;
default value: true",
"type": [
"boolean",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"rank\",\">\",\"100\"][[\"target\",\"like\",\"%forbes%\"],
\"and\",
[[\"rank\",\">\",\"100\"],\"or\",[\"intersections\",\">\",\"5\"]]]
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"main_domain": {
"description": "indicates if only main domain of the target will be included in the search
optional field
if set to true, only the main domain will be included in search;
default value: true",
"type": [
"boolean",
"null"
]
},
"offset": {
"description": "offset in the results array of returned domains
optional field
default value: 0
if 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 pages",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"rank,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"intersections,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"target": {
"description": "domain, subdomain or webpage to get competitor domains for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksCompetitorsLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "竞争对手",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-competitors-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0276,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:37ec83a6682026121794dada48f9fdde26ccb75b542a0103fc5a6da9da017044",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "a03eb0ec1c86"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_competitors_live",
"path": "/apis/v1/dataforseo/backlinks/competitors/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/competitors/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/competitors/live \\\n --header 'Authorization: Bearer target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:\"backlinks_filters\": [[\"dofollow\", \"=\", true]]",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"backlinks_status_type": {
"description": "set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets;
possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;live",
"type": [
"string",
"null"
]
},
"exclude_internal_backlinks": {
"description": "indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, the backlinks from subdomains of the target will be omitted and you won't receive the same domain in the response;
default value: true",
"type": [
"boolean",
"null"
]
},
"exclude_targets": {
"description": "domains, subdomains or webpages you want to exclude
optional field
you can specify up to 10 domains, subdomains or webpages
if you use this array, results will contain the referring domains that link to targets but don't link to exclude_targets
example:
`\"exclude_targets\": [
\"bbc.com\",
\"https://www.apple.com/iphone/*\",
\"https://dataforseo.com/apis/*\"]`",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"filters": {
"description": "array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:[\"1.internal_links_count\",\">\",\"1\"][[\"2.referring_pages\",\">\",\"2\"],
\"and\",
[\"1.backlinks\",\">\",\"10\"]][[\"1.first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],
\"and\",
[[\"2.target\",\"like\",\"%dataforseo.com%\"],\"or\",[\"1.referring_domains\",\">\",\"10\"]]]targets will be included in the results
optional field
if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page
if set to false, indirect links will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"include_subdomains": {
"description": "indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true",
"type": [
"boolean",
"null"
]
},
"internal_list_limit": {
"description": "maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locations10
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"intersection_mode": {
"description": "indicates whether to intersect backlinks
optional field
use this field to intersect or merge results for the specified domains
possible values: all, partialall - results are based on all backlinks;partial - results are based on the intersecting backlinks only;
default value: all",
"type": [
"string",
"null"
]
},
"limit": {
"description": "the maximum number of returned results
optional field
default value: 100
maximum value: 1000",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "offset in the array of returned results
optional field
default value: 0
if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending order
you should use a comma to set up a sorting type
example:[\"backlinks,desc\"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:[\"backlinks,desc\",\"rank,asc\"]",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"rank_scale": {
"description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional fieldone_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaleone_thousand
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response",
"type": [
"string",
"null"
]
},
"targets": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "domains, subdomains or webpages to get links for
required field
you can set up to 20 domains, subdomains or webpages
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)
example:
`\"targets\": {
\"1\": \"http://planet.postgresql.org/\",
\"2\": \"http://gborg.postgresql.org/\"
}`",
"type": [
"object",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Response0A3E90081762_BacklinksDomainIntersectionLiveResponseInfo"
}
],
"type": [
"object",
"null"
]
}
}
},
"description": "Successful operation"
},
"default": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Error response; upstream passthrough responses may use provider formats"
}
},
"summary": "域名交集",
"tags": [
"default"
],
"x-aisa-capabilities": {
"idempotency": "Idempotency-Key",
"max_price": "X-AISA-Max-Price-USD",
"mpp": false,
"mpp_methods": [],
"quote": {
"header": "X-AISA-Cost-Mode",
"value": "quote"
},
"x402": false
},
"x-aisa-catalog-id": "dataforseo",
"x-aisa-category": "13",
"x-aisa-docs-url": "https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-domain-intersection-live",
"x-aisa-passthrough": true,
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.06,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"x-aisa-query-policy": {
"ignore_undeclared": false,
"request_wins": true
},
"x-aisa-response-source": {
"content_hash": "sha256:ccf5d54d3f7c757b0ff9de539c8f3eec70faf11389f954f4e47f47e4367b9304",
"kind": "upstream_success_contract",
"source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
}
},
"x-aisa-revision": {
"customer_pricing_ref": "6155513a94fd",
"plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb",
"profile_ref": "660a596d645e"
},
"x-aisa-runtime-operation": {
"method": "ANY",
"operation_id": "post_dataforseo_backlinks_domain_intersection_live",
"path": "/apis/v1/dataforseo/backlinks/domain_intersection/live"
},
"x-aisa-source": {
"content_hash": "sha256:4af5b8359214f2a833013bf0956702d4de186356b9ba15a9646892917d482a2c",
"converter": "scripts/import_dataforseo_filters.py@1",
"duplicate_batch_examples_removed": 272,
"fetched_at": "2026-10-16T11:32:33.369735+00:00",
"filter_json_fields_normalized": 85,
"kind": "provider_openapi",
"owner": "AIsa-team/docs",
"policy_revision": "sha256:718bb0ba1ba18fb3b562443eb74e96aa9057b6e584050e7817cda944fe8fea62",
"refresh_interval_hours": 24,
"refresh_policy": "automatic",
"review_period_days": 30,
"upstream_content_hash": "sha256:8539f0b2a3a415e5553c9337a97d2f74cc00e24db72cc0505ad5eab1f1e4ffff",
"url": "https://raw.githubusercontent.com/dataforseo/OpenApiDocumentation/master/openapi_specification.yaml"
},
"x-aisa-status": "enabled",
"x-aisa-upstream-path": "/v3/backlinks/domain_intersection/live",
"x-aisa-validation": "provider",
"x-codeSamples": [
{
"label": "Reference example",
"lang": "text",
"source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_intersection/live \\\n --header 'Authorization: Bearer