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 tasks array |
tasks_error |
integer |
the number of tasks in the tasks array that were returned an error |
tasks |
array |
array of tasks |
id |
string |
task identifier
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 a POST array |
check_url |
string |
direct URL to search engine results
you can use it to make sure that we provided accurate 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 |
title |
string |
title of the ‘reviews’ element in SERP
the name of the local establishment for which the reviews are collected |
sub_title |
string |
subtitle of the ‘reviews’ element in SERP
additional information (e.g., address) on the ‘reviews’ element for which the reviews are collected |
rating |
object |
rating of the corresponding local establishment
popularity rate based on reviews and displayed in SERP |
rating_type |
string |
type of rating
here you can find the following elements: Max5, Percents, CustomMax |
value |
float |
the average rating based on all reviews |
votes_count |
integer |
the number of votes
|
rating_max |
integer |
the maximum value for a rating_type |
feature_id |
string |
the unique identifier of the ‘reviews’ element in SERP
learn more about the identifier in this help center article |
place_id |
string |
unique identifier of a business location assigned by Google
learn more about the identifier in this help center article |
cid |
string |
google-defined client id
unique id of a local establishment
learn more about the identifier in this help center article |
reviews_count |
integer |
the total number of reviews |
items_count |
integer |
the number of reviews items in the results array
you can get more results by using the depth parameter when setting a task |
items |
array |
found reviews
you can get more results by using the depth parameter when setting a task |
type |
string |
the review’s type
possible review types: "google_reviews_search" |
rank_group |
integer |
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 among all the listed reviews
absolute position among all reviews on the list |
position |
string |
the alignment of the review in SERP
can take the following values: right |
xpath |
string |
the XPath of the review |
review_text |
string |
the content of the review |
original_review_text |
string |
original content of the review
the original content of the review, no auto-translate applied |
time_ago |
string |
the time of publication
indicates the time (in the ‘time ago’ format) when the review was listed |
timestamp |
string |
date and time when a review was published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00 |
rating |
object |
the rating score submitted by the reviewer |
rating_type |
string |
the type of the rating
can take the following values: Max5 |
value |
float |
the value of the rating |
votes_count |
integer |
the amount of feedback
indicated the number of votes the review obtained |
rating_max |
integer |
the maximum value for a rating_type
the maximum value for Max5 is 5 |
reviews_count |
integer |
total number of reviews submitted by the reviewer |
photos_count |
integer |
total number of photos submitted by the reviewer |
local_guide |
boolean |
indicates whether the reviewer has a ‘local guide’ status |
profile_name |
string |
profile name of the reviewer |
profile_url |
string |
URL of the reviewer’s profile |
review_url |
string |
the URL of the review |
profile_image_url |
string |
URL of the reviewer’s profile image |
owner_answer |
string |
text of the owner’s response
the owner’s response to the review |
original_owner_answer |
string |
original text of the owner’s response
the original response to the review, no auto-translate applied |
owner_time_ago |
string |
publication time
indicates the time (in the ‘time ago’ format) when the owner submitted the response to the review |
owner_timestamp |
string |
date and time of the owner’s reply to the review
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00 |
review_id |
string |
the unique identifier of a review on Google
example:
ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE |
images |
array |
images submitted by the reviewer |
type |
string |
type of element = ‘images_element’ |
alt |
string |
alt tag of the image |
url |
string |
relevant image URL from Google |
image_url |
string |
URL of the image featured in the review |
review_highlights |
array |
review highlights
contains highlighted review criteria and assessments |
feature |
string |
reviewed feature |
assessment |
string |
feature assessment |