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

Setting ‘Bing Keyword Performance’ Tasks

伺服器:https://openapi.felo.ai
用戶端程式庫

DataForSEO

​

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

Setting ‘Bing Keyword Performance’ Tasks

​

Queues a Bing keyword-performance task, returning a task id. ⚠️ Same requirement as the live twin: language_name must be present. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Retrieve with get_dataforseo_keywords_bing_kw_performance_fetch.

請求本文
必填
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

      • pingback_url
        類型: string

        notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center

      • postback_url
        類型: string

        URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center

      • 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 tasksarray

    • 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

      unique task identifier in our system in the Universally unique identifier (UUID) format

    • tasks.path
      類型: array string[]

      URL path

    • tasks.result
      類型: array string[]

      array of results in this case, the value will be null

    • tasks.result_count
      類型: integer

      number of elements in the result 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 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/bing/keyword_performance/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/keyword_performance/task_post \
  --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"
  ]
}
Setting ‘Bing Keyword Performance’ Tasks