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

Get Search Volume Results by id

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

DataForSEO

​

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

Get Search Volume Results by id

​

Retrieves a queued Google Ads search-volume task by id. Same shape as post_dataforseo_keywords_gads_search_volume_live. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.

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_KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo
    • 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_KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo
        • 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

          • competition
            Type: string | null

            competition
            represents the relative amount of competition associated with the given keyword in paid SERP only;
            this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;
            if there is no data the value is null;
            learn more about the metric in this help center article

          • competition_index
            Type: integer | null

            competition
            represents the relative amount of competition associated with the given keyword in paid SERP only;
            this value is based on Google Ads data and can be between 0 and 100 (inclusive);
            if there is no data the value is null;
            learn more about the metric in this help center article

          • cpc
            Type: number | null

            cost per click
            indicates the amount paid (USD) for each click on the ad displayed for a given keyword

          • high_top_of_page_bid
            Type: number | null

            maximum bid for the ad to be displayed at the top of the first page
            indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
            the value may differ depending on the location specified in a POST request

          • keyword
            Type: string | null

            keyword
            keyword is returned with decoded %## (plus character '+' will be decoded to a space character)

          • language_code
            Type: string | null

            language code in a POST array
            if there is no data, then the value is_nulln

          • location_code
            Type: integer | null

            location code in a POST array
            if there is no data, then the value is_nulln

          • low_top_of_page_bid
            Type: number | null

            minimum bid for the ad to be displayed at the top of the first page
            indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);
            the value may differ depending on the location specified in a POST request

          • 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 by default), targeted to the specified geographic locations;
            if there is no data then the value is_nulln

            • 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

          • spell
            Type: string | null

            correct spelling of the keyword
            Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;
            we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link

        • 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/google_ads/search_volume/task_get/{id}
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/search_volume/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,
          "spell": null,
          "location_code": null,
          "language_code": null,
          "search_partners": null,
          "competition": null,
          "competition_index": null,
          "search_volume": null,
          "low_top_of_page_bid": null,
          "high_top_of_page_bid": null,
          "cpc": null,
          "monthly_searches": [
            {
              "year": null,
              "month": null,
              "search_volume": null
            }
          ]
        }
      ]
    }
  ]
}
Get Search Volume Results by id

Need help?