Tool ID:
dataforseo_dataforseo_labs_google_keyword_ideas_liveRun this action
Use the TypeScript SDK for one call. Usectx.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_keyword_ideas_live',
{
"keywords": [
"software companies hiring engineers"
]
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute dataforseo_dataforseo_labs_google_keyword_ideas_live --input '{
"keywords": [
"software companies hiring engineers"
]
}' --json
Example response
The SDK returns this shape atresult.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": [
{}
]
}
deepline describe dataforseo_dataforseo_labs_google_keyword_ideas_live --json for the latest machine-readable contract.
Input reference
The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.keywords | array | Yes | — | keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. 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/dataforseo_labs/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/dataforseo_labs/locations_and_languages 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 example: English Note: if omitted, results default to the language with the most keyword records in the specified location. refer to the available_languages.keywords field of the Locations and Languages endpoint to See the live schema for the complete constraint. |
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 example: en Note: if omitted, results default to the language with the most keyword records in the specified location. refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the See the live schema for the complete constraint. |
payload.closely_variants | boolean | No | — | search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: false |
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.include_serp_info | boolean | No | — | include data from SERP for each keyword optional field if set to true , we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false |
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_keyword_info , keyword_info_normalized_with_clickstream , and keyword_info_normalized_with_bing fields 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 keywords in the results array optional field default value: 700 maximum value: 1000 |
payload.offset | integer | No | — | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead. |
payload.offset_token | string | No | — | offset token for subsequent requests optional field provided in the identical filed of the response to each request. Use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request. by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task. offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be See the live schema for the complete constraint. |
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 , match , not_match , ilike , not_ilike , like , not_like you can use the % operator with like and not_like ,as well as ilike , not_ilike to match any string of zero or more characters note that you can not filter the results 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 set up a sorting parameter default rule: [“relevance,desc”] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note 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_keyword_ideas_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.02per pricing unit.