Run in Enrichment Spreadsheet
Use this function as a column step in
deepline enrich.deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_ai_optimization_ai_keyword_data_keywords_search_volume_live:{"keywords":"{{keywords}}"}' --json
Map payload values to spreadsheet columns with
{{column_name}} placeholders.Input Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
payload.keywords | array | Yes | keywords required field UTF-8 encoding The maximum number of keywords you can specify: 1000; The maximum number of characters in a single keyword: 250; The keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article | |
payload.location_name | string | No | full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or 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/ai_optimization/ai_keyword_data/locations_and_languages example: United Kingdom | |
payload.location_code | integer | No | unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages example: 2840 | |
payload.language_name | string | No | full name of the language required field if you don’t specify language_code 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/ai_optimization/ai_keyword_data/locations_and_languages example: English | |
payload.language_code | string | No | language code required field if you don’t specify language_name 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/ai_optimization/ai_keyword_data/locations_and_languages example: en | |
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 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 |
Advanced: Direct CLI
Use direct execution for single payload debugging.
deepline tools execute dataforseo_ai_optimization_ai_keyword_data_keywords_search_volume_live --payload '{
"keywords": "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.01per pricing unit. - Billing mode:
post_deduct.