DataForSEO: Keywords Data Dataforseo Trends Subregion Interests Live

This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends.

Tool ID: dataforseo_keywords_data_dataforseo_trends_subregion_interests_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_keywords_data_dataforseo_trends_subregion_interests_live',
  {
    "keywords": [
      "software companies hiring engineers"
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute dataforseo_keywords_data_dataforseo_trends_subregion_interests_live --input '{
  "keywords": [
    "software companies hiring engineers"
  ]
}' --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_keywords_data_dataforseo_trends_subregion_interests_live --json for the latest machine-readable contract.

Input reference

This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping.

Name	Type	Required	Default	Details
`payload.keywords`	`array`	Yes	—	keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis). specifying non-Latin characters, you’ll get data for the countries where they are used 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 search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations note that the data will be provided for the country the specified location_name belongs to. example: United Kingdom
`payload.location_code`	`integer`	No	—	search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations note that the data will be provided for the country the specified location_code belongs to. example: 2840
`payload.type`	`string`	No	—	dataforseo trends type optional field if you don’t specify this field, the web type will be used by default possible values: web , news , ecommerce
`payload.date_from`	`string`	No	—	starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other types: 2008-01-01 date format: “yyyy-mm-dd” example: “2019-01-15”
`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: “2019-01-15”
`payload.time_range`	`string`	No	—	preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours , past_day , past_7_days , past_30_days , past_90_days , past_12_months , past_5_years
`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_keywords_data_dataforseo_trends_subregion_interests_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.01 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