Skip to content

Get reviews

Use this endpoint to retrieve actual reviews from scraping using the job_id of the task.

Base URL

GET https://app.datashake.com/api/v2/profiles/reviews

Request parameters

KEY DATATYPE REQUIRED DESCRIPTION
job_id string yes Job ID of the task to retrieve
from_date string no Reviews time range
language_code string no Reviews language
page integer no Page number to fetch
per_page string no Number of reviews per page
allow_response boolean no Review responses

Reviews language

With this parameter you can request reviews in a specific language only.

Country code must be specified in alpha2 format in lower case (eg. us).

curl GET 'https://app.datashake.com/api/v2/profiles/reviews?job_id=12345&language=en' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/reviews"
params = {
    "job_id": "12345",
    "language": "en"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Reviews page number

With page parameter you can specify the page number of the reviews on a specific site.

curl GET 'https://app.datashake.com/api/v2/profiles/reviews?job_id=12345&page=7' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/reviews"
params = {
    "job_id": "12345",
    "page": 7
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Reviews per page

With this parameter you can specify how many reviews you would like to retrieve per page.

Default value is set to 20, maximum supported value is 500.

curl GET 'https://app.datashake.com/api/v2/profiles/reviews?job_id=12345&per_page=300' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/reviews"
params = {
    "job_id": "12345",
    "per_page": 300
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Review responses

Set this value to true in case you would also like to receive responses to the reviews.

curl GET 'https://app.datashake.com/api/v2/profiles/reviews?job_id=12345&allow_response=true' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/reviews"
params = {
    "job_id": "12345",
    "allow_response: True
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Response

API response is a JSON object containing these keys:

KEY DATATYPE DESCRIPTION
success boolean Outcome of the task
status integer HTTP status code
meta_data JSON encoded string | null Review's meta data
unique_id string | null Review's unique ID (reported by the review site)
review_count integer | null Total number of reviews reported by the site
average_rating float | null Average review rating reported by the site
last_crawl string | null Last crawling date
crawl_status string Crawling status
percentage_complete float | null Number of reviews saved divided by total reviews available
result_count integer | null The total number of reviews saved
reviews list of JSONs Reviews

Reviews

Those are the scraped reviews. It's a JSON structure containing these keys:

KEY DATATYPE DESCRIPTION
id string Review's unique ID (from our database)
name string Reviewer's name
date string Date of posting the review in ISO 8601 format
rating_value integer Reviewer's rating (stars)
review_text string Review content
url string | null URL to the review
profile_picture string | null Reviewer's profile picture
location string Location the review belongs to
review_title string | null Review's title
verified_order boolean Verified order status
language_code string Language of the review (alpha2 format)
reviewer_title string | null Reviewer's title
unique_id string | null Review's unique ID (reported by the review site)
meta_data JSON encoded string | null Any available meta data for the review
curl GET 'https://app.datashake.com/api/v2/profiles/reviews?job_id=112233' -H 'spiderman-token: 1234567890'
{
    "success": true,
    "status": 200,
    "meta_data": "{\"star_ratings\"=>{\"1star\"=>\"0%\", \"2star\"=>\"2%\", \"3star\"=>\"3%\", \"4star\"=>\"18%\", \"5star\"=>\"77%\"}}",
    "unique_id": null,
    "review_count": 91,
    "average_rating": 4.6,
    "last_crawl": "2021-01-16",
    "crawl_status": "complete",
    "percentage_complete": 100,
    "result_count": 3,
    "reviews": [
        {
            "id": 56868,
            "name": "Mahmoud M. Abdel-Fattah",
            "date": "2018-12-03",
            "rating_value": 4,
            "review_text": "The book is good but repetitive, and it'll be great if there is a summary (tasks/todo list) with the output.",
            "url": "https://www.amazon.com/gp/customer-reviews/R2NFQ2VFAIGZ3G/ref=cm_cr_arp_d_rvw_ttl?ie=UTF8&ASIN=B003YH9MMI",
            "profile_picture": null,
            "location": null,
            "review_title": "I highly recommend it but it is repittive",
            "verified_order": true,
            "language_code": "en",
            "reviewer_title": null,
            "unique_id": "R2NFQ2VFAIGZ3G",
            "meta_data": null
        }
    ]
}
{
    "success": false,
    "status": 400,
    "message": "This job ID doesn't exist, please create it"
}