v0.1.0-beta

OpenAPI 3.1.0

Setting Live ‘Bing Keyword Performance’ 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/bing/keyword_performance/live

Setting Live ‘Bing Keyword Performance’ Tasks

How a list of keywords performs in Bing Ads for a given device and match type. ⚠️ language_name is required and its absence is reported as Invalid Field: 'language_name' inside an HTTP 200 - the message means missing as well as wrong. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Valid pairs come from get_dataforseo_keywords_bing_kw_performance_locales. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.

请求体

必填

application/json

类型: array object[]
- 类型: object
  keywords
  类型: array string[]
  必填
  
  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 specified keywords will be converted to lowercase, data will be provided in a separate array learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
  
  device
  类型: string
  
  device type optional field specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all default value: all
  
  language_code
  类型: string
  
  search engine language code required field if you don’t specify language_name you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages example: "en"
  
  language_name
  类型: string
  
  full name of search engine 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 locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages example: English
  
  location_code
  类型: integer
  
  search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages example: 2840
  
  location_coordinate
  类型: string
  
  GPS coordinates of a location required field if you don’t specify location_name or location_code 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
  类型: string
  
  full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages example: "United States"
  
  match
  类型: string
  
  keywords match type optional field can take the following values: aggregate returns data across all match types; broad returns data for all user queries containing the specified keyword with varying word order; phrase returns data for all user queries containing the specified keyword with identical word order; exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default
  
  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.keyword
类型: string

keyword in a POST array

tasks.result.keyword_kpi
类型: object

object containing keyword metrics if there is no data, then the value is null

tasks.result.keyword_kpi.desktop
类型: array string[]

keyword data aggregated for desktop devices if there is no data, then the value is null

tasks.result.keyword_kpi.desktop.ad_position
类型: string

represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page

tasks.result.keyword_kpi.desktop.average_bid
类型: integer

average bid of the keyword

tasks.result.keyword_kpi.desktop.average_cpc
类型: integer

average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks

tasks.result.keyword_kpi.desktop.clicks
类型: integer

ad clicks the number of clicks that the keyword and match type generated during the last month

tasks.result.keyword_kpi.desktop.ctr
类型: integer

click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100

tasks.result.keyword_kpi.desktop.impressions
类型: integer

ad impressions the number of impressions that the keyword and match type generated during the last month

tasks.result.keyword_kpi.desktop.total_cost
类型: integer

total cost of an ad, USD the cost of using the specified keyword and match type during the last month

tasks.result.keyword_kpi.mobile
类型: array string[]

keyword data aggregated for mobile devices if there is no data, then the value is null

tasks.result.keyword_kpi.mobile.ad_position
类型: string

represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page

tasks.result.keyword_kpi.mobile.average_bid
类型: integer

average bid of the keyword

tasks.result.keyword_kpi.mobile.average_cpc
类型: integer

average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks

tasks.result.keyword_kpi.mobile.clicks
类型: integer

ad clicks the number of clicks that the keyword and match type generated during the last month

tasks.result.keyword_kpi.mobile.ctr
类型: integer

click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100

tasks.result.keyword_kpi.mobile.impressions
类型: integer

ad impressions the number of impressions that the keyword and match type generated during the last month

tasks.result.keyword_kpi.mobile.total_cost
类型: integer

total cost of an ad, USD the cost of using the specified keyword and match type during the last month

tasks.result.keyword_kpi.tablet
类型: array string[]

keyword data aggregated for tablet devices if there is no data, then the value is null

tasks.result.keyword_kpi.tablet.ad_position
类型: string

represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page

tasks.result.keyword_kpi.tablet.average_bid
类型: integer

average bid of the keyword

tasks.result.keyword_kpi.tablet.average_cpc
类型: integer

average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks

tasks.result.keyword_kpi.tablet.clicks
类型: integer

ad clicks the number of clicks that the keyword and match type generated during the last month

tasks.result.keyword_kpi.tablet.ctr
类型: integer

click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100

tasks.result.keyword_kpi.tablet.impressions
类型: integer

ad impressions the number of impressions that the keyword and match type generated during the last month

tasks.result.keyword_kpi.tablet.total_cost
类型: integer

total cost of an ad, USD the cost of using the specified keyword and match type during the last month

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.result.month
类型: integer

indicates the month for which the data is provided for example: 10

tasks.result.year
类型: integer

indicates the year for which the data is provided for example: 2020

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 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/bing/keyword_performance/live

curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/keyword_performance/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": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.keyword": "string",
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.year": 1,
  "tasks.result.month": 1,
  "tasks.result.keyword_kpi": {},
  "tasks.result.keyword_kpi.desktop": [
    "string"
  ],
  "tasks.result.keyword_kpi.desktop.ad_position": "string",
  "tasks.result.keyword_kpi.desktop.clicks": 1,
  "tasks.result.keyword_kpi.desktop.impressions": 1,
  "tasks.result.keyword_kpi.desktop.average_cpc": 1,
  "tasks.result.keyword_kpi.desktop.ctr": 1,
  "tasks.result.keyword_kpi.desktop.total_cost": 1,
  "tasks.result.keyword_kpi.desktop.average_bid": 1,
  "tasks.result.keyword_kpi.mobile": [
    "string"
  ],
  "tasks.result.keyword_kpi.mobile.ad_position": "string",
  "tasks.result.keyword_kpi.mobile.clicks": 1,
  "tasks.result.keyword_kpi.mobile.impressions": 1,
  "tasks.result.keyword_kpi.mobile.average_cpc": 1,
  "tasks.result.keyword_kpi.mobile.ctr": 1,
  "tasks.result.keyword_kpi.mobile.total_cost": 1,
  "tasks.result.keyword_kpi.mobile.average_bid": 1,
  "tasks.result.keyword_kpi.tablet": [
    "string"
  ],
  "tasks.result.keyword_kpi.tablet.ad_position": "string",
  "tasks.result.keyword_kpi.tablet.clicks": 1,
  "tasks.result.keyword_kpi.tablet.impressions": 1,
  "tasks.result.keyword_kpi.tablet.average_cpc": 1,
  "tasks.result.keyword_kpi.tablet.ctr": 1,
  "tasks.result.keyword_kpi.tablet.total_cost": 1,
  "tasks.result.keyword_kpi.tablet.average_bid": 1
}

Successful response

Setting Live ‘Bing Keyword Performance’ Tasks

身份验证Required

DataForSEO

Setting Live ‘Bing Keyword Performance’ Tasks