addedInput schema / $defs
Added value: +{
+ "Provider0A3E90081762_AisaDataforseoFilterJsonValue": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/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."
+ }
+}
addedInput schema / properties / body / items / anyOf
Added value: +[
+ {
+ "properties": {
+ "filters": {
+ "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/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"
+ ]
+ },
+ "ignore_synonyms": {
+ "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "include_clickstream_data": {
+ "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "include_serp_info": {
+ "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "limit": {
+ "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>",
+ "type": "string"
+ },
+ "offset": {
+ "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "offset_token": {
+ "description": "<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task.<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "order_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]
removedInput schema / properties / body / items / oneOf
Removed value: -[
- {
- "example": [
- {
- "language_name": "English",
- "limit": 3,
- "location_code": 2840
- }
- ],
- "properties": {
- "filters": {
- "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>",
- "items": {
- "type": [
- "object",
- "null"
- ]
- },
- "type": [
- "array",
- "null"
- ]
- },
- "ignore_synonyms": {
- "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "include_clickstream_data": {
- "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "include_serp_info": {
- "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "limit": {
- "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>",
- "type": "string"
- },
- "offset": {
- "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.",
- "type": [
- "integer",
- "null"
- ]
- },
- "offset_token": {
- "description": "<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task.<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "order_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]