Note that the structure of DataForSEO Labs API requests and responses was updated on 2022-03-19. However, we will continue supporting the legacy version documented here. You can review the documentation of the new version by this link.
This endpoint will provide you with rankings and traffic data for the web pages of the specified domain. You will be able to review each page’s ranking distribution and estimated monthly traffic volume from both organic and paid searches.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access \
login="login" \
password="password" \
cred="$(printf ${login}:${password} | base64)" \
curl --location --request POST "https://api.dataforseo.com/v3/dataforseo_labs/relevant_pages/live" \
--header "Authorization: Basic ${cred}" \
--header "Content-Type: application/json" \
--data-raw "[
{
"target": "dataforseo.com",
"language_name": "English",
"location_code": 2840,
"filters": [
["metrics.organic.pos_1", "<>", 0],
"or",
["metrics.organic.pos_2_3", "<>", 0]
],
"limit": 5
}
]"
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to set a task
$post_array[] = array(
"target" => "dataforseo.com",
"language_name" => "English",
"location_code" => 2840,
"filters" => [
["metrics.organic.pos_1", "<>", 0],
"or",
["metrics.organic.pos_2_3", "<>", 0]
]
);
try {
// POST /v3/dataforseo_labs/relevant_pages/live
$result = $client->post('/v3/dataforseo_labs/relevant_pages/live', $post_array);
print_r($result);
// do something with post result
} catch (RestClientException $e) {
echo "\n";
print "HTTP code: {$e->getHttpCode()}\n";
print "Error code: {$e->getCode()}\n";
print "Message: {$e->getMessage()}\n";
print $e->getTraceAsString();
echo "\n";
}
$client = null;
?>
from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
target="dataforseo.com",
location_name="United States",
language_name="English",
filters=[
["metrics.organic.pos_1", "<>", 0],
"or",
["metrics.organic.pos_2_3", "<>", 0]
]
)
# POST /v3/dataforseo_labs/relevant_pages/live
response = client.post("/v3/dataforseo_labs/relevant_pages/live", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task dataforseo_labs_relevant_pages_live()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
var postData = new List<object>();
postData.Add(new
{
target = "dataforseo.com",
location_name = "United States",
language_name = "English",
filters = new object[]
{
new object[] { "metrics.organic.pos_1", "<>", 0 },
"or",
new object[] { "metrics.organic.pos_2_3", "<>", 0 }
}
});
// POST /v3/dataforseo_labs/relevant_pages/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/relevant_pages/live", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.
You can specify the number of results you want to retrieve, filter and sort them.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
Field name
Type
Description
target
string
domain required field
the domain name of the target website
the domain should be specified without https:// and www.
location_name
string
full name of the location
optional field
if you use this field, you don’t need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example: United Kingdom
location_code
integer
location code
optional field
if you use this field, you don’t need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example: 2840
language_name
string
full name of the language
optional field
if you use this field, you don’t need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example: English
language_code
string
language code
optional field
if you use this field, you don’t need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example: en
item_types
array
display results by item type
optional field
indicates the type of search results included in the response
Note: if the item_types array contains item types that are different from organic, 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;
the maximum number of returned pages
optional field
default value: 100
maximum value: 1000
offset
integer
offset in the results array of returned pages
optional field
default value: 0
if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
filters
array
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
[[""metrics.organic.count",">",50"],
"and",
[["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]]
for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_by
array
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 order desc – results will be sorted in the descending order
you should use a comma to specify a sorting type
example: ["metrics.paid.etv,asc"] Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example: ["metrics.organic.etv,desc","metrics.paid.count,asc"]
default rule: ["metrics.organic.count,desc"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
tag
string
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
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
Field name
Type
Description
version
string
the current version of the API
status_code
integer
general status code
you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message
string
general informational message
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
total tasks cost, USD
tasks_count
integer
the number of tasks in the tasks array
tasks_error
integer
the number of tasks in the tasks array returned with an error
tasks
array
array of tasks
id
string
task identifier unique task identifier in our system in the UUID format
status_code
integer
status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
status_message
string
informational message of the task
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
cost of the task, USD
result_count
integer
number of elements in the result array
path
array
URL path
data
object
contains the same parameters that you specified in the POST request
result
array
array of results
target
string
target domain in a POST array
location_code
integer
location code in a POST array
if there is no data, then the value is null
language_code
string
language code in a POST array
if there is no data, then the value is null
total_count
integer
total amount of results in our database relevant to your request
items_count
integer
the number of results returned in the items array
items
array
relevant pages and related data
page_address
string
absolute URL of the relevant page
metrics
object
rankings and traffic metrics for the relevant page
organic
object
ranking and traffic data from organic search
pos_1
integer
number of organic SERPs where the page ranks #1
pos_2_3
integer
number of organic SERPs where the page ranks #2-3
pos_4_10
integer
number of organic SERPs where the page ranks #4-10
pos_11_20
integer
number of organic SERPs where the page ranks #11-20
pos_21_30
integer
number of organic SERPs where the page ranks #21-30
pos_31_40
integer
number of organic SERPs where the page ranks #31-40
pos_41_50
integer
number of organic SERPs where the page ranks #41-50
pos_51_60
integer
number of organic SERPs where the page ranks #51-60
pos_61_70
integer
number of organic SERPs where the page ranks #61-70
pos_71_80
integer
number of organic SERPs where the page ranks #71-80
pos_81_90
integer
number of organic SERPs where the page ranks #81-90
pos_91_100
integer
number of organic SERPs where the page ranks #91-100
etv
float
estimated traffic volume
estimated organic monthly traffic to the page
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated organic monthly traffic to the page
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of organic SERPs that contain the page
estimated_paid_traffic_cost
float
estimated cost of converting organic search traffic into paid
represents the estimated monthly cost (USD) of running ads for all keywords in the category that a page ranks for
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the page
is_up
integer
rank went up
indicates how many ranked elements of the page went up
is_down
integer
rank went down
indicates how many ranked elements of the page went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the page were previously presented in SERPs, but weren’t found during the last check
paid
object
ranking and traffic data from paid search
pos_1
integer
number of paid SERPs where the page ranks #1
pos_2_3
integer
number of paid SERPs where the page ranks #2-3
pos_4_10
integer
number of paid SERPs where the page ranks #4-10
pos_11_20
integer
number of paid SERPs where the page ranks #11-20
pos_21_30
integer
number of paid SERPs where the page ranks #21-30
pos_31_40
integer
number of paid SERPs where the page ranks #31-40
pos_41_50
integer
number of paid SERPs where the page ranks #41-50
pos_51_60
integer
number of paid SERPs where the page ranks #51-60
pos_61_70
integer
number of paid SERPs where the page ranks #61-70
pos_71_80
integer
number of paid SERPs where the page ranks #71-80
pos_81_90
integer
number of paid SERPs where the page ranks #81-90
pos_91_100
integer
number of paid SERPs where the page ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the page
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the page
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of paid SERPs that contain the page
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the page
is_up
integer
rank went up
indicates how many ranked elements of the page went up
is_down
integer
rank went down
indicates how many ranked elements of the page went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the page were previously presented in SERPs, but weren’t found during the last check
featured_snippet
object
ranking and traffic data from the featured snippet results in Google SERP
pos_1
integer
number of featured snippet items where the page ranks #1
pos_2_3
integer
number of featured snippet items where the page ranks #2-3
pos_4_10
integer
number of featured snippet items where the page ranks #4-10
pos_11_20
integer
number of featured snippet items where the page ranks #11-20
pos_21_30
integer
number of featured snippet items where the page ranks #21-30
pos_31_40
integer
number of featured snippet items where the page ranks #31-40
pos_41_50
integer
number of featured snippet items where the page ranks #41-50
pos_51_60
integer
number of featured snippet items where the page ranks #51-60
pos_61_70
integer
number of featured snippet items where the page ranks #61-70
pos_71_80
integer
number of featured snippet items where the page ranks #71-80
pos_81_90
integer
number of featured snippet items where the page ranks #81-90
pos_91_100
integer
number of featured snippet items where the page ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the page
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the page
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of featured snippet items that contain the page
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the page
is_up
integer
rank went up
indicates how many ranked elements of the page went up
is_down
integer
rank went down
indicates how many ranked elements of the page went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the page were previously presented in SERPs, but weren’t found during the last check
local_pack
object
ranking and traffic data from the local pack results in SERP
pos_1
integer
number of local pack items where the page ranks #1
pos_2_3
integer
number of local pack items where the page ranks #2-3
pos_4_10
integer
number of local pack items where the page ranks #4-10
pos_11_20
integer
number of local pack items where the page ranks #11-20
pos_21_30
integer
number of local pack items where the page ranks #21-30
pos_31_40
integer
number of local pack items where the page ranks #31-40
pos_41_50
integer
number of local pack items where the page ranks #41-50
pos_51_60
integer
number of local pack items where the page ranks #51-60
pos_61_70
integer
number of local pack items where the page ranks #61-70
pos_71_80
integer
number of local pack items where the page ranks #71-80
pos_81_90
integer
number of local pack items where the page ranks #81-90
pos_91_100
integer
number of local pack items where the page ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the page
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the page
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of local pack items that contain the page
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the page ranks for
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the page
is_up
integer
rank went up
indicates how many ranked elements of the page went up
is_down
integer
rank went down
indicates how many ranked elements of the page went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the page were previously presented in SERPs, but weren’t found during the last check
