Skip to content

Add response

Use this endpoint to respond to reviews for sites which don't have an API.

Note

This feature is currently available for Yelp and Tripadvisor.

Base URL

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

Request parameters

KEY DATATYPE REQUIRED DESCRIPTION
username string yes The username for logging into the review site
password string yes The password for logging into the review site
profile_url string yes The URL for the review profile
review_id string yes Unique review ID
text string yes Your response
reviewer_name string yes Reviewer's name
review_text string yes Original review text
callback string no URL for callback
external_identifier string no Your response identifier

Tip

We highly recommend that you use the callback functionality instead of polling our servers for results.

Learn more about this functionality in this article: What is the callback functionality?

Review identification

This is a unique identification of the review that you'd like to respond to. It is provided by the review site.

Response text

This is your place to write the response to the original review.

Callback

Callback is a URL where you would like to receive your task results once the job is complete.

You can find detailed information about this functionality here.

External identifier

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

Restriction

The value cannot exceed 255 characters.

curl POST --url https://app.datashake.com/api/v2/responds/add -H 'spiderman-token: 1234567890' --data '{ "username": "my_username", "password": "my_password", "profile_url": "xxx", "review_id": "Qhjhn68b", "text": "Thank you.", "review_text": "xxx", "reviewer_name":"xxx", "callback": "https://app.reviewcompany.com/Datashake_callback", "external_identifier": "qwerty123" }'
import requests

url = "https://app.datashake.com/api/v2/responds/add"
payload = {
    "username": "my_username",
    "password": "my_password",
    "profile_url": "xxx",
    "review_id": "Qhjhn68b",
    "text": "Thank you.",
    "review_text": "xxx",
    "reviewer_name": "xxx",
    "callback": "https://app.reviewcompany.com/Datashake_callback",
    "external_identifier": "qwerty123",
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    payload=payload,
    headers=headers
}
coming soon
coming soon
coming soon

Response

Our response is a JSON object containing these keys:

KEY DATATYPE DESCRIPTION
success boolean Job outcome
status integer HTTP status code
message string Additional information
job_id integer Job identification

Warning

Remember to store the job_id internally, you will need the value to GET the status for the local NAP audit!

curl POST --url https://app.datashake.com/api/v2/responds/add --header 'spiderman-token: 1234567890' --data '{ "username": "xxx", "password": "xxx", "profile_url": "xxx", "review_id": "xxx", "text": "xxx", "review_text": "xxx", "reviewer_name":"xxx", "callback": "https://app.reviewcompany.com/Datashake_callback", "external_identifier": "xxx" }'
{
    "success": true,
    "job_id": 12312313,
    "status": 200,
    "message": "Added response to the queue..."
}
{
    "success": false,
    "status": 400,
    "message": "We do not support www.deliveroo.com yet, please submit it to our feedback forum (https://feedback.reviewshake.com)"
}