Skip to content

Basic usage

Base URL

Review Index API has a single API endpoint that accepts GET method.

GET https://app.datashake.com/api/v2/review_index/

Request parameters

KEY DATATYPE REQUIRED DESCRIPTION
domain string no* Company domain
company_name string no* Name of the company
ticker_symbol string no* Company's ticker symbol
site string no Reviews source website
from_date string no Reviews time range
to_date string no Reviews time range
product_name string no* Pick specific product only
page integer no Page number to fetch
per_page integer no Number of reviews per page
update boolean no Update reviews
timeseries boolean no Time series data

*

In order to perform the task, we need you to provide at least one of these parameters:

  • domain, company_name, ticker_symbol, product_name

Company domain

The domain parameter tells us which domain you would like look up for reviews.

curl -H 'spiderman-token: [YOUR_TOKEN]' 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Company name

We strongly recommend passing parameter with company name. It improves the profile matching and help us deliver the best results. 💥

curl 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com&company_name=Slack'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com",
    "company_name": "Slack"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Ticker symbol

Company's ticker symbol. You can use this search to find it.

curl 'GET https://app.datashake.com/api/v2/review_index?domain=microsoft.com&ticker_symbol=MSFT'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "microsoft.com",
    "ticker_symbol": "MSFT"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Reviews Site

We're currently indexing reviews from:

You can use this parameter if you wish to get reviews from a specific reviews website.

Website support

In case you're interested in a website that we currently do not support, feel free to reach out.

curl 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com&site=g2'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com",
    "site": "g2"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Reviews time range

Using parameters from_date and to_date you can select a specific time range for which you need your reviews to be collected.

The value should be a valid ISO formatted date. Examples:

  • yyyy-mm-dd
  • yyyy-mm-ddThh:mm:ss
curl 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com&from_date=2021-03-25'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com",
    "from_date": "2021-03-25"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Product name

If you're interested in reviews for a specific product only, you can use product_name parameter for that.

curl 'GET https://app.datashake.com/api/v2/review_index?domain=microsoft.com&product_name=azure'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "microsoft.com",
    "product_name": "azure"
}
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 pagination number for the reviews on a specific site.

curl 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com&site=g2&page=2'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com",
    "site": "g2",
    "page": 2
}
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.

Limitation

Default value is 50 and maximum is 500.

curl 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com&per_page=100'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com",
    "page": 100
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Update reviews

When this parameter is used, we immediately start crawling latest reviews for the given company. It is a little bit time consuming process and usually takes a few minutes to accomplish.

curl 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com&update=true'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com",
    "update": True
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Time series data

When this parameter is used, our response contains time series data showing volume and average rating of reviews per day.

curl 'GET https://app.datashake.com/api/v2/review_index?domain=slack.com&timeseries=true'
import requests

url = "https://app.datashake.com/api/v2/review_index"
params = {
    "domain": "slack.com",
    "timeseries": True
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon