Show a specific schedule

GET

/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}

const url = 'https://dashboard.quantcdn.io/api/v2/organizations/example/projects/example/crawlers/example/schedules/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v2/organizations/example/projects/example/crawlers/example/schedules/example \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

organization

required

string

Organization identifier

project

required

string

Project identifier

crawler

required

string

Crawler identifier

crawler_schedule

required

string

Crawler schedule identifier

Responses

200

The crawler schedule.

application/json

object

required

Schedule ID

integer

name

Schedule name

string

crawler_config_id

required

Crawler config ID

integer

crawler_uuid

Crawler UUID

string

project_id

required

Project ID

integer

crawler_last_run_id

required

Last run ID

integer

schedule_cron_string

required

Standard Unix cron expression with 5 space-separated fields: minute, hour, day-of-month, month, day-of-week. Example: 0 2 * * * runs daily at 2 AM.

string

created_at

Creation timestamp

string format: date-time

updated_at

Last update timestamp

string format: date-time

Example

{
  "id": 1,
  "name": "Test schedule",
  "crawler_config_id": 456,
  "crawler_uuid": "550e8400-e29b-41d4-a716-446655440000",
  "project_id": 789,
  "crawler_last_run_id": 12345,
  "schedule_cron_string": "0 2 * * *",
  "created_at": "2024-01-20T09:15:00Z",
  "updated_at": "2024-10-11T16:45:00Z"
}

400

The server could not understand the request due to invalid syntax.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}

403

Access is forbidden.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}