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

Get ‘Keywords For Site’ Results by id

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

DataForSEO

​

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

Get ‘Keywords For Site’ Results by id

​

Retrieves a queued Bing keywords-for-site task by id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ The response size was fixed by the depth or limit set at submit time and cannot be narrowed here; if it is too large, resubmit smaller rather than paging.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.012.
  • 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.

Path Parameters
  • id
    Type: string
    required

    task identifier
    unique task identifier in our system in the UUID format
    you will be able to use it within 30 days to request the results of the task at any time

Responses
  • 200
    Type: object | null · Response36Afe1097B20_KeywordsDataBingKeywordsForSiteTaskGetResponseInfo
    • 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_KeywordsDataBingKeywordsForSiteTaskGetTaskInfo
        • 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: array (object | null)[] | null

          array of results

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

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

          • competition
            Type: number | null

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

            0.1 - low competition,
            0.5 - medium competition,
            0.9 - high competition;
            if there is no data the value is null

          • cpc
            Type: number | null

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

          • device
            Type: string | null

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

          • keyword
            Type: string | null

            keyword in a POST array

          • language_code
            Type: string | null

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

          • location_code
            Type: integer | null

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

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

            monthly searches
            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            search volume is rounded to the closest decimal values

            if there is no data the value is null

            • month
              Type: integer | null

              month

            • search_volume
              Type: integer | null

              monthly average search volume rate

            • year
              Type: integer | null

              year

          • search_partners
            Type: boolean | null

            indicates whether data from partner networks included in the response

          • search_volume
            Type: integer | null Format: int64

            monthly average search volume rate
            represents the (approximate) number of searches for the given keyword idea on Bing search engine depending on the user’s targeting
            if there is no data then the value is_nulln

        • 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 get/v1/beta/dataforseo/keywords_data/bing/keywords_for_site/task_get/{id}
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/keywords_for_site/task_get/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "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": [
        {
          "keyword": null,
          "location_code": null,
          "language_code": null,
          "search_partners": null,
          "device": null,
          "competition": null,
          "cpc": null,
          "search_volume": null,
          "categories": [
            null
          ],
          "monthly_searches": [
            {
              "year": null,
              "month": null,
              "search_volume": null
            }
          ]
        }
      ]
    }
  ]
}
Get ‘Keywords For Site’ Results by id

Need help?