Lists all currently scheduled events for a particular project identified by the given API key.
Request Fields
These are passed in as arguments at the top level of the request.
| Key | Type | Description |
|---|---|---|
| page | integer Optional |
Page of results to retrieve. Default: 1 |
| per_page | integer Optional |
How many results to return per page. Default: 250 |
Request Example
{
"api_key" : "__PROJECT_API__KEY__"
}Response 200 OK
For a successful request the response comes in the following form:
{
"response": {
"status": "ok"
},
"data": {
"scheduled_events": [
{
"uid": "__UID__",
"status": "activated",
"schedule": "every 5 mins",
"event_type": "repeatable",
"scheduled_at": "2018-12-18T19:20:00+00:00",
"metadata": "..."
},
{
"uid": "__UID__",
"status": "activated",
"schedule": "every 5 hours",
"event_type": "repeatable",
"scheduled_at": "2018-12-18T19:20:00+00:00",
"metadata": "..."
}
]
}
}Where status is one of:
activatedmeaning the event is running.suspendwhere the event is temporarily supended.