v0.1.0-beta

OpenAPI 3.1.0

Setting Live ‘DataForSEO 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 操作

post/v1/beta/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live

Setting Live ‘DataForSEO Search Volume’ Tasks

Search volume derived from clickstream panels rather than the ad platforms, for a list of keywords. use_clickstream toggles the blend. Returns location_code, language_code, use_clickstream, 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. Clickstream volume often disagrees with post_dataforseo_keywords_gads_search_volume_live, which is the point: one measures what advertisers are shown, the other what people did.

请求体

必填

application/json

类型: array object[]
- 类型: object
  keywords
  类型: array string[]
  必填
  
  target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 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
  
  language_code
  类型: string
  
  search engine language code required field if don’t 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/keywords_data/clickstream_data/locations_and_languages example: en
  
  language_name
  类型: string
  
  full name of search engine language required field if don’t 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/keywords_data/clickstream_data/locations_and_languages example: English
  
  location_code
  类型: integer
  
  search engine location code required field if you don’t specify location_name if you use this field, you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages example: 2826
  
  location_name
  类型: string
  
  full name of search engine location required field if you don’t specify location_code you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages example: United Kingdom
  
  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
  
  use_clickstream
  类型: boolean
  
  use clickstream data to provide results optional field if set to true, you will get DataForSEO search volume values based on clickstream data; if set to false, Bing search volume data will be used to calculate DataForSEO search volume; default value: true; Note: Bing search volume is available for locations provided in Bing Search Volume History Locations and Bing Ads Locations endpoints; search volume values for any other location are calculated based on clickstream data even if you set this parameter to false
  
  空对象
  空对象

响应

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
类型: array string[]

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[]

array of keywords contains keywords and their search volume rates

tasks.result.items_count
类型: string

ithe number of results returned in the items array

tasks.result.items.keyword
类型: string

keyword provided in the POST array

tasks.result.items.monthly_searches
类型: array string[]

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

tasks.result.items.monthly_searches.month
类型: integer

month

tasks.result.items.monthly_searches.search_volume
类型: integer

search volume rate in a certain month of a year

tasks.result.items.monthly_searches.year
类型: integer

year

tasks.result.items.search_volume
类型: integer

current search volume rate of a keyword

tasks.result.items.use_clickstream
类型: boolean

indicates if the use_clickstream parameter is active possible values: true, false

tasks.result.language_code
类型: string

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

tasks.result.location_code
类型: integer

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

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.

post/v1/beta/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live

curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {}
]'

显示 Schema

{
  "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.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.items_count": "string",
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.keyword": "string",
  "tasks.result.items.use_clickstream": true,
  "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 ‘DataForSEO Search Volume’ Tasks

身份验证Required

DataForSEO

Setting Live ‘DataForSEO Search Volume’ Tasks