Skip to content

Create schedule

Base URL

POST https://schedulingapi.datashake.com/schedules

Request parameters

service *

string The service you want to create a schedule for. Can be rsapi or riapi.

Code example 
curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}'

import requests

url = "https://schedulingapi.datashake.com/schedules"
body = {
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon
endpoint *

string The endpoint you want to create a schedule for.

If the service for your new schedule is rsapi, choices are: add and add_bulk. For more info, please refer to Review Scraper API docs.

For riapi, the options are: profiles and reviews. For more info, please refer to Review Index API docs

Code example 
curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}'

import requests

url = "https://schedulingapi.datashake.com/schedules"
body = {
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon
frequency *

string Defines how often you want to run the job. Can be daily, weekly, or monthly.

Code example 
curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}'

import requests

url = "https://schedulingapi.datashake.com/schedules"
body = {
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon
schedule_name

string Name for the schedule. Optional.

Code example 
curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}'

import requests

url = "https://schedulingapi.datashake.com/schedules"
body = {
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon
headers

object Headers to be sent to the target endpoint. Optional.

Code example 
curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "endpoint": "add",
    "frequency": "daily",
    "service": "rsapi",
    "schedule_name": "Statue of Liberty NYC Job",
    "query_params": {
        "query": "Statue of Liberty NYC",
        "callback": "https://www.example.com/callback"
    }
}'

import requests

url = "https://schedulingapi.datashake.com/schedules"
body = {
    "endpoint": "add",
    "frequency": "daily",
    "service": "rsapi",
    "schedule_name": "Statue of Liberty NYC Job",
    "query_params": {
        "query": "Statue of Liberty NYC",
        "callback": "https://www.example.com/callback"
    }
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon
query_params

object Query parameters to be sent to the target endpoint. Optional.

Code example 
curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}'

import requests

url = "https://schedulingapi.datashake.com/schedules"
body = {
    "endpoint": "profiles",
    "frequency": "daily",
    "service": "riapi",
    "schedule_name": "Conrad Bengaluru Schedule",
    "query_params": {
        "name": "Conrad Bengaluru",
        "city": "Bangalore",
        "zip_code": "560008",
        "callback": "https://www.example.com/callback"
    }
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon
body

object Body to be sent to the target endpoint. Optional.

Code example 
curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "endpoint": "add_bulk",
    "frequency": "daily",
    "service": "rsapi",
    "schedule_name": "Sample Schedule",
    "body": [
        {
            "url": "https://www.airbnb.com/rooms/18553190",
            "callback": "https://example.com/callback"
        },
        {
            "url": "https://www.aliexpress.com/item/2251832570993631.html",
            "callback": "https://example.com/callback"
        }
    ]
}'

import requests

url = "https://schedulingapi.datashake.com/schedules"
body = {
    "endpoint": "add_bulk",
    "frequency": "daily",
    "service": "rsapi",
    "schedule_name": "Sample Schedule",
    "body": [
        {
            "url": "https://www.airbnb.com/rooms/18553190",
            "callback": "https://example.com/callback"
        },
        {
            "url": "https://www.aliexpress.com/item/2251832570993631.html",
            "callback": "https://example.com/callback"
        }
    ],
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon

Rules and restrictions

  • The service, endpoint, and frequency fields are required.
  • Either query_params or body must be submitted.

Notes

  • No need to send spiderman-token for Review Scraper API in headers or api_key for Review Index API in query params.
  • For more information on the query_params and body fields, please refer to your target API docs.

Response

API Response example 
{
    "status": "success",
    "results": [
        {
            "schedule_id": 2,
            "frequency": "daily",
            "service": "riapi",
            "endpoint": "https://reviewindexapi.datashake.com/profiles",
            "schedule_name": "Conrad Bengaluru Schedule",
            "last_successful_run": null,
            "payload": {
                "query_params": {
                    "name": "Conrad Bengaluru",
                    "city": "Bangalore",
                    "zip_code": "560008",
                    "callback": "https://www.example.com/callback",
                },
                "body": {},
                "headers": {}
            },
            "disabled": false,
            "last_request_id": null,
            "last_successful_request_id": null
        }
    ]
}