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

AI Keyword Data Keyword Search Volume

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

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.

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

        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

      • language_code
        Type: string

        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

      • language_name
        Type: string

        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

      • location_code
        Type: integer

        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

      • location_name
        Type: string

        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

      • 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 object of the response

      Empty object
      Empty object
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: object

      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.items
      Type: array string[]

      contains specified keywords with their AI search volume rates

    • tasks.result.items_count
      Type: integer

      number of results returned in the items array

    • tasks.result.items.ai_monthly_searches
      Type: array string[]

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

    • tasks.result.items.ai_monthly_searches.ai_search_volume
      Type: integer

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

    • tasks.result.items.ai_monthly_searches.month
      Type: integer

      month

    • tasks.result.items.ai_monthly_searches.year
      Type: integer

      year

    • tasks.result.items.ai_search_volume
      Type: integer

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

    • tasks.result.items.keyword
      Type: string

      specified keyword

    • tasks.result.language_code
      Type: string

      language code in a POST array

    • tasks.result.location_code
      Type: integer

      location code in a POST array

    • 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/ai_optimization/ai_keyword_data/keywords_search_volume/live
curl https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/ai_keyword_data/keywords_search_volume/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {}
]'

{
  "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": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.keyword": "string",
  "tasks.result.items.ai_search_volume": 1,
  "tasks.result.items.ai_monthly_searches": [
    "string"
  ],
  "tasks.result.items.ai_monthly_searches.year": 1,
  "tasks.result.items.ai_monthly_searches.month": 1,
  "tasks.result.items.ai_monthly_searches.ai_search_volume": 1
}

Successful response

AI Keyword Data Keyword Search Volume