The Activities Status API allows you to get information about whether or not an Activity is currently running.
API Entry points
/api/collections/collection/activities/id/status: get the status of an activity.
Get the Current Status of an Activity
GET /api/collection/collection/activities/id/status
Input
Path Parameters
| Key | Description |
|---|---|
| collection | The collection name. |
| id | The activity ID. Use 'all' for all activities. |
Query Parameters
None
Input Content
None
Output
Output Content
| Key | Type | Description |
|---|---|---|
| id | int | The activity ID. |
| running | boolean | True indicates the activity is currently running. |
| type | string | The activity type. Possible types are click, autocomplete, or optimize. |
Examples
Input
curl 'http://localhost:8888/api/collections/collection1/activities/2/status'
Output
While the activity is running:
{
"id" : 2,
"running" : true,
"type" : "optimize"
}
Once process is finished, and the activity is idle:
{
"id" : 2,
"running" : false,
"type" : "optimize"
}
