Skip to main content
POST
https://api.aisa.one/apis/v1
/
dataforseo
/
dataforseo_labs
/
google
/
bulk_traffic_estimation
/
live
Bulk Traffic Estimation
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/bulk_traffic_estimation/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targets": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 123,
  "language_name": "<string>",
  "language_code": "<string>",
  "item_types": [
    "<string>"
  ],
  "ignore_synonyms": true,
  "tag": "<string>"
}
'
{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "tasks.result": [
    "<string>"
  ],
  "tasks.result.se_type": "<string>",
  "tasks.result.location_code": 123,
  "tasks.result.language_code": "<string>",
  "tasks.result.total_count": 123,
  "tasks.result.items_count": 123,
  "tasks.result.items": [
    "<string>"
  ],
  "tasks.result.items.se_type": "<string>",
  "tasks.result.items.target": "<string>",
  "tasks.result.items.metrics": {},
  "tasks.result.items.metrics.organic": {},
  "tasks.result.items.metrics.organic.etv": 123,
  "tasks.result.items.metrics.organic.count": 123,
  "tasks.result.items.metrics.paid": {},
  "tasks.result.items.metrics.paid.etv": 123,
  "tasks.result.items.metrics.paid.count": 123,
  "tasks.result.items.metrics.featured_snippet": {},
  "tasks.result.items.metrics.featured_snippet.etv": 123,
  "tasks.result.items.metrics.featured_snippet.count": 123,
  "tasks.result.items.metrics.local_pack": {},
  "tasks.result.items.metrics.local_pack.etv": 123,
  "tasks.result.items.metrics.local_pack.count": 123
}

Documentation Index

Fetch the complete documentation index at: https://aisa.one/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
targets
string[]
required

target domains, subdomains, and webpages required field you can specify domains, subdomains, and webpages in this field; domains and subdomains should be specified without https:// and www.; pages should be specified with absolute URL, including https:// and www.; you can set up to 1000 domains, subdomains or webpages

​
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

​
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

​
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

​
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

​
item_types
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"]

​
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

​
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

Response

Successful response

​
version
string

the current version of the API

​
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

​
time
string

execution time, seconds

​
cost
number

total tasks cost, USD

​
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
string[]

array of tasks

​
tasks.id
string

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

​
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

​
tasks.cost
number

cost of the task, USD

​
tasks.result_count
integer

number of elements in the result array

​
tasks.path
string[]

URL path

​
tasks.data
object

contains the same parameters that you specified in the POST request

​
tasks.result
string[]

array of results

​
tasks.result.se_type
string

search engine type

​
tasks.result.location_code
integer

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

​
tasks.result.language_code
string

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

​
tasks.result.total_count
integer

total amount of results in our database relevant to your request

​
tasks.result.items_count
integer

the number of results returned in the items array

​
tasks.result.items
string[]

array of items with relevant traffic estimation data

​
tasks.result.items.se_type
string

search engine type

​
tasks.result.items.target
string

target domain in a POST array

​
tasks.result.items.metrics
object

traffic data relevant to the specified domain

​
tasks.result.items.metrics.organic
object

traffic data from organic search

​
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.count
integer

total count of organic SERPs that contain the domain

​
tasks.result.items.metrics.paid
object

traffic data from paid search

​
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.count
integer

total count of paid SERPs that contain the domain

​
tasks.result.items.metrics.featured_snippet
object

traffic data from the featured snippet results in Google SERP

​
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.count
integer

total count of featured snippet items that contain the domain

​
tasks.result.items.metrics.local_pack
object

traffic data from the local pack results in SERP

​
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.count
integer

total count of local pack items that contain the domain