Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Setting Live ‘Google Ads Search Volume’ Tasks

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operations

Setting Live ‘Google Ads Search Volume’ Tasks

​

Google Ads search volume for a list of keywords. Returns keyword, location_code, language_code, search_partners, competition, competition_index, search_volume, low_top_of_page_bid, high_top_of_page_bid, cpc and monthly_searches, plus spell when Google corrected the term. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This is the classical search-volume number; for how often people ask an assistant instead, use post_dataforseo_ai_keyword_volume_live. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.

Body
required
application/json
  • Type: array object[]
    • keywords
      Type: array string[]
      required

      keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the keywords you specify will be converted to a lowercase format Note #1: Google Ads may return no data for certain groups of keywords; Note #2: Google Ads provides combined search volume values for groups of similar keywords to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests; Note #3: Google Ads doesn’t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can’t use them when setting a task; 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

    • date_from
      Type: string

      starting date of the time range optional field date format: "yyyy-mm-dd" minimal value: 4 years from the current date by default, data is returned for the past 12 months; Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior; if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior

    • date_to
      Type: string

      ending date of the time range optional field Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month; if you don’t specify this field, yesterday’s date will be used by default date format: "yyyy-mm-dd" example: "2022-11-30"

    • include_adult_keywords
      Type: boolean

      include keywords associated with adult content optional field if set to true, adult keywords will be included in the response default value: false note that the API may return no data for such keywords due to Google Ads restrictions

    • language_code
      Type: string

      search engine language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages example: en

    • language_name
      Type: string

      full name of search engine language optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages example: English

    • location_code
      Type: integer

      search engine location code optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or location_coordinate; 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/google_ads/locations example: 2840

    • location_coordinate
      Type: string

      GPS coordinates of a location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or location_code; location_coordinate parameter should be specified in the “latitude,longitude” format; the data will be provided for the country the specified coordinates belong to; example: 52.6178549,-155.352142

    • location_name
      Type: string

      full name of search engine location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_code or location_coordinate 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/google_ads/locations example: London,England,United Kingdom

    • search_partners
      Type: boolean

      include Google search partners optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search; default value: false – results are returned for Google search sites

    • sort_by
      Type: string

      results sorting parameters optional field use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order default value: relevance

    • tag
      Type: string

      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 array of the response

Responses
  • 200
    Type: object

    Successful response

    • cost
      Type: number

      total tasks cost, USD

    • status_code
      Type: integer

      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_message
      Type: string

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

    • tasks
      Type: array string[]

      array of tasks

    • tasks_count
      Type: integer

      the number of tasks in the tasks array

    • tasks_error
      Type: integer

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

    • tasks.cost
      Type: number

      cost of the task, USD

    • tasks.data
      Type: array string[]

      contains the same parameters that you specified in the POST request

    • tasks.id
      Type: string

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

    • tasks.path
      Type: array string[]

      URL path

    • tasks.result
      Type: array string[]

      array of results

    • tasks.result_count
      Type: integer

      number of elements in the result array

    • tasks.result.competition
      Type: string

      competition represents the relative amount of competition associated with the given keyword in paid SERP only; this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW; if there is no data the value is null; learn more about the metric in this help center article

    • tasks.result.competition_index
      Type: integer

      competition represents the relative amount of competition associated with the given keyword in paid SERP only; this value is based on Google Ads data and can be between 0 and 100 (inclusive); if there is no data the value is null; learn more about the metric in this help center article

    • tasks.result.cpc
      Type: number

      cost per click indicates the amount paid (USD) for each click on the ad displayed for a given keyword

    • tasks.result.high_top_of_page_bid
      Type: number

      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

    • tasks.result.keyword
      Type: string

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

    • tasks.result.language_code
      Type: string

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

    • tasks.result.location_code
      Type: integer

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

    • tasks.result.low_top_of_page_bid
      Type: number

      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

    • tasks.result.monthly_searches
      Type: array string[]

      monthly searches represents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations; if there is no data then the value is null

    • tasks.result.monthly_searches.month
      Type: integer

      month

    • tasks.result.monthly_searches.search_volume
      Type: integer

      monthly average search volume rate

    • tasks.result.monthly_searches.year
      Type: integer

      year

    • tasks.result.search_partners
      Type: boolean

      indicates whether data from partner networks included in the response

    • tasks.result.search_volume
      Type: integer

      monthly average search volume rate; represents either the (approximate) number of searches for the given keyword idea on google.com or google.com and partners, depending on the user’s targeting; if there is no data then the value is null

    • tasks.result.spell
      Type: string

      correct spelling of the keyword Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword; we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link

    • tasks.status_code
      Type: integer

      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

    • tasks.status_message
      Type: string

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

    • tasks.time
      Type: string

      execution time, seconds

    • time
      Type: string

      execution time, seconds

    • version
      Type: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/keywords_data/google_ads/search_volume/live
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/search_volume/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "keywords": [
      "accounting software"
    ],
    "location_code": 2840,
    "language_code": "en"
  }
]'

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": [
    "string"
  ],
  "tasks.result": [
    "string"
  ],
  "tasks.result.keyword": "string",
  "tasks.result.spell": "string",
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.search_partners": true,
  "tasks.result.competition": "string",
  "tasks.result.competition_index": 1,
  "tasks.result.search_volume": 1,
  "tasks.result.low_top_of_page_bid": 1,
  "tasks.result.high_top_of_page_bid": 1,
  "tasks.result.cpc": 1,
  "tasks.result.monthly_searches": [
    "string"
  ],
  "tasks.result.monthly_searches.year": 1,
  "tasks.result.monthly_searches.month": 1,
  "tasks.result.monthly_searches.search_volume": 1
}

Successful response

Setting Live ‘Google Ads Search Volume’ Tasks