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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</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"
+ ]
+ },
+ "historical_serp_mode": {
+ "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>",
+ "type": [
+ "string",
+ "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_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data 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"
+ ]
+ },
+ "item_types": {
+ "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, 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;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "language_code": {
+ "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages 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>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages 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>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "limit": {
+ "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</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>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <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>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "offset": {
+ "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> 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": "<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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array",
+ "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"
+ ]
+ },
+ "target": {
+ "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+]
removedInput schema / properties / body / items / oneOf
Removed value: -[
- {
- "example": [
- {
- "filters": [
- [
- "metrics.organic.pos_1",
- "<>",
- 0
- ],
- "or",
- [
- "metrics.organic.pos_2_3",
- "<>",
- 0
- ]
- ],
- "language_name": "English",
- "limit": 3,
- "location_code": 2840,
- "target": "amazon.com"
- }
- ],
- "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</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"
- ]
- },
- "historical_serp_mode": {
- "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>",
- "type": [
- "string",
- "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_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data 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"
- ]
- },
- "item_types": {
- "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, 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;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "language_code": {
- "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages 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>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "language_name": {
- "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages 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>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "limit": {
- "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</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>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "location_name": {
- "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <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>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "offset": {
- "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> 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": "<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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array",
- "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"
- ]
- },
- "target": {
- "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>",
- "type": "string"
- }
- },
- "type": "object"
- }
-]