> ## 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 Historical Bulk Traffic
> This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020.
## 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_historical_bulk_traffic_estimation_live:{"targets":"{{targets}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.targets` | `array` | Yes | | target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https\:// and [www](http://www). ; you can set up to 1000 domains or subdomains |
| `payload.location_name` | `string` | No | | full name of the location if you use this field, you don't have 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 if you use this field, you don't have 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 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 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.date_from` | `string` | No | | starting date of the time range optional field if you don't specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: "yyyy-mm-dd" |
| `payload.date_to` | `string` | No | | ending date of the time range optional field if you don't specify this field, the today's date will be used by default; date format: "yyyy-mm-dd" example: "2021-04-01" |
| `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.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; possible values: \["organic", "paid", "featured\_snippet", "local\_pack"] default value: \["organic", "paid"] |
| `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 historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.",
"properties": {
"targets": {
"type": "array",
"description": "target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www. ; you can set up to 1000 domains or subdomains",
"items": {}
},
"location_name": {
"type": "string",
"description": "full name of the location if you use this field, you don't have 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 if you use this field, you don't have 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 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 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"
},
"date_from": {
"type": "string",
"description": "starting date of the time range optional field if you don't specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\""
},
"date_to": {
"type": "string",
"description": "ending date of the time range optional field if you don't specify this field, the today's date will be used by default; date format: \"yyyy-mm-dd\" example: \"2021-04-01\""
},
"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"
},
"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; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]",
"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": [
"targets"
],
"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_historical_bulk_traffic_estimation_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_historical_bulk_traffic_estimation_live --payload '{
"targets": "array"
}' --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`.