Felo API PlatformFelo API Platform

データ API / DataForSEO / AI Optimization

AI Keyword Data Keyword Search Volume

Returns location_code, language_code, 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. For classical search volume use post_dataforseo_keywords_gads_search_volume_live; the two answer different questions and often disagree.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

  • keywordsstring[]必須

    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

  • location_namestring任意

    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

  • location_codeinteger任意

    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

  • language_namestring任意

    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

  • language_codestring任意

    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

  • 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/ai_optimization/ai_keyword_data/keywords_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>",
  "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

  • dataobject任意

    contains the same parameters that you specified in the POST request

  • resultstring[]任意

    array of results

  • location_codeinteger任意

    location code in a POST array

  • language_codestring任意

    language code in a POST array

  • items_countinteger任意

    number of results returned in the items array

  • itemsstring[]任意

    contains specified keywords with their AI search volume rates

  • keywordstring任意

    specified keyword

  • ai_search_volumeinteger任意

    current AI search volume rate of a keyword learn more about this metric here

  • ai_monthly_searchesstring[]任意

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

  • yearinteger任意

    year

  • monthinteger任意

    month

  • ai_search_volumeinteger任意

    AI search volume rate in a certain month of a year learn more about this metric here