Lists all currently scheduled events for a particular project identified by the given API key.
Request Fields
These are passed in at the top level of the request.
Key | Type | Description |
---|---|---|
uid | string | Scheduled Event UID |
Request Example
{
"api_key": "__PROJECT_API__KEY__",
"uid": "__UID__"
}
Response 200 OK
If successful the following structure is returned:
{
"response": {
"status": "ok",
"uid": "__UID__"
},
"data": {
"scheduled_event_instances": [
{
"uid": "bd2bd9ea-20d9-4233-9a7a-7a37e148c535",
"status": "succeeded",
"completed_at": "2018-12-18T13:30:00-05:00",
"content": "..."
},
{
"uid": "8f730ebf-fd68-4491-96a5-dc639f065b23",
"status": "succeeded",
"completed_at": "2018-12-18T13:35:00-05:00",
"content": "..."
},
{
"uid": "daa02a32-736b-47db-aa76-54507e8bcb99",
"status": "succeeded",
"completed_at": "2018-12-18T13:55:00-05:00",
"content": "..."
}
]
}
}
Each instance has a status
field which ends up in the following state:
succeded
if the instance was successfully ingested.failed
if the instance was not accepted.retrying
if the instance is scheduled for retry.cancelled
if the instance was cancelled before it could run.