Skip to main content
POST
https://api.aisa.one/apis/v1
/
dataforseo
/
keywords_data
/
google_ads
/
keywords_for_site
/
live
Setting Live ‘Keywords For Site’ Tasks
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_site/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "<string>",
  "target_type": "<string>",
  "location_name": "<string>",
  "location_code": 123,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "search_partners": true,
  "date_from": "<string>",
  "date_to": "<string>",
  "include_adult_keywords": true,
  "sort_by": "<string>",
  "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.keyword": "<string>",
  "tasks.result.location_code": 123,
  "tasks.result.language_code": "<string>",
  "tasks.result.search_partners": true,
  "tasks.result.competition": "<string>",
  "tasks.result.competition_index": 123,
  "tasks.result.search_volume": 123,
  "tasks.result.low_top_of_page_bid": 123,
  "tasks.result.high_top_of_page_bid": 123,
  "tasks.result.cpc": 123,
  "tasks.result.monthly_searches": [
    "<string>"
  ],
  "tasks.result.monthly_searches.year": 123,
  "tasks.result.monthly_searches.month": 123,
  "tasks.result.monthly_searches.search_volume": 123,
  "tasks.result.keyword_annotations": {},
  "tasks.result.concepts": [
    "<string>"
  ],
  "tasks.result.concepts.name": "<string>",
  "tasks.result.concepts.concept_group": {},
  "tasks.result.concepts.concept_group.name": "<string>",
  "tasks.result.concepts.concept_group.type": "<string>"
}

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
​
target
string
required

domain or page required field the domain name of the target website or the url of the target page; note: to obtain keywords for the target website, use the target_type parameter

​
target_type
string

search keywords for site or for url optional field possible values: site, page; default value: page; if set to site, keywords will be provided for the entire site; if set to page, keywords will be provided for the specified webpage

​
location_name
string

full name of search engine location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; 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/google_ads/locations example: London,England,United Kingdom

​
location_code
integer

search engine location code optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; 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/google_ads/locations example: 2840

​
location_coordinate
string

GPS coordinates of a location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; 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” format; the data will be provided for the country the specified coordinates belong to; example: 52.6178549,-155.352142

​
language_name
string

full name of search engine language optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages example: English

​
language_code
string

search engine language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages example: en

​
search_partners
boolean

include Google search partners optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search; default value: false – results are returned for Google search sites

​
date_from
string

starting date of the time range optional field date format: "yyyy-mm-dd" minimal value: 4 years from the current date by default, data is returned for the past 12 months; Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior; if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior

​
date_to
string

ending date of the time range optional field Note: the indicated date cannot be greater than yesterday’s date; if you don’t specify this field, yesterday’s date will be used by default date format: "yyyy-mm-dd" example: "2022-11-30"

​
include_adult_keywords
boolean

include keywords associated with adult content optional field if set to true, adult keywords will be included in the response default value: false note that the API may return no data for such keywords due to Google Ads restrictions

​
sort_by
string

results sorting parameters optional field Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order default value: relevance

​
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 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.keyword
string

keyword in a POST array

​
tasks.result.location_code
integer

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

​
tasks.result.language_code
string

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

​
tasks.result.search_partners
boolean

include Google search partners the value you specified when setting the task if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if false, the results are returned for Google search sites only

​
tasks.result.competition
string

competition represents the relative level of competition associated with the given keyword in paid SERP only possible values: LOW, MEDIUM, HIGH if competition level is unknown, the value is null; learn more about the metric in this help center article

​
tasks.result.competition_index
integer

competition index the competition index for the query indicating how competitive ad placement is for the keyword can take values from 0 to 100 the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available if not enough data is available, the value is null; learn more about the metric in this help center article

​
tasks.result.search_volume
integer

monthly average search volume rate represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting if there is no data, the value is null

​
tasks.result.low_top_of_page_bid
number

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

​
tasks.result.high_top_of_page_bid
number

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

​
tasks.result.cpc
number

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

​
tasks.result.monthly_searches
string[]

monthly searches represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations if there is no data, the value is null

​
tasks.result.monthly_searches.year
integer

year

​
tasks.result.monthly_searches.month
integer

month

​
tasks.result.monthly_searches.search_volume
integer

monthly average search volume rate

​
tasks.result.keyword_annotations
object

the annotations for the keyword

​
tasks.result.concepts
string[]

the list of concepts for the keyword

​
tasks.result.concepts.name
string

the concept name for the keyword in the concept_group

​
tasks.result.concepts.concept_group
object

the concept group of the concept details

​
tasks.result.concepts.concept_group.name
string

the concept group name

​
tasks.result.concepts.concept_group.type
string

the concept group type