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 |
asin |
string |
asin received in a POST array |
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 |
spell |
object |
autocorrection of the search engine
in this case, the value will be null |
title |
string |
title of the product on Amazon
the title of the product for which the reviews are collected |
image |
object |
product image data |
type |
string |
type of element = ‘images_element’ |
alt |
string |
alt tag of the image |
url |
string |
relevant url |
image_url |
string |
URL of the product image featured in the results |
rating |
object |
rating of the product on Amazon
popularity rate based on reviews and displayed in SERP |
type |
string |
type of element = ‘rating_element’ |
position |
string |
the alignment of the element in Amazon SERP
can take the following values:
left, right |
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 |
reviews_count |
integer |
the total number of reviews |
item_types |
array |
type of search results in Amazon SERP
contains types of search results (items) found in Amazon SERP;
possible item types:
amazon_review_item |
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: "amazon_review_item" |
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 element |
verified |
boolean |
indicates whether the review has the “Verified Purchase” mark |
subtitle |
string |
subtitle of the review |
helpful_votes |
integer |
helpful votes count
number of users who clicked on the ‘Helpful” button under the review text |
images |
array |
images of the product submitted by the reviewer |
type |
string |
type of element = ‘images_element’ |
alt |
string |
alt tag of the image |
url |
string |
relevant url |
image_url |
string |
URL of the product image featured in the review |
videos |
array |
videos of the product submitted by the reviewer |
type |
string |
type of element = ‘video_element’ |
source |
string |
URL to the video source |
preview |
string |
URL to the video preview image |
user_profile |
object |
user profile of the reviewer |
name |
string |
the name of the reviewer
|
avatar |
string |
URL to the profile picture of the reviewer
|
url |
string |
URL to the reviewer’s profile
|
reviews_count |
integer |
total number of reviews submitted by the reviewer
|
locations |
string |
country of the reviewer
|
title |
string |
title of the review |
url |
string |
URL to the review |
review_text |
string |
content of the review |
publication_date |
string |
date and time when the 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
in this case, the value will be null |
rating_max |
integer |
the maximum value for a rating_type
the maximum value for Max5 is 5 |