Skip to content

Add review profile

Add one review profile

Base URL

POST https://app.datashake.com/api/v2/profiles/add

Request parameters

url

string The URL of the profile you want to retrieve reviews from.

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?url=https://www.amazon.com/dp/B003YH9MMI' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "url": "https://www.amazon.com/dp/B003YH9MMI"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
query

string Google search query that shows the Google My Business listing. This parameter can only be used with Google review profiles.

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?query=I-80%20Towing%20%26%20Service%2C%201209%20S%203rd%20St%2C%20Laramie%2C%20WY%2082070%2C%20USA' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "query": "I-80 Towing & Service, 1209 S 3rd St, Laramie, WY 82070, USA"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
place_id

string You can provide the Google Place ID to be more specific about the Google My Business profile you need the reviews from.

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?place_id=ChIJr5dFzfKAhYARj99B34yuZOw' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "place_id": "ChIJr5dFzfKAhYARj99B34yuZOw"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
from_date

string Using this parameter you can retrieve reviews since a specific date.

Required format is YYYY-MM-DD

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?url=url=https://www.amazon.com/dp/B003YH9MMI&from_date=2021-01-01' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "url": "url=https://www.amazon.com/dp/B003YH9MMI",
    "from_date": "2021-01-01"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
blocks

integer This parameter tells us how many reviews you'd like to collect on a website.

If there are 100 reviews on the website and you only want the 50 latest ones, you would use blocks=50

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?place_id=ChIJr5dFzfKAhYARj99B34yuZOw&blocks=50' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "place_id": "ChIJr5dFzfKAhYARj99B34yuZOw",
    "blocks": 50
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
diff

integer If you’re requesting reviews regularly and would like to get the latest reviews only (those you do not have yet), you can pass the previous job_id via the diff parameter, and we will only fetch the reviews you’re missing from your last job. For more information click here.

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?place_id=ChIJr5dFzfKAhYARj99B34yuZOw&diff=1234232' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "place_id": "ChIJr5dFzfKAhYARj99B34yuZOw",
    "diff": 1234232
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
callback

string A callback is a URL where you would like to receive task results once the job is complete.

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?place_id=ChIJr5dFzfKAhYARj99B34yuZOw&callback=https://app.reviewcompany.com/datashake_callback' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "place_id": "ChIJr5dFzfKAhYARj99B34yuZOw",
    "callback": "https://app.reviewcompany.com/datashake_callback"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
external_identifier

string If you would like to identify the jobs yourself, you can use external identifier. This value will always be included in our callback payload.

The value cannot exceed 255 characters.

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add?place_id=ChIJr5dFzfKAhYARj99B34yuZOw&external_identifier=qwerty123' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/add"
params = {
    "place_id": "ChIJr5dFzfKAhYARj99B34yuZOw",
    "external_identifier": "qwerty123"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Rules and restrictions

To perform the task, we need at least one of these parameters: url, query or place_id

Response

API Response example
{
    "success": true,
    "job_id": 1234232,
    "status": 200,
    "message": "Added this profile to the queue..."
}

Add review profiles in bulk

Base URL

POST https://app.datashake.com/api/v2/profiles/add_bulk

Request parameters

You can add more review profiles at once. Instead of using request parameters, create a list of JSON objects containing the same information as you would provide when adding profiles one by one and then pass this list as a POST payload.

Code example
curl POST 'https://app.datashake.com/api/v2/profiles/add_bulk'
-H 'spiderman-token: 1234567890'
-H 'Content-Type: application/json'
--data-raw '[
    {"url": "https://www.homeaway.com/vacation-rental/p4494671", "callback": "https://app.reviewcompany.com/datashake_callback", "from_date": "2021-01-01"},
    {"query": "I-80 Towing & Service, 1209 S 3rd St, Laramie, WY 82070, USA", "callback": "https://app.reviewcompany.com/datashake_callback", "blocks":"10"}
]'
import requests

url = "https://app.datashake.com/api/v2/profiles/add_bulk"
payload = [
    {
        "url": "https://www.homeaway.com/vacation-rental/p4494671",
        "callback": "https://app.reviewcompany.com/datashake_callback",
        "from_date": "2021-01-01"
    },
    {
        "query": "I-80 Towing & Service, 1209 S 3rd St, Laramie, WY 82070, USA",
        "blocks": 10,
        "callback": "https://app.reviewcompany.com/datashake_callback"
    }
]

headers = {
    "spiderman-token": "1234567890",
    "content-type": "application/json"
}
response = requests.post(
    url=url,
    json=payload,
    headers=headers
}
coming soon
coming soon
coming soon

Response

API Response example
[
    {
        "url": "https://www.homeaway.com/vacation-rental/p4494671",
        "callback": "https://app.reviewcompany.com/Datashake_callback",
        "from_date": "2021-01-01",
        "success": true,
        "job_id": 4807,
        "status": 200,
        "message": "Added this profile to the queue..."
    },
    {
        "query": "I-80 Towing & Service, 1209 S 3rd St, Laramie, WY 82070, USA",
        "callback": "https://app.reviewcompany.com/Datashake_callback",
        "blocks": "10",
        "success": true,
        "job_id": 4808,
        "status": 200,
        "message": "Added this profile to the queue..."
    },
    ...
]