> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Dataforseo Dataforseo Labs Google Relevant Pages: Inputs,
> This endpoint will provide you with rankings and traffic data for the web pages of the specified domain. Includes inputs, outputs, and CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_dataforseo_labs_google_relevant_pages_live:{"target":"{{target}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ---------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.target` | `string` | Yes | | domain required field the domain name of the target website the domain should be specified without https\:// and [www](http://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](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](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](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](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", \[\["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 |
| `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: \["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 |
| `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 |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "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.",
"properties": {
"target": {
"type": "string",
"description": "domain required field the domain name of the target website the domain should be specified without https:// and www."
},
"location_name": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "array",
"description": "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\"]",
"items": {}
},
"include_clickstream_data": {
"type": "boolean",
"description": "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"
},
"limit": {
"type": "integer",
"description": "the maximum number of returned pages optional field default value: 100 maximum value: 1000"
},
"offset": {
"type": "integer",
"description": "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"
},
"historical_serp_mode": {
"type": "string",
"description": "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"
},
"ignore_synonyms": {
"type": "boolean",
"description": "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"
},
"filters": {
"type": "array",
"description": "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\", [[\"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",
"items": {}
},
"order_by": {
"type": "array",
"description": "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",
"items": {}
},
"tag": {
"type": "string",
"description": "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"
}
},
"required": [
"target"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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 |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Top-level response envelope for dataforseo_dataforseo_labs_google_relevant_pages_live.",
"properties": {
"version": {
"type": "string",
"description": "the current version of the API"
},
"status_code": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "general informational message you can find the full list of general informational messages here"
},
"time": {
"type": "string",
"description": "execution time, seconds"
},
"tasks_count": {
"type": "integer",
"description": "the number of tasks in the tasks array"
},
"tasks_error": {
"type": "integer",
"description": "the number of tasks in the tasks array returned with an error"
},
"tasks": {
"type": "array",
"description": "array of tasks",
"items": {}
}
},
"required": [
"version",
"status_code",
"status_message",
"time",
"tasks_count",
"tasks_error",
"tasks"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute dataforseo_dataforseo_labs_google_relevant_pages_live --payload '{
"target": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.02` per pricing unit.
* Billing mode: `post_deduct`.