Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Setting ‘Keywords For Site’ Tasks

Server:https://openapi.felo.ai
Client Libraries

DataForSEO

​

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

Setting ‘Keywords For Site’ Tasks

​

Queues a Bing keywords-for-site task, returning a task id. 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_for_site_fetch.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.09.
  • Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

Body
application/json
  • Type: array (object | null)[]
    • date_from
      Type: string | null

      starting date of the time range
      optional field
      minimal value: 24 months from today's date;
      if you don't specify this field, data will be provided for the last 12 months;
      if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;
      if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;
      date format: "yyyy-mm-dd"
      example:
      "2020-01-01"

      Note: we do not recommend using a custom time range for the past year's dates

    • date_to
      Type: string | null

      ending date of the time range
      optional field
      if you don't specify this field, data will be provided for the last 12 months;
      minimum value: two years back from today’s date;
      maximum value: one month from today's date;
      date format: "yyyy-mm-dd"
      example:
      "2020-03-15"

      Note: we do not recommend using a custom time range for the past year's dates

    • device
      Type: string | null

      device type
      optional field
      specify this field if you want to get the data for a particular device type
      possible values: all, mobile, desktop, tablet
      default value: all

    • keywords_negative
      Type: array string[] | null

      keywords negative array
      optional field
      These keywords will be ignored in the results array;
      You can specify a maximum of 200 terms that you want to exclude from the results;
      the specified keywords will be converted to lowercase format

    • language_code
      Type: string

      search engine language code
      required field if you don't specify language_name
      if you use this field, you don't need to specify language_name
      supported languages:
      en, fr, de

    • language_name
      Type: 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
      supported languages:
      English, French, German

    • location_code
      Type: 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 of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
      example:
      2840

    • location_coordinate
      Type: 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
      Type: 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 of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations
      example:
      London,England,United Kingdom

    • pingback_url
      Type: string | null

      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
      Type: string | null

      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

    • search_partners
      Type: boolean | null

      Bing search partners type
      optional field
      if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.
      default value: false - results are returned for Bing, AOL, and Yahoo search networks

    • sort_by
      Type: string | null

      results sorting parameters
      optional field
      Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order
      default value: relevance

    • tag
      Type: string | null

      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

    • target
      Type: string

      domain or URL
      required field
      the URL of the webpage or the domain to scan for possible keywords

Responses
  • 200
    Type: object | null · Response36Afe1097B20_KeywordsDataBingKeywordsForSiteTaskPostResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

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

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_KeywordsDataBingKeywordsForSiteTaskPostTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

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

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: object | null

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

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

          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

        • status_message
          Type: string | null

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

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

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

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      the current version of the API

    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 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

    Error response; upstream passthrough responses may use provider formats

    application/json
Request Example for post/v1/beta/dataforseo/keywords_data/bing/keywords_for_site/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/keywords_for_site/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "target": "dataforseo.com"
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": null
    }
  ]
}
Setting ‘Keywords For Site’ Tasks

Need help?