Felo API PlatformFelo API Platform

Data API / DataForSEO / Keywords Data

Setting Live ‘DataForSEO Search Volume’ Tasks

Search volume derived from clickstream panels rather than the ad platforms, for a list of keywords. use_clickstream toggles the blend. Returns location_code, language_code, use_clickstream, items_count and items. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Clickstream volume often disagrees with post_dataforseo_keywords_gads_search_volume_live, which is the point: one measures what advertisers are shown, the other what people did.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

  • keywordsstring[]Обязательный

    target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed to learn more about which symbols and characters can be used, please refer to this article learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

  • location_namestringНеобязательный

    full name of search engine location required field if you don’t specify location_code you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages example: United Kingdom

  • location_codeintegerНеобязательный

    search engine location code required field if you don’t specify location_name if you use this field, you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages example: 2826

  • language_namestringНеобязательный

    full name of search engine language required field if don’t 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/keywords_data/clickstream_data/locations_and_languages example: English

  • language_codestringНеобязательный

    search engine language code required field if don’t 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/keywords_data/clickstream_data/locations_and_languages example: en

  • use_clickstreambooleanНеобязательный

    use clickstream data to provide results optional field if set to true, you will get DataForSEO search volume values based on clickstream data; if set to false, Bing search volume data will be used to calculate DataForSEO search volume; default value: true; Note: Bing search volume is available for locations provided in Bing Search Volume History Locations and Bing Ads Locations endpoints; search volume values for any other location are calculated based on clickstream data even if you set this parameter to false

  • tagstringНеобязательный

    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

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keywords": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "use_clickstream": false,
  "tag": "<string>"
}'

Ответ

Поля ответа

  • versionstringНеобязательный

    the current version of the API

  • status_codeintegerНеобязательный

    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_messagestringНеобязательный

    general informational message you can find the full list of general informational messages here

  • timestringНеобязательный

    execution time, seconds

  • costnumberНеобязательный

    total tasks cost, USD

  • tasks_countintegerНеобязательный

    the number of tasks in the tasks array

  • tasks_errorintegerНеобязательный

    the number of tasks in the tasks array returned with an error

  • tasksstring[]Необязательный

    array of tasks

  • idstringНеобязательный

    task identifier unique task identifier in our system in the UUID format

  • status_codeintegerНеобязательный

    status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here

  • status_messagestringНеобязательный

    informational message of the task you can find the full list of general informational messages here

  • timestringНеобязательный

    execution time, seconds

  • costnumberНеобязательный

    cost of the task, USD

  • result_countintegerНеобязательный

    number of elements in the result array

  • pathstring[]Необязательный

    URL path

  • datastring[]Необязательный

    contains the same parameters that you specified in the POST request

  • resultstring[]Необязательный

    array of results

  • location_codeintegerНеобязательный

    location code in a POST array if there is no data, then the value is null

  • language_codestringНеобязательный

    language code in a POST array if there is no data, then the value is null

  • items_countstringНеобязательный

    ithe number of results returned in the items array

  • itemsstring[]Необязательный

    array of keywords contains keywords and their search volume rates

  • keywordstringНеобязательный

    keyword provided in the POST array

  • use_clickstreambooleanНеобязательный

    indicates if the use_clickstream parameter is active possible values: true, false

  • search_volumeintegerНеобязательный

    current search volume rate of a keyword

  • monthly_searchesstring[]Необязательный

    monthly search volume rates array of objects with search volume rates in a certain month of a year

  • yearintegerНеобязательный

    year

  • monthintegerНеобязательный

    month

  • search_volumeintegerНеобязательный

    search volume rate in a certain month of a year