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

Setting Live ‘Keywords For Site’ Tasks

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

DataForSEO

​

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

DataForSEO Operations

Setting Live ‘Keywords For Site’ Tasks

​

The Bing keywords a whole site ranks or bids for, from a target domain. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The Google twin is post_dataforseo_keywords_gads_kw_for_site_live. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.

Body
required
application/json
  • Type: array object[]
    • Type: object
      • target
        Type: string
        required

        domain or URL required field the domain name or URL of the target website

      • date_from
        Type: string

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

        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; note: we do not recommend using a custom time range for the past year’s dates; 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

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

      • keywords_negative
        Type: array string[]

        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

      • search_partners
        Type: boolean

        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

        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

        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

      Empty object
      Empty object
Responses
  • 200
    Type: object

    Successful response

    • cost
      Type: number

      total tasks cost, USD

    • status_code
      Type: 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
      Type: string

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

    • tasks
      Type: array string[]

      array of tasks

    • tasks_count
      Type: integer

      the number of tasks in the tasks array

    • tasks_error
      Type: integer

      the number of tasks in the tasks array that were returned an error

    • tasks.cost
      Type: number

      cost of the task, USD

    • tasks.data
      Type: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Type: string

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

    • tasks.path
      Type: array string[]

      URL path

    • tasks.result
      Type: array string[]

      array of results

    • tasks.result_count
      Type: integer

      number of elements in the result array

    • tasks.result.categories
      Type: array string[]

      product and service categories legacy field, the value will always be null

    • tasks.result.competition
      Type: number

      competition represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data. Possible values: 0.1, 0.5,0.90.1 – low competition, 0.5 – medium competition, 0.9 – high competition; if there is no data the value is null

    • tasks.result.cpc
      Type: number

      cost-per-click represents the average cost per click (USD) historically paid for the keyword. if there is no data, then the value is null

    • tasks.result.device
      Type: string

      device type in a POST array if there is no data, then the value is null

    • tasks.result.keyword
      Type: string

      keyword in a POST array

    • tasks.result.language_code
      Type: string

      language code in a POST array

    • tasks.result.location_code
      Type: integer

      location code in a POST array

    • tasks.result.monthly_searches
      Type: array string[]

      monthly searches represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations. if there is no data, then the value is null

    • tasks.result.monthly_searches.month
      Type: integer

      month

    • tasks.result.monthly_searches.search_volume
      Type: integer

      monthly average search volume rate search volume is rounded to the closest decimal values

    • tasks.result.monthly_searches.year
      Type: integer

      year

    • tasks.result.search_partners
      Type: boolean

      indicates whether data from partner networks included in the response

    • tasks.result.search_volume
      Type: integer

      monthly average search volume rate represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingsearch volume is rounded to the closest decimal valuesif there is no data, then the value is null

    • tasks.status_code
      Type: 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
      Type: string

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

    • tasks.time
      Type: string

      execution time, seconds

    • time
      Type: string

      execution time, seconds

    • version
      Type: 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/keywords_for_site/live
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/keywords_for_site/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.keyword": "string",
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.search_partners": true,
  "tasks.result.device": "string",
  "tasks.result.competition": 1,
  "tasks.result.cpc": 1,
  "tasks.result.search_volume": 1,
  "tasks.result.categories": [
    "string"
  ],
  "tasks.result.monthly_searches": [
    "string"
  ],
  "tasks.result.monthly_searches.year": 1,
  "tasks.result.monthly_searches.month": 1,
  "tasks.result.monthly_searches.search_volume": 1
}

Successful response

Setting Live ‘Keywords For Site’ Tasks