v0.1.0-beta

OpenAPI 3.1.0

Historical Bulk Traffic Estimation

Felo API Support

MIT

伺服器

https://openapi.felo.ai

用戶端程式庫

Shell Curl

DataForSEO

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

DataForSEO 操作

post/v1/beta/dataforseo/dataforseo_labs/google/historical_bulk_traffic_estimation/live

Historical Bulk Traffic Estimation

Estimated organic traffic for many domains at each point in the available history - the time series behind post_dataforseo_labs_google_bulk_traffic_estimation_live. This one takes no limit parameter, but it is priced per call rather than per item, so send the whole list at once. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ Response size multiplies domains by dates; keep both lists short. Available dates come from get_dataforseo_labs_google_available_history.

請求本文

必填

application/json

類型: array object[]
- targets
  類型: array string[]
  必填
  
  target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www.; you can set up to 1000 domains or subdomains
- date_from
  類型: string
  
  starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: "yyyy-mm-dd"
- date_to
  類型: string
  
  ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default; date format: "yyyy-mm-dd" example: "2021-04-01"
- ignore_synonyms
  類型: boolean
  
  ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false
- item_types
  類型: array string[]
  
  display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]
- language_code
  類型: string
  
  language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en
- language_name
  類型: string
  
  full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English
- location_code
  類型: integer
  
  location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840
- location_name
  類型: string
  
  full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom
- tag
  類型: 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

回應

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.items
類型: array string[]

array of items with relevant traffic estimation data

tasks.result.items_count
類型: integer

the number of results returned in the items array

tasks.result.items.metrics
類型: object

traffic data relevant to the specified domain

tasks.result.items.metrics.featured_snippet
類型: array string[]

traffic data from the featured snippet results in Google SERP

tasks.result.items.metrics.featured_snippet.count
類型: integer

total count of featured snippet items that contain the domain

tasks.result.items.metrics.featured_snippet.etv
類型: number

estimated traffic volume estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for learn more about how the metric is calculated in this help center article

tasks.result.items.metrics.featured_snippet.month
類型: integer

month for which the data is provided

tasks.result.items.metrics.featured_snippet.year
類型: integer

year for which the data is provided

tasks.result.items.metrics.local_pack
類型: array string[]

traffic data from the local pack results in SERP

tasks.result.items.metrics.local_pack.count
類型: integer

total count of local pack items that contain the domain

tasks.result.items.metrics.local_pack.etv
類型: number

estimated traffic volume estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for learn more about how the metric is calculated in this help center article

tasks.result.items.metrics.local_pack.month
類型: integer

month for which the data is provided

tasks.result.items.metrics.local_pack.year
類型: integer

year for which the data is provided

tasks.result.items.metrics.organic
類型: array string[]

traffic data from organic search

tasks.result.items.metrics.organic.count
類型: integer

total count of organic SERPs that contain the domain

tasks.result.items.metrics.organic.etv
類型: number

estimated traffic volume estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article

tasks.result.items.metrics.organic.month
類型: integer

month for which the data is provided

tasks.result.items.metrics.organic.year
類型: integer

year for which the data is provided

tasks.result.items.metrics.paid
類型: array string[]

traffic data from paid search

tasks.result.items.metrics.paid.count
類型: integer

total count of paid SERPs that contain the domain

tasks.result.items.metrics.paid.etv
類型: number

estimated traffic volume estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article

tasks.result.items.metrics.paid.month
類型: integer

month for which the data is provided

tasks.result.items.metrics.paid.year
類型: integer

year for which the data is provided

tasks.result.items.se_type
類型: string

search engine type

tasks.result.items.target
類型: string

target domain in a POST array

tasks.result.language_code
類型: string

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

tasks.result.location_code
類型: integer

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

tasks.result.se_type
類型: string

search engine type

tasks.result.total_count
類型: integer

total amount of results in our database relevant to your request

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

post/v1/beta/dataforseo/dataforseo_labs/google/historical_bulk_traffic_estimation/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/historical_bulk_traffic_estimation/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "targets": [
      ""
    ],
    "location_name": "",
    "location_code": 1,
    "language_name": "",
    "language_code": "",
    "date_from": "",
    "date_to": "",
    "ignore_synonyms": true,
    "item_types": [
      ""
    ],
    "tag": ""
  }
]'

顯示 Schema

{
  "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.se_type": "string",
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.se_type": "string",
  "tasks.result.items.target": "string",
  "tasks.result.items.metrics": {},
  "tasks.result.items.metrics.organic": [
    "string"
  ],
  "tasks.result.items.metrics.organic.year": 1,
  "tasks.result.items.metrics.organic.month": 1,
  "tasks.result.items.metrics.organic.etv": 1,
  "tasks.result.items.metrics.organic.count": 1,
  "tasks.result.items.metrics.paid": [
    "string"
  ],
  "tasks.result.items.metrics.paid.year": 1,
  "tasks.result.items.metrics.paid.month": 1,
  "tasks.result.items.metrics.paid.etv": 1,
  "tasks.result.items.metrics.paid.count": 1,
  "tasks.result.items.metrics.featured_snippet": [
    "string"
  ],
  "tasks.result.items.metrics.featured_snippet.year": 1,
  "tasks.result.items.metrics.featured_snippet.month": 1,
  "tasks.result.items.metrics.featured_snippet.etv": 1,
  "tasks.result.items.metrics.featured_snippet.count": 1,
  "tasks.result.items.metrics.local_pack": [
    "string"
  ],
  "tasks.result.items.metrics.local_pack.year": 1,
  "tasks.result.items.metrics.local_pack.month": 1,
  "tasks.result.items.metrics.local_pack.etv": 1,
  "tasks.result.items.metrics.local_pack.count": 1
}

Successful response

Historical Bulk Traffic Estimation

身分驗證Required

DataForSEO

Historical Bulk Traffic Estimation