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

Setting Live ‘Bing Ads Audience Estimation’ Tasks

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клиентские библиотеки
Shell Curl

DataForSEO

​

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

DataForSEO Операции

Setting Live ‘Bing Ads Audience Estimation’ Tasks

​

Estimates the Bing Ads audience reachable at a given bid and daily_budget, narrowed by location_code, age, industry and job function. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Industry and job-function values come from get_dataforseo_keywords_bing_audience_industries and get_dataforseo_keywords_bing_audience_job_functions - both free, and both worth reading before composing a request. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.

Тело
обязательно
application/json
  • Тип: array object[]
      • location_name
        Тип: 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

      • age
        Тип: array string[]

        selection of age ranges for targeting possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve

      • bid
        Тип: number

        desired bid setting value in USD maximum value: 1000

      • daily_budget
        Тип: number

        daily campaign budget value in USD maximum value: 10000

      • gender
        Тип: array string[]

        gender to target possible values: male, female, unknown

      • industry
        Тип: array integer[]

        industry of LinkedIn profile targeting if you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries example: 806301758

      • job_function
        Тип: array integer[]

        job function of LinkedIn profile targeting if you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions example: 806300451

      • location_code
        Тип: 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
        Тип: 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,radius (in km)” format the data will be provided for the country the specified coordinates belong to example: 29.6821525,-82.4098881,100

Ответы
  • 200
    Тип: object

    Successful response

    • cost
      Тип: number

      total tasks cost, USD

    • status_code
      Тип: 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
      Тип: string

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

    • tasks
      Тип: array string[]

      array of tasks

    • tasks_count
      Тип: integer

      the number of tasks in the tasks array

    • tasks_error
      Тип: integer

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

    • tasks.cost
      Тип: number

      cost of the task, USD

    • tasks.data
      Тип: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Тип: string

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

    • tasks.path
      Тип: array string[]

      URL path

    • tasks.result
      Тип: array string[]

      array of results

    • tasks.result_count
      Тип: integer

      number of elements in the result array

    • tasks.result.currency
      Тип: integer

      currency name example: USDollar

    • tasks.result.est_audience_size
      Тип: object

      monthly estimated reach user count range

    • tasks.result.est_audience_size.high
      Тип: integer

      indicates the upper bound of the range result

    • tasks.result.est_audience_size.low
      Тип: integer

      indicates the lower bound of the range result

    • tasks.result.est_clicks
      Тип: object

      monthly estimated click count range

    • tasks.result.est_clicks.high
      Тип: integer

      indicates the upper bound of the range result

    • tasks.result.est_clicks.low
      Тип: integer

      indicates the lower bound of the range result

    • tasks.result.est_cost_per_event
      Тип: object

      indicates the estimated cost per event with range result

    • tasks.result.est_cost_per_event.high
      Тип: number

      indicates the upper bound of the range result

    • tasks.result.est_cost_per_event.low
      Тип: number

      indicates the lower bound of the range result

    • tasks.result.est_ctr
      Тип: object

      estimated click-through rate range

    • tasks.result.est_ctr.high
      Тип: number

      indicates the upper bound of the range result

    • tasks.result.est_ctr.low
      Тип: number

      indicates the lower bound of the range result

    • tasks.result.est_impressions
      Тип: object

      monthly estimated impressions range

    • tasks.result.est_impressions.high
      Тип: integer

      indicates the upper bound of the range result

    • tasks.result.est_impressions.low
      Тип: integer

      indicates the lower bound of the range result

    • tasks.result.est_reach_audience_size
      Тип: integer

      monthly estimated user count

    • tasks.result.est_reach_impressions
      Тип: integer

      monthly estimated impressions

    • tasks.result.est_spend
      Тип: object

      monthly estimated spending range

    • tasks.result.est_spend.high
      Тип: integer

      indicates the upper bound of the range result

    • tasks.result.est_spend.low
      Тип: integer

      indicates the lower bound of the range result

    • tasks.result.events_lost_to_bid
      Тип: integer

      indicates event lost count due to insufficient input bid

    • tasks.result.events_lost_to_budget
      Тип: integer

      indicates the event lost count due to insufficient input budget

    • tasks.result.suggested_bid
      Тип: number

      suggested bid value under the current targeting

    • tasks.result.suggested_budget
      Тип: integer

      suggested daily budget value under the current targeting and bid

    • tasks.status_code
      Тип: 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
      Тип: string

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

    • tasks.time
      Тип: string

      execution time, seconds

    • time
      Тип: string

      execution time, seconds

    • version
      Тип: 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/audience_estimation/live
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/audience_estimation/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.est_impressions": {},
  "tasks.result.est_impressions.high": 1,
  "tasks.result.est_impressions.low": 1,
  "tasks.result.est_audience_size": {},
  "tasks.result.est_audience_size.high": 1,
  "tasks.result.est_audience_size.low": 1,
  "tasks.result.est_clicks": {},
  "tasks.result.est_clicks.high": 1,
  "tasks.result.est_clicks.low": 1,
  "tasks.result.est_spend": {},
  "tasks.result.est_spend.high": 1,
  "tasks.result.est_spend.low": 1,
  "tasks.result.est_cost_per_event": {},
  "tasks.result.est_cost_per_event.high": 1,
  "tasks.result.est_cost_per_event.low": 1,
  "tasks.result.est_ctr": {},
  "tasks.result.est_ctr.high": 1,
  "tasks.result.est_ctr.low": 1,
  "tasks.result.suggested_bid": 1,
  "tasks.result.suggested_budget": 1,
  "tasks.result.events_lost_to_bid": 1,
  "tasks.result.events_lost_to_budget": 1,
  "tasks.result.est_reach_audience_size": 1,
  "tasks.result.est_reach_impressions": 1,
  "tasks.result.currency": 1
}

Successful response

Setting Live ‘Bing Ads Audience Estimation’ Tasks