Skip to content

Get job status

Retrieve information about the current status of your job.

Base URL

GET https://app.datashake.com/api/v2/responds/info

Request parameters

KEY DATATYPE REQUIRED DESCRIPTION
job_id integer yes Job ID of the task to retrieve

Job identification

This value can be found in the response from /add endpoint.

curl GET --url 'https://app.datashake.com/api/v2/responds/info?job_id=123123132' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/responds/info"
params = {
    "job_id": 92222,
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    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
respond JSON Response information

Response information

Information related to your submitted response. It's JSON object containing these keys:

KEY DATATYPE DESCRIPTION
id string The ID of the response from the Datashake database (auto-increments)
username string The username for logging into the review site
profile_url string The URL for the review profile
review_id string Unique review ID
text string Your response
external_identifier string Your response identifier
status string Current job status

Job status

The status returned can be one of the following:

  • pending - The job is still in the queue and is pending completion
  • complete - The job is complete
  • maintenance - There has been an issue with the response - our team is automatically notified for investigation
  • invalid_credentials - The credentials you have provided are invalid
curl GET --url 'https://app.datashake.com/api/v2/responds/info?job_id=12312313' -H 'spiderman-token: 1234567890'
{
    "success": true,
    "status": 200,
    "respond": {
        "id": 12312313,
        "username": "xxx",
        "profile_url": "https://www.yelp.com/biz/naturally-delicious-brooklyn",
        "review_id": "xxx",
        "text": "xxx",
        "status": "pending",
        "external_identifier": 8394
    }
}
{
    "success": false,
    "status": 400,
    "message": "This job ID doesn't exist, please create it"
}