Skip to content

Get all your submitted jobs

Get multiple jobs

Base URL

GET https://app.datashake.com/api/v2/profiles/jobs

Request parameters

from_created_at

string Return jobs created on or after the date.

Required format is YYYY-MM-DD

Code example
curl GET 'https://app.datashake.com/api/v2/profiles/jobs?from_created_at=2022-01-01' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/profiles/jobs"
params = {
    "from_created_at": "2022-01-01",
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon
crawl_status

string Only retrieve jobs with specific crawling status.

Code example
curl GET 'https://app.datashake.com/api/v2/profiles/jobs?crawl_status=pending' -H 'spiderman-token: 1234567890'
import requests

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

integer The page of the jobs list.

The default value is set to 1.

Code example
curl GET 'https://app.datashake.com/api/v2/profiles/jobs?page=7' -H 'spiderman-token: 1234567890'
import requests

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

integer The number of jobs to return page.

Default value is set to 20, maximum supported value is 500.

Code example
curl GET 'https://app.datashake.com/api/v2/profiles/jobs?per_page=300' -H 'spiderman-token: 1234567890'
import requests

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

Response

API Response example
[
    {
    "success": true,
    "job_id": 12346,
    "url": "https://www.itcentralstation.com/products/amazon-aws-reviews",
    "status": "complete",
    "last_crawl": "2022-03-19",
    "from_date": null,
    "credits_used": 156
    },
    {
    "success": true,
    "job_id": 12345,
    "url": "https://www.itcentralstation.com/products/microsoft-azure",
    "status": "complete",
    "last_crawl": "2022-03-18",
    "from_date": null,
    "credits_used": 201
    },
    ...
]

Get one specific job

Base URL

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

Response

API Response example
{
    "success": true,
    "job_id": 12345,
    "url": "https://www.itcentralstation.com/products/microsoft-azure",
    "status": "complete",
    "last_crawl": "2022-03-18",
    "from_date": null,
    "credits_used": 201
}