DataForSEO: Dataforseo Labs Google Relevant Pages Live

Google ranking and estimated monthly traffic for each page of a domain, across organic and paid search.

Tool ID: dataforseo_dataforseo_labs_google_relevant_pages_live

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_dataforseo_labs_google_relevant_pages_live',
  {
    "target": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute dataforseo_dataforseo_labs_google_relevant_pages_live --input '{
  "target": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}

Use deepline describe dataforseo_dataforseo_labs_google_relevant_pages_live --json for the latest machine-readable contract.

Input reference

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.

Name	Type	Required	Default	Details
`payload.target`	`string`	Yes	—	domain required field the domain name of the target website the domain should be specified without https:// and www.
`payload.location_name`	`string`	No	—	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
`payload.location_code`	`integer`	No	—	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
`payload.language_name`	`string`	No	—	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
`payload.language_code`	`string`	No	—	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
`payload.item_types`	`array`	No	—	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. possible values: [“organic”, “paid”, “featured_snippet”, “local_pack”] default value: [“organic”, “paid”]
`payload.include_clickstream_data`	`boolean`	No	—	include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true , you will receive clickstream_etv , clickstream_gender_distribution , and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article
`payload.limit`	`integer`	No	—	the maximum number of returned pages optional field default value: 100 maximum value: 1000
`payload.offset`	`integer`	No	—	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
`payload.historical_serp_mode`	`string`	No	—	data collection mode optional field you can use this field to filter the results. possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results. lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check. all — return metrics for both types of SERPs. default value: live
`payload.ignore_synonyms`	`boolean`	No	—	ignore highly similar keywords optional field if set to true , only core keywords will be returned, all highly similar keywords will be excluded. default value: false
`payload.filters`	`array`	No	—	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 example: [“metrics.paid.count”,”>“,0] [[“metrics.organic.count”,”>“,50],“and”,[“metrics.organic.pos_1”,”<>“,0]] [[""metrics.organic.count”,”>“,50”], “and”, See the live schema for the complete constraint.
`payload.order_by`	`array`	No	—	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: See the live schema for the complete constraint.
`payload.tag`	`string`	No	—	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

Output reference

Top-level response envelope for dataforseo_dataforseo_labs_google_relevant_pages_live.

Name	Type	Required	Default	Details
`result.version`	`string`	Yes	—	the current version of the API
`result.status_code`	`integer`	Yes	—	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
`result.status_message`	`string`	Yes	—	general informational message you can find the full list of general informational messages here
`result.time`	`string`	Yes	—	execution time, seconds
`result.tasks_count`	`integer`	Yes	—	the number of tasks in the tasks array
`result.tasks_error`	`integer`	Yes	—	the number of tasks in the tasks array returned with an error
`result.tasks`	`array`	Yes	—	array of tasks

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.02 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation