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

Setting Live ‘Bulk Clickstream Search Volume’ Tasks

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клиентские библиотеки
Shell Curl

DataForSEO

​

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

DataForSEO Операции

Setting Live ‘Bulk Clickstream Search Volume’ Tasks

​

Clickstream search volume for many keywords in one call, without the language dimension. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The per-keyword-with-language variant is post_dataforseo_keywords_clickstream_search_volume_live. Since the price is per call and not per keyword, this is the one to use for a list.

Тело
обязательно
application/json
  • Тип: array object[]
      • keywords
        Тип: array string[]
        обязательно

        target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; each keyword should be at least 3 characters long; 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_name
        Тип: 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/keywords_data/clickstream_data/locations_and_languages example: United Kingdom

      • location_code
        Тип: integer

        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/keywords_data/clickstream_data/locations_and_languages example: 2840

      • tag
        Тип: 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

Ответы
  • 200
    Тип: object

    Successful response

    • cost
      Тип: number

      total tasks cost, USD

    • status_code
      Тип: 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
      Тип: string

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

    • tasks
      Тип: array string[]

      array of tasks

    • tasks_count
      Тип: integer

      the number of tasks in the tasks array

    • tasks_error
      Тип: integer

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

    • tasks.cost
      Тип: number

      cost of the task, USD

    • tasks.data
      Тип: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Тип: string

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

    • tasks.path
      Тип: array string[]

      URL path

    • tasks.result
      Тип: array string[]

      array of results

    • tasks.result_count
      Тип: integer

      number of elements in the result array

    • tasks.result.items
      Тип: array string[]

      contains keywords and related data

    • tasks.result.items_count
      Тип: integer

      the number of results returned in the items array

    • tasks.result.items.keyword
      Тип: string

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

    • tasks.result.items.monthly_searches
      Тип: array string[]

      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

    • tasks.result.items.monthly_searches.month
      Тип: integer

      month

    • tasks.result.items.monthly_searches.search_volume
      Тип: integer

      monthly average search volume rate

    • tasks.result.items.monthly_searches.year
      Тип: integer

      year

    • tasks.result.items.search_volume
      Тип: integer

      clickstream-based average monthly search volume rate represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in this Help Center article

    • tasks.result.location_code
      Тип: integer

      location code in a POST array

    • tasks.status_code
      Тип: 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
      Тип: string

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

    • tasks.time
      Тип: string

      execution time, seconds

    • time
      Тип: string

      execution time, seconds

    • version
      Тип: 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/clickstream_data/bulk_search_volume/live
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/clickstream_data/bulk_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.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.keyword": "string",
  "tasks.result.items.search_volume": 1,
  "tasks.result.items.monthly_searches": [
    "string"
  ],
  "tasks.result.items.monthly_searches.year": 1,
  "tasks.result.items.monthly_searches.month": 1,
  "tasks.result.items.monthly_searches.search_volume": 1
}

Successful response

Setting Live ‘Bulk Clickstream Search Volume’ Tasks