Felo API PlatformFelo API Platform

データ API / DataForSEO / DataForSEO Labs

Historical Keyword Data

How a keyword's own metrics - volume, competition, cpc - moved over time. This one takes no limit parameter, but it is priced per call rather than per item, so send the whole list at once. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This tracks the keyword; post_dataforseo_labs_google_historical_rank_live tracks a domain. For the current values use post_dataforseo_labs_google_keyword_overview_live.

パラメータ

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

リクエストボディ

  • keywordsstring[]必須

    keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results 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/dataforseo_labs/locations_and_languages example: United Kingdom

  • location_codeinteger任意

    location code 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

  • language_namestring任意

    full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English

  • language_codestring任意

    language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/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/dataforseo_labs/google/historical_keyword_data/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

  • se_typestring任意

    search engine type

  • location_codeinteger任意

    location code in a POST array

  • language_codestring任意

    language code in a POST array

  • items_countinteger任意

    the number of results returned in the items array

  • itemsstring[]任意

    contains keywords and related data

  • se_typestring任意

    search engine type

  • keywordstring任意

    keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)

  • 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

  • historystring[]任意

    array of objects with historical data for the keyword

  • yearinteger任意

    year

  • monthinteger任意

    month

  • keyword_infoobject任意

    historical data for the keyword

  • se_typestring任意

    search engine type

  • last_updated_timestring任意

    date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

  • competitionnumber任意

    competition represents the relative amount of competition associated with the given keyword; the value is based on Google Ads data and can be between 0 and 1 (inclusive)

  • competition_levelstring任意

    competition level represents the relative level of competition associated with the given keyword in paid SERP only; possible values: LOW, MEDIUM, HIGH if competition level is unknown, the value is null; learn more about the metric in this help center article

  • cpcnumber任意

    cost-per-click represents the average cost per click (USD) historically paid for the keyword

  • search_volumeinteger任意

    average monthly search volume rate represents the (approximate) number of searches for the given keyword idea on google.com

  • low_top_of_page_bidnumber任意

    minimum bid for the ad to be displayed at the top of the first page indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request

  • high_top_of_page_bidnumber任意

    maximum bid for the ad to be displayed at the top of the first page indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request

  • categoriesstring[]任意

    product and service categories you can download the full list of possible categories

  • monthly_searchesstring[]任意

    monthly searches represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

  • yearinteger任意

    year

  • monthinteger任意

    month

  • search_volumeinteger任意

    monthly average search volume rate

  • search_volume_trendobject任意

    search volume trend changes represents search volume change in percent compared to the previous period

  • monthlyinteger任意

    search volume change in percent compared to the previous month

  • quarterlyinteger任意

    search volume change in percent compared to the previous quarter

  • yearlyinteger任意

    search volume change in percent compared to the previous year