# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"target": "forbes.com",
"mode": "as_is",
"filters": [
"dofollow",
"=",
true
],
"limit": 5
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"filters": [
"dofollow",
"=",
true
],
"limit": 5,
"mode": "as_is",
"target": "forbes.com"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live"
payload = [
{
"filters": ["dofollow", "=", True],
"limit": 5,
"mode": "as_is",
"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([
{
filters: ['dofollow', '=', true],
limit: 5,
mode: 'as_is',
target: 'forbes.com'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/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/backlinks/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([
[
'filters' => [
'dofollow',
'=',
true
],
'limit' => 5,
'mode' => 'as_is',
'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/backlinks/live"
payload := strings.NewReader("[\n {\n \"filters\": [\n \"dofollow\",\n \"=\",\n true\n ],\n \"limit\": 5,\n \"mode\": \"as_is\",\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/backlinks/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"filters\": [\n \"dofollow\",\n \"=\",\n true\n ],\n \"limit\": 5,\n \"mode\": \"as_is\",\n \"target\": \"forbes.com\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/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 \"filters\": [\n \"dofollow\",\n \"=\",\n true\n ],\n \"limit\": 5,\n \"mode\": \"as_is\",\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": [
{
"custom_mode": {},
"items": [
{
"alt": "<string>",
"anchor": "<string>",
"attributes": [
"<string>"
],
"backlink_spam_score": 123,
"dofollow": true,
"domain_from": "<string>",
"domain_from_country": "<string>",
"domain_from_ip": "<string>",
"domain_from_is_ip": true,
"domain_from_platform_type": [
"<string>"
],
"domain_from_rank": 123,
"domain_to": "<string>",
"first_seen": "<string>",
"group_count": 123,
"image_url": "<string>",
"indirect_link_path": [
{
"status_code": 123,
"type": "<string>",
"url": "<string>"
}
],
"is_broken": true,
"is_indirect_link": true,
"is_lost": true,
"is_new": true,
"item_type": "<string>",
"last_seen": "<string>",
"links_count": 123,
"original": true,
"page_from_encoding": "<string>",
"page_from_external_links": 123,
"page_from_internal_links": 123,
"page_from_language": "<string>",
"page_from_rank": 123,
"page_from_size": 123,
"page_from_status_code": 123,
"page_from_title": "<string>",
"prev_seen": "<string>",
"rank": 123,
"ranked_keywords_info": {
"page_from_keywords_count_top_10": 123,
"page_from_keywords_count_top_100": 123,
"page_from_keywords_count_top_3": 123
},
"semantic_location": "<string>",
"text_post": "<string>",
"text_pre": "<string>",
"tld_from": "<string>",
"type": "<string>",
"url_from": "<string>",
"url_from_https": true,
"url_to": "<string>",
"url_to_https": true,
"url_to_redirect_target": "<string>",
"url_to_spam_score": 123,
"url_to_status_code": 123
}
],
"items_count": 123,
"mode": "<string>",
"search_after_token": "<string>",
"target": "<string>",
"total_count": 123
}
]
}
]
}Backlinks
The individual inbound links to one target, one row per link.
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"target": "forbes.com",
"mode": "as_is",
"filters": [
"dofollow",
"=",
true
],
"limit": 5
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"filters": [
"dofollow",
"=",
true
],
"limit": 5,
"mode": "as_is",
"target": "forbes.com"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live"
payload = [
{
"filters": ["dofollow", "=", True],
"limit": 5,
"mode": "as_is",
"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([
{
filters: ['dofollow', '=', true],
limit: 5,
mode: 'as_is',
target: 'forbes.com'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/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/backlinks/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([
[
'filters' => [
'dofollow',
'=',
true
],
'limit' => 5,
'mode' => 'as_is',
'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/backlinks/live"
payload := strings.NewReader("[\n {\n \"filters\": [\n \"dofollow\",\n \"=\",\n true\n ],\n \"limit\": 5,\n \"mode\": \"as_is\",\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/backlinks/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"filters\": [\n \"dofollow\",\n \"=\",\n true\n ],\n \"limit\": 5,\n \"mode\": \"as_is\",\n \"target\": \"forbes.com\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/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 \"filters\": [\n \"dofollow\",\n \"=\",\n true\n ],\n \"limit\": 5,\n \"mode\": \"as_is\",\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": [
{
"custom_mode": {},
"items": [
{
"alt": "<string>",
"anchor": "<string>",
"attributes": [
"<string>"
],
"backlink_spam_score": 123,
"dofollow": true,
"domain_from": "<string>",
"domain_from_country": "<string>",
"domain_from_ip": "<string>",
"domain_from_is_ip": true,
"domain_from_platform_type": [
"<string>"
],
"domain_from_rank": 123,
"domain_to": "<string>",
"first_seen": "<string>",
"group_count": 123,
"image_url": "<string>",
"indirect_link_path": [
{
"status_code": 123,
"type": "<string>",
"url": "<string>"
}
],
"is_broken": true,
"is_indirect_link": true,
"is_lost": true,
"is_new": true,
"item_type": "<string>",
"last_seen": "<string>",
"links_count": 123,
"original": true,
"page_from_encoding": "<string>",
"page_from_external_links": 123,
"page_from_internal_links": 123,
"page_from_language": "<string>",
"page_from_rank": 123,
"page_from_size": 123,
"page_from_status_code": 123,
"page_from_title": "<string>",
"prev_seen": "<string>",
"rank": 123,
"ranked_keywords_info": {
"page_from_keywords_count_top_10": 123,
"page_from_keywords_count_top_100": 123,
"page_from_keywords_count_top_3": 123
},
"semantic_location": "<string>",
"text_post": "<string>",
"text_pre": "<string>",
"tld_from": "<string>",
"type": "<string>",
"url_from": "<string>",
"url_from_https": true,
"url_to": "<string>",
"url_to_https": true,
"url_to_redirect_target": "<string>",
"url_to_spam_score": 123,
"url_to_status_code": 123
}
],
"items_count": 123,
"mode": "<string>",
"search_after_token": "<string>",
"target": "<string>",
"total_count": 123
}
]
}
]
}target, one row per link. Returns total_count, items_count, items and a search_after_token for paging - use that rather than offset past the first few pages. mode and custom_mode control grouping, backlinks_status_type selects live, lost or all. Measured at 2.5 KB for one link. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. For counts rather than rows use post_dataforseo_backlinks_summary_live; for the linking domains grouped, post_dataforseo_backlinks_referring_domains_live. Keep limit low and do not loop.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"target": "...", "mode": "...", "custom_mode": "..."}]'
// 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_backlinks_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-backlinks-live.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.
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/backlinks/live
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/dataforseo/backlinks/backlinks/live - Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_backlinks_backlinks_live",
"method": "POST",
"path": "/apis/v1/dataforseo/backlinks/backlinks/live",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"filters": [
"dofollow",
"=",
true
],
"limit": 5,
"mode": "as_is",
"target": "forbes.com"
}
],
"items": {
"oneOf": [
{
"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>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"
]
},
"custom_mode": {
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "<em>detailed results grouping type</em><br>optional field<br>use this object to get a specific number of backlinks per <code>field</code><br>if you use <code>custom_mode</code>, then <code>mode</code> will be ignored<br>example:<br><code>\"custom_mode\": {\"field\": \"domain\", \"value\": 100}</code>",
"type": [
"object",
"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 results<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>=</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>regex</code>, <code>not_regex</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>[\"rank\",\">\",\"80\"]</code><p><code>[[\"page_from_rank\",\">\",\"55\"],<br>\"and\",<br>[\"dofollow\",\"=\",true]]</code><p><code>[[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],<br>\"and\",<br>[[\"anchor\",\"like\",\"%seo%\"],\"or\",[\"text_pre\",\"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": "#/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_subdomains": {
"description": "<em>indicates if the subdomains of the <code>target</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"
]
},
"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"
]
},
"mode": {
"description": "<em>results grouping type</em><br>optional field<br>possible grouping types:<br><code>as_is</code> - returns all backlinks<br><code>one_per_domain</code> - returns one backlink per domain<br><code>one_per_anchor</code> - returns one backlink per anchor<p>default value: <code>as_is</code>",
"type": [
"string",
"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;<br><strong>Note:</strong> the maximum value is <code>20,000</code>, use the <code>search_after_token</code> if you would like to offset more results",
"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"
]
},
"search_after_token": {
"description": "<em>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 <code>20,000</code> results in a single request;<br>by specifying the unique <code>search_after_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>search_after_token</code> values are unique for each subsequent task ;<br><strong>Note:</strong> if the <code>search_after_token</code> is specified in the request, all other parameters should be identical to the previous request",
"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 backlinks 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.06,
"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.06 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.06
- 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
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
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}
Show child attributes
Show child attributes
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
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%"]]]
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 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
the maximum number of returned backlinks
optional field
default value: 100
maximum value: 1000
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 anchor
default value: as_is
offset in the results array of the returned backlinks
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;
Note: the maximum value is 20,000, use the search_after_token if you would like to offset more results
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"]
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
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
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
[ { "filters": ["dofollow", "=", true], "limit": 5, "mode": "as_is", "target": "forbes.com" } ]
Response
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