Get schedules

List Schedules

Base URL

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

Request parameters

service

string Parameter used to filter by service. Can be rsapi or riapi. Optional.

Code example

curlpythonrubyjavascriptphp

curl --location 'https://schedulingapi.datashake.com/schedules' \
--header 'x-api-key: 1234567890'

import requests

url = "https://schedulingapi.datashake.com/schedules"
params = {
    "service": "riapi"
}
headers= {
    "x-api-key": "1234567890"
}
response = requests.get(
    url=url,
    params=params,
    headers=headers
)

coming soon

coming soon

coming soon

Response

API Response example

{
    "status": "success",
    "results": [
        {
            "frequency": "daily",
            "endpoint": "https://reviewindexapi.datashake.com/profiles",
            "schedule_id": 2,
            "schedule_name": "Conrad Bengaluru Schedule",
            "service": "riapi",
            "payload": {
                "body": {},
                "headers": {},
                "query_params": {
                    "name": "Conrad Bengaluru",
                    "city": "Bangalore",
                    "zip_code": "560008",
                    "callback": "https://www.example.com/callback",
                }
            },
            "disabled": false,
            "last_successful_run": "2023-08-25T10:40:00"
        },
        {
            "frequency": "weekly",
            "endpoint": "https://reviewindexapi.datashake.com/profiles",
            "schedule_id": 3,
            "schedule_name": "Ippudo Job #1",
            "service": "riapi",
            "payload": {
                "body": {},
                "headers": {},
                "query_params": {
                    "name": "Ippudo",
                    "address": "New York",
                    "callback": "https://www.example.com/callback"
                }
            },
            "disabled": false,
            "last_successful_run": "2023-08-25T13:26:40"
        }
    ]
}

Get Schedule

Base URL

GET https://schedulingapi.datashake.com/schedules/:schedule_id

Make sure to replace :schedule_id with the actual Schedule ID.

Response

API Response example

{
    "status": "success",
    "results": [
        {
            "frequency": "weekly",
            "endpoint": "https://reviewindexapi.datashake.com/profiles",
            "schedule_id": 3,
            "schedule_name": "Ippudo Job #1",
            "service": "riapi",
            "payload": {
                "body": {},
                "headers": {},
                "query_params": {
                    "name": "Ippudo",
                    "address": "New York",
                    "callback": "https://www.example.com/callback"
                }
            },
            "disabled": false,
            "last_request_id": "1694635207488650442-b29cf7e4-0363-49"
            "last_successful_request_id": null,
            "last_successful_run": "2023-08-25T13:26:40"
        }
    ]
}