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

Get ‘Ads Traffic By Keywords’ Results by id

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

DataForSEO

​

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

Get ‘Ads Traffic By Keywords’ Results by id

​

Retrieves a queued Google Ads traffic forecast by id: projected impressions, clicks, cost and average position for the bid you specified. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Unlike the volume endpoints this is a projection, not a measurement - the numbers move with bid and match.

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_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo
    • 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_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetTaskInfo
        • 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

          • average_cpc
            Type: number | null Format: double

            the average cost-per-click value
            represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;
            if there is no data, then the value is_nulln

          • bid
            Type: number | null

            the maximum custom bid
            the bid you have specified when setting the task
            represents the price you are willing to pay for an ad
            the higher value you have specified, the higher metrics and cost you receive in response
            learn more in this help center article

          • clicks
            Type: number | null

            number of clicks on an ad
            number of clicks an ad is projected to get within the specified time period
            if there is no data, then the value is_nulln

          • cost
            Type: number | null

            charge for an ad
            amount that will be charged for running an ad within the specified time period
            if there is no data, then the value is_nulln

          • ctr
            Type: number | null Format: double

            projected clickthrough rate (CTR) of the advertisement
            number of clicks an ad is projected to receive divided by the number of ad impressions;
            Note: parameter deprecated, the value is always null

          • date_interval
            Type: string | null

            forecasting date interval in a POST array

          • impressions
            Type: integer | null

            projected number of ad impressions
            number of impressions an ad is projected to get within the specified time period
            Note: parameter deprecated, the value is always_nulln

          • keyword
            Type: string | null

            keyword in a POST array
            metrics are provided for all the keywords specified in the POST array

          • 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

          • match
            Type: string | null

            keywords match-type
            can take the following values: exact, broad, phrase

          • search_partners
            Type: boolean | null

            include Google search partners
            the value is always false

        • 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/ad_traffic_by_keywords/task_get/{id}
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/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,
          "date_interval": null,
          "search_partners": null,
          "bid": null,
          "match": null,
          "impressions": null,
          "ctr": null,
          "average_cpc": null,
          "cost": null,
          "clicks": null
        }
      ]
    }
  ]
}
Get ‘Ads Traffic By Keywords’ Results by id

Need help?