Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"target": "forbes.com",
"limit": 4,
"order_by": [
"backlinks,desc"
]
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"limit": 4,
"order_by": [
"backlinks,desc"
],
"target": "forbes.com"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live"
payload = [
{
"limit": 4,
"order_by": ["backlinks,desc"],
"target": "forbes.com"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([{limit: 4, order_by: ['backlinks,desc'], target: 'forbes.com'}])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'limit' => 4,
'order_by' => [
'backlinks,desc'
],
'target' => 'forbes.com'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live"
payload := strings.NewReader("[\n {\n \"limit\": 4,\n \"order_by\": [\n \"backlinks,desc\"\n ],\n \"target\": \"forbes.com\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"limit\": 4,\n \"order_by\": [\n \"backlinks,desc\"\n ],\n \"target\": \"forbes.com\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"limit\": 4,\n \"order_by\": [\n \"backlinks,desc\"\n ],\n \"target\": \"forbes.com\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"items": [
{
"backlinks": 123,
"backlinks_spam_score": 123,
"broken_backlinks": 123,
"broken_pages": 123,
"first_seen": "<string>",
"lost_date": "<string>",
"rank": 123,
"referring_domains": 123,
"referring_domains_nofollow": 123,
"referring_ips": 123,
"referring_links_attributes": {},
"referring_links_countries": {},
"referring_links_platform_types": {},
"referring_links_semantic_locations": {},
"referring_links_tld": {},
"referring_links_types": {},
"referring_main_domains": 123,
"referring_main_domains_nofollow": 123,
"referring_pages": 123,
"referring_pages_nofollow": 123,
"referring_subnets": 123,
"type": "<string>",
"url": "<string>"
}
],
"items_count": 123,
"target": "<string>",
"total_count": 123
}
]
}
]
}Backlinks
Domain Pages Summary
Domain Pages Summary
POST
https://api.aisa.one
/
apis
/
v1
/
dataforseo
/
backlinks
/
domain_pages_summary
/
live
Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"target": "forbes.com",
"limit": 4,
"order_by": [
"backlinks,desc"
]
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"limit": 4,
"order_by": [
"backlinks,desc"
],
"target": "forbes.com"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live"
payload = [
{
"limit": 4,
"order_by": ["backlinks,desc"],
"target": "forbes.com"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([{limit: 4, order_by: ['backlinks,desc'], target: 'forbes.com'}])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'limit' => 4,
'order_by' => [
'backlinks,desc'
],
'target' => 'forbes.com'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live"
payload := strings.NewReader("[\n {\n \"limit\": 4,\n \"order_by\": [\n \"backlinks,desc\"\n ],\n \"target\": \"forbes.com\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"limit\": 4,\n \"order_by\": [\n \"backlinks,desc\"\n ],\n \"target\": \"forbes.com\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"limit\": 4,\n \"order_by\": [\n \"backlinks,desc\"\n ],\n \"target\": \"forbes.com\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"items": [
{
"backlinks": 123,
"backlinks_spam_score": 123,
"broken_backlinks": 123,
"broken_pages": 123,
"first_seen": "<string>",
"lost_date": "<string>",
"rank": 123,
"referring_domains": 123,
"referring_domains_nofollow": 123,
"referring_ips": 123,
"referring_links_attributes": {},
"referring_links_countries": {},
"referring_links_platform_types": {},
"referring_links_semantic_locations": {},
"referring_links_tld": {},
"referring_links_types": {},
"referring_main_domains": 123,
"referring_main_domains_nofollow": 123,
"referring_pages": 123,
"referring_pages_nofollow": 123,
"referring_subnets": 123,
"type": "<string>",
"url": "<string>"
}
],
"items_count": 123,
"target": "<string>",
"total_count": 123
}
]
}
]
}Per-page backlink metrics for one
Set this endpoint up in your agent →
target: one row per url with rank, backlinks, first_seen, lost_date, backlinks_spam_score, broken_backlinks and broken_pages. Measured at 1.3 KB. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The page-level twin of post_dataforseo_backlinks_summary_live, which reports the same metrics for the domain as a whole. For crawl metadata about those pages instead, use post_dataforseo_backlinks_domain_pages_live. Keep limit low and do not loop.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"target": "...", "limit": "...", "offset": "..."}]'
// Copy this whole block into Claude Code, Codex, Cursor or any coding agent.
// It carries everything needed to connect, authorize and run this example —
// no key to paste, one click of Allow in the browser.
{
"calls": [
{
"call_id": "1",
"tool": "post_dataforseo_backlinks_domain_pages_summary_live",
"arguments": {}
}
]
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `batch_quote` tool with the JSON above.
// name aisa
// endpoint https://mcp.aisa.one/mcp
// transport streamable-http
// auth OAuth. The server publishes RFC 9728 metadata, so open a
// browser and the user clicks Allow once — nothing to paste.
// If AISA_API_KEY is set, send it as a bearer header instead.
// Use your own MCP mechanism, not a hand-edited config file:
// Codex codex mcp add aisa --url https://mcp.aisa.one/mcp
// Claude Code claude mcp add --transport http -s user aisa https://mcp.aisa.one/mcp
// Cursor / VS Code a "url" entry for https://mcp.aisa.one/mcp in the MCP config
// The server reaches https://mcp.aisa.one/servers worth of APIs through a few meta
// tools: search, list_categories, get_details, batch_quote, batch_use.
// search, get_details and batch_quote are free; batch_use is billed per
// call. This operation's full contract — every argument, the response
// shape, the price and the pitfalls — is at
// https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-backlinks-domain-pages-summary-live.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.
First time? Point any MCP client at
https://mcp.aisa.one/mcp — Claude
Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
opens a browser, you click Allow once, and there is no key to paste. Your
agent then reaches every endpoint through a few meta tools: search,
list_categories, get_details and batch_quote are free, batch_use is
billed per call. Setup per client is in
Connect via MCP; the live tool list and what each call
costs are on aisa.one/mcp.Request contract
- Method and path: POST /apis/v1/dataforseo/backlinks/domain_pages_summary/live
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/live - Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_backlinks_domain_pages_summary_live",
"method": "POST",
"path": "/apis/v1/dataforseo/backlinks/domain_pages_summary/live",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"limit": 4,
"order_by": [
"backlinks,desc"
],
"target": "forbes.com"
}
],
"items": {
"oneOf": [
{
"properties": {
"backlinks_filters": {
"description": "<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href=\"/v3/backlinks/backlinks/live/\">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>\"backlinks_filters\": [[\"dofollow\", \"=\", true]]</code>",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_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": "<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>target</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 whether the backlinks from subdomains of the <code>target</code> are excluded</em><br>optional field<br>if set to <code>false</code>, backlinks from the subdomains of the <code>target</code> domain will be ommited and you won't receive the same domain in the response;<br>default value: <code>true</code>",
"type": [
"boolean",
"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>[\"referring_links_types.anchors\",\">\",\"1\"]</code><p><code>[[\"broken_pages\",\">\",\"2\"],<br>\"and\",<br>[\"backlinks\",\">\",\"10\"]]</code><p><code>[[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],<br>\"and\",<br>[[\"anchor\",\"like\",\"%seo%\"],\"or\",[\"referring_domains\",\">\",\"10\"]]]</code><p>The full list of possible filters is available <a href=\"/v3/backlinks/filters/?bash\">here.</a>",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_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>target</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 the 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>target</code> domain 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>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>",
"type": [
"integer",
"null"
]
},
"limit": {
"description": "<em>the maximum number of returned anchors</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
"type": [
"integer",
"null"
]
},
"offset": {
"description": "<em>offset in the results array of returned anchors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> 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": "<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>[\"backlinks,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>[\"backlinks,desc\",\"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"
]
},
"target": {
"description": "<em>domain, subdomain or webpage to get summary data for</em><br><strong>required field</strong><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>)",
"type": "string"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"x-aisa-status": "enabled",
"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"
},
"components": {
"schemas": {
"ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_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."
}
},
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.0276
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
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]]
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.
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;
default value: live
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
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"]]]
The full list of possible filters is available here.
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.
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
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
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_locations
default value: 10
maximum value: 1000
the maximum number of returned anchors
optional field
default value: 100
maximum value: 1000
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
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"]
defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
optional field
you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale
possible values:one_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scale
default value: one_thousand
learn more about how this parameter works and how ranking metrics are calculated in this Help Center article
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
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://)
Example:
[
{
"limit": 4,
"order_by": ["backlinks,desc"],
"target": "forbes.com"
}
]
Response
object | null
Successful operation
total tasks cost, USD
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
total execution time, seconds
the current version of the API
array of tasks
Show child attributes
Show child attributes