Skip to content

Get job status

Retrieve information about the current status of your job.

Base URL

GET https://app.datashake.com/api/v2/local_naps/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 /local_naps endpoint.

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

url = "https://app.datashake.com/api/v2/local_naps/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
job_id integer Job identification
state string Job's current state
company_name string Given company name
phone_number* string Given company phone number
post_code* string Given company post code
competitor* boolean Fetch data on company competitor

*

You will receive these values only if you provided them when creating the job_id.

Job states

The state 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 local NAP audit - our team is automatically notified for investigation
  • invalid_company - The company you provided is invalid
curl GET --url 'https://app.datashake.com/api/v2/local_naps/info?job_id=92222' --header 'spiderman-token: 1234567890'
{
    "success": true,
    "status": 200,
    "job_id": 92222,
    "company_name": "Brooklyn Burgers & Beers",
    "phone_number": "718-788-1458",
    "post_code": "11215",
    "state": "complete"
}
{
    "success": false,
    "status": 400,
    "message": "This job ID doesn't exist, please create it"
}