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": {
+ "backlinks_status_type": {
+ "description": "<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>targets</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "exclude_internal_backlinks": {
+ "description": "<em>indicates if internal backlinks from subdomains to the <code>target</code> will be excluded from the results</em><br>optional field<br>if set to <code>true</code>, the results will not include data on internal backlinks from subdomains of the same domain as <code>target</code><br>if set to <code>false</code>, internal links will be included in the result<br>default value: <code>true</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "exclude_targets": {
+ "description": "<em>domains, subdomains or webpages you want to exclude</em><br>optional field<br>you can set up to 10 domains, subdomains or webpages<br>if you use this array, results will contain the referring pages that link to <code>targets</code> but don't link to <code>exclude_targets</code><br>example:<br>`\"exclude_targets\": [<br>\"bbc.com\",<br>\"https://www.apple.com/iphone/*\",<br>\"https://dataforseo.com/apis/*\"]`",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "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>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"1.rank\",\">\",\"80\"]</code><p><code>[[\"2.page_from_rank\",\">\",\"55\"],<br>\"and\",<br>[\"1.original\",\"=\",\"true\"]]</code><p><code>[[\"1.first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],<br>\"and\",<br>[[\"1.acnhor\",\"like\",\"%seo%\"],\"or\",[\"1.text_pre\",\"not_like\",\"%seo%\"]]]</code><p>The full list of possible filters is available <a href=\"/v3/backlinks/filters/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">here.</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"
+ ]
+ },
+ "include_indirect_links": {
+ "description": "<em>indicates if indirect links to the <code>targets</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "include_subdomains": {
+ "description": "<em>indicates if the subdomains of the <code>targets</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "internal_list_limit": {
+ "description": "<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>attributes</code><br><code>domain_from_platform_type</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "intersection_mode": {
+ "description": "<em>indicates whether to intersect backlinks</em><br>optional field<br>use this field to intersect or merge results for the specified URLs<br>possible values: <code>all</code>, <code>partial</code><br><code>all</code> - results are based on all backlinks;<br><code>partial</code> - results are based on the intersecting backlinks only;<br>default value: <code>all</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "limit": {
+ "description": "<em>the maximum number of returned backlinks</em><br>optional field<p>default value: <code>100</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "offset": {
+ "description": "<em>offset in the results array of the returned backlinks</em><br>optional field<p>default value: <code>0</code><br>if you specify the <code>10</code> 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": "<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>[\"rank,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>[\"domain_from_rank,desc\",\"page_from_rank,asc\"]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "rank_scale": {
+ "description": "<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale\">this Help Center article</a>",
+ "type": [
+ "string",
+ "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"
+ ]
+ },
+ "targets": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": "<em>domains, subdomains or webpages to get links for</em><br><strong>required field</strong><br>you can set up to 20 domains, subdomains or webpages<br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`\"targets\": {<br>\"1\": \"http://planet.postgresql.org/\",<br>\"2\": \"http://gborg.postgresql.org/\"<br>}`",
+ "type": [
+ "object",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]
removedInput schema / properties / body / items / oneOf
Removed value: -[
- {
- "example": [
- {
- "exclude_targets": [
- "skysports.com"
- ],
- "filters": [
- [
- "2.domain_from_rank",
- ">",
- 400
- ],
- "and",
- [
- "1.dofollow",
- "=",
- true
- ]
- ],
- "limit": 5,
- "order_by": [
- "1.rank,desc"
- ],
- "targets": {
- "1": "football.com",
- "2": "fifa.com"
- }
- }
- ],
- "properties": {
- "backlinks_status_type": {
- "description": "<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>targets</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "exclude_internal_backlinks": {
- "description": "<em>indicates if internal backlinks from subdomains to the <code>target</code> will be excluded from the results</em><br>optional field<br>if set to <code>true</code>, the results will not include data on internal backlinks from subdomains of the same domain as <code>target</code><br>if set to <code>false</code>, internal links will be included in the result<br>default value: <code>true</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "exclude_targets": {
- "description": "<em>domains, subdomains or webpages you want to exclude</em><br>optional field<br>you can set up to 10 domains, subdomains or webpages<br>if you use this array, results will contain the referring pages that link to <code>targets</code> but don't link to <code>exclude_targets</code><br>example:<br>`\"exclude_targets\": [<br>\"bbc.com\",<br>\"https://www.apple.com/iphone/*\",<br>\"https://dataforseo.com/apis/*\"]`",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "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>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"1.rank\",\">\",\"80\"]</code><p><code>[[\"2.page_from_rank\",\">\",\"55\"],<br>\"and\",<br>[\"1.original\",\"=\",\"true\"]]</code><p><code>[[\"1.first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],<br>\"and\",<br>[[\"1.acnhor\",\"like\",\"%seo%\"],\"or\",[\"1.text_pre\",\"not_like\",\"%seo%\"]]]</code><p>The full list of possible filters is available <a href=\"/v3/backlinks/filters/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>",
- "items": {
- "type": [
- "object",
- "null"
- ]
- },
- "type": [
- "array",
- "null"
- ]
- },
- "include_indirect_links": {
- "description": "<em>indicates if indirect links to the <code>targets</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "include_subdomains": {
- "description": "<em>indicates if the subdomains of the <code>targets</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "internal_list_limit": {
- "description": "<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>attributes</code><br><code>domain_from_platform_type</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "intersection_mode": {
- "description": "<em>indicates whether to intersect backlinks</em><br>optional field<br>use this field to intersect or merge results for the specified URLs<br>possible values: <code>all</code>, <code>partial</code><br><code>all</code> - results are based on all backlinks;<br><code>partial</code> - results are based on the intersecting backlinks only;<br>default value: <code>all</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "limit": {
- "description": "<em>the maximum number of returned backlinks</em><br>optional field<p>default value: <code>100</code><br>maximum value: <code>1000</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "offset": {
- "description": "<em>offset in the results array of the returned backlinks</em><br>optional field<p>default value: <code>0</code><br>if you specify the <code>10</code> 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": "<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>[\"rank,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>[\"domain_from_rank,desc\",\"page_from_rank,asc\"]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "rank_scale": {
- "description": "<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale\">this Help Center article</a>",
- "type": [
- "string",
- "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"
- ]
- },
- "targets": {
- "additionalProperties": {
- "type": [
- "string",
- "null"
- ]
- },
- "description": "<em>domains, subdomains or webpages to get links for</em><br><strong>required field</strong><br>you can set up to 20 domains, subdomains or webpages<br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`\"targets\": {<br>\"1\": \"http://planet.postgresql.org/\",<br>\"2\": \"http://gborg.postgresql.org/\"<br>}`",
- "type": [
- "object",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]
