Dashboard

Get alert triggers within start and end date

Returns alert triggers within start and end date

SecurityapiKey

Request

path Parameters

enterprise_id

required

string

A UUID string identifying this enterprise.

query Parameters

start_date	string <date-time> Start date of alert triggers
end_date	string <date-time> End date of alert triggers

Responses

200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/dashboard/alert-panel/

Response samples

application/json

{"total": 0,
"results": [{"name": "string",
"alarm_id": "50344303-c5be-4cb8-8f20-e7a6c6bdaa39",
"trigger_count": "string",
"latest_trigger_timestamp": "2019-08-24T14:15:22Z"
}
]
}

Get latest pipeline runs for an enterprise

Returns latest pipeline runs for an enterprise

SecurityapiKey

Request

path Parameters

enterprise_id

required

string

A UUID string identifying this enterprise.

query Parameters

limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/dashboard/pipeline-panel/

Response samples

application/json

{"count": 0,
"next": "string",
"previous": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"run_count": 0,
"state": "string",
"status": "string",
"client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
"reason": "string",
"name": "string",
"meta": {"started_by": {"user_id": 0,
"username": "string",
"started_at": "2019-08-24T14:15:22Z"
}
},
"started_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"job_count": 0,
"job_name": "string",
"pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",
"pipeline_name": "string",
"stages": "string"
}
]
}

Gets data from provisioned device panel

Returns data from provisioned device panel

SecurityapiKey

Request

path Parameters

enterprise_id

required

string

A UUID string identifying this enterprise.

Responses

200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/dashboard/provisioned-device-panel/

Response samples

application/json

{"total": 0,
"results": {"es_data": {"timestamp": "2019-08-24T14:15:22Z"
}
}
}

Gets list of all locations on dashboard

Returns list of locations with corresponding information

SecurityapiKey

Responses

200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/dashboard/location/

Response samples

application/json

{"locations": [{"city": "string",
"count": 0,
"location": {"latitude": 0,
"longitude": 0
}
}
]
}

➔ Next to Report