Skip to content

Get jobs

This endpoint retrieves a list of all your review profile jobs.

Base URL

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

Request parameters

KEY DATATYPE REQUIRED DESCRIPTION
from_created_at string [YYYY-MM-DD] no Return jobs created on or after the date.
crawl_status string no Only retrieve jobs with specific crawling status
per_page integer no Number of jobs to return page. Default is 20
page integer no The page of the per_page task. Default is 1

Response

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

KEY DATATYPE DESCRIPTION
job_id string The job ID assigned to a review profile
url string | null URL of the review profile
place_id string | null Google place id of the review profile
status string Current crawling status
last_crawl string | null Last crawling date
from_date string | null Oldest review time stamp
blocks integer | null blocks parameter used to create the review profile
diff string | null diff parameter used to create the review profile
credits_used integer Amount of credits used for the job
created_at string The date of the job creation
result_count integer | null The total number of reviews saved
curl GET 'https://app.datashake.com/api/v2/profiles/jobs' -H 'spiderman-token: 1234567890'
[
    {
        "job_id": 233412312,
        "url": "https://www.amazon.com/dp/B003YH9MMI",
        "crawl_status": "maintenance",
        "last_crawl": null,
        "from_date": "2018-01-01",
        "blocks": null,
        "credits_used": 22
    },
    {
        "job_id": 2366454234,
        "url": "https://www.amazon.com/dp/B003YH9MMI",
        "crawl_status": "maintenance",
        "last_crawl": null,
        "from_date": "2018-01-01",
        "blocks": null,
        "credits_used": 5
    }
]

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

Our response is a JSON object containing these keys:

KEY DATATYPE DESCRIPTION
job_id string The job ID assigned to a review profile
url string | null URL of the review profile
status string Current crawling status
last_crawl string | null Last crawling date
from_date string | null Oldest review time stamp
credits_used integer Amount of credits used for the job
curl GET 'https://app.datashake.com/api/v2/profiles/jobs/1234' -H 'spiderman-token: 1234567890'
{
    "job_id": 1234,
    "url": "https://www.amazon.com/dp/B003YH9MMI",
    "crawl_status": "maintenance",
    "date": null,
    "from_date": "2018-01-01",
    "blocks": null,
    "credits_used": 22
}