Skip to content

Get jobs

This endpoint retrieves a list of all your response jobs. No parameters are necessary, you just need to provide your API token.

Base URL

GET https://app.datashake.com/api/v2/responds/jobs
curl GET --url 'https://app.datashake.com/api/v2/responds/jobs' -H 'spiderman-token: 1234567890'
import requests

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

Response

Our response is a list of JSON object containing these keys:

KEY DATATYPE DESCRIPTION
job_id string The job_id assigned to the task
profile_url string The URL for the review profile
review_id string Unique review ID
text string Your response
credits_used integer Amount of credits used for this job
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/jobs' -H 'spiderman-token: 1234567890'
[
    {
        "job_id": 1234556789,
        "profile_url": "https://www.yelp.com/biz/naturally-delicious-newyork",
        "review_id": "252A3F4",
        "status": "complete",
        "text": "Great place to eat burgers and fries.",
        "credits_used": 5
    },
    {
        "job_id": 1234356789,
        "profile_url": "https://www.yelp.com/biz/naturally-delicious-brooklyn",
        "review_id": "BB52A3F4",
        "status": "complete",
        "text": "My dad used to take me to this place when I was a kid.",
        "credits_used": 2
    }
]

Get one specific job

Base URL

GET https://app.datashake.com/api/v2/responds/jobs/{job_id}

If you wish to retrieve one specific job, substitute {job_id} with the required job_id. Request parameters are the same as for retrieving all jobs. No more parameters are necessary.

Response

Our response is a JSON object containing these keys:

KEY DATATYPE DESCRIPTION
job_id string The job_id assigned to the task
profile_url string The URL for the review profile
review_id string Unique review ID
text string Your response
credits_used integer Amount of credits used for this job
status string Current job status
curl GET --url 'https://app.datashake.com/api/v2/responds/jobs/1234556789' -H 'spiderman-token: 1234567890'
{
    "job_id": 1234556789,
    "profile_url": "https://www.yelp.com/biz/naturally-delicious-newyork",
    "review_id": "252A3F4",
    "status": "complete",
    "text": "Great place to eat burgers and fries.",
    "credits_used": 5
}