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 |
float |
total tasks cost, USD |
tasks_count |
integer |
the number of tasks in the tasksarray |
tasks_error |
integer |
the number of tasks in the tasks array returned with an error |
tasks |
array |
array of tasks |
id |
string |
unique task identifier in our system
in the UUID format |
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 |
status_message |
string |
informational message of the task
you can find the full list of general informational messages here |
time |
string |
execution time, seconds |
cost |
float |
cost of the task, USD |
result_count |
integer |
number of elements in the result array |
path |
array |
URL path |
data |
object |
contains the same parameters that you specified in the POST request |
result |
array |
array of results |
keyword |
string |
keyword received in a POST array
keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) |
type |
string |
search engine type in a POST array |
se_domain |
string |
search engine domain in a POST array |
location_code |
integer |
location code in a POST array |
language_code |
string |
language code
in this case, the value will be null |
check_url |
string |
direct URL to search engine results |
datetime |
string |
date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00 |
spell |
object |
autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection |
keyword |
string |
keyword obtained as a result of search engine autocorrection
the results will be provided for the corrected keyword |
type |
string |
type of autocorrection
possible values:
did_you_mean, showing_results_for, no_results_found_for, including_results_for |
refinement_chips |
object |
search refinement chips
|
type |
string |
type of element = ‘refinement_chips’ |
xpath |
string |
the XPath of the element |
items |
array |
items of the element
|
type |
string |
type of element = ‘refinement_chips_element’ |
title |
string |
title of the element |
url |
string |
search URL with refinement parameters |
domain |
string |
domain in SERP |
options |
array |
further search refinement options |
type |
string |
type of element = ‘refinement_chips_option’ |
title |
string |
title of the element |
url |
string |
search URL with refinement parameters |
domain |
string |
domain in SERP |
item_types |
array |
types of search results found in SERP
possible item types:
event_item |
se_results_count |
integer |
total number of results in SERP
in this case, the value will be 0
this search engine does not indicate the total number of results |
items_count |
integer |
the number of results returned in the items array |
items |
array |
items in SERP |
| ‘event_item’ element in SERP |
|
|
type |
string |
type of element = ‘event_item’ |
rank_group |
integer |
group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group |
rank_absolute |
integer |
absolute rank in SERP
absolute position among all the elements in SERP |
position |
string |
the alignment of the element in SERP
can take the following values:
left, right |
xpath |
string |
the XPath of the element |
title |
string |
title of the result in SERP |
description |
string |
description of the results element in SERP
|
url |
string |
relevant URL |
image_url |
string |
URL of the image featured in the element |
event_dates |
object |
dates when the event takes place
if there are none, equals null |
start_datetime |
string |
date and time when the event starts
if time zone is specified in the event, value will be returned in the UTC format:
“yyyy-mm-ddThh-mm-ss+00:00”
example:
2019-11-15T12:57:46+00:00
if time zone is not specified in the event, unspecified local time will be returned in the following format:
“yyyy-mm-ddThh-mm-ss”
example:
2019-11-15T12:57:46 |
end_datetime |
string |
date and time when the event ends
if time zone is specified in the event, value will be returned in the UTC format:
“yyyy-mm-ddThh-mm-ss+00:00”
example:
2019-11-15T12:57:46+00:00
if time zone is not specified in the event, unspecified local time will be returned in the following format:
“yyyy-mm-ddThh-mm-ss”
example:
2019-11-15T12:57:46 |
displayed_dates |
string |
date or date range as it is displayed in SERP
|
location_info |
object |
information about the event’s venue
|
name |
string |
name of the event’s venue
|
address |
string |
address of the event’s venue |
url |
string |
URL to the event’s venue on google maps
|
cid |
string |
google-defined client id
can be used with Google Reviews API to get a full list of reviews
|
feature_id |
string |
the unique identifier of the element in SERP
|
information_and_tickets |
array |
additional information and ticket purchase options
|
type |
string |
type of element = ‘information_and_tickets_element’ |
title |
string |
title of the element |
description |
string |
description of the element |
url |
string |
relevant URL |
domain |
string |
domain in SERP |