Reports & Audit
Access system logs and uptime metrics for security and compliance.
Audit Trail
Retrieve system logs including user actions and timestamps.
HTTP Method & URL: GET /api/admin/AuditTrail
Authorization: Requires X-API-KEY
Request
- Headers
- Query Parameters
- cURL
| Name | Value | Required | Description |
|---|---|---|---|
X-API-KEY | string | Yes | Your unique API key. |
pageNumber: (Int) Page number to retrieve.pageSize: (Int) Number of records per page.
curl -X GET "https://stg.itechops.com/api/admin/AuditTrail?pageNumber=1&pageSize=5" \
-H "X-API-KEY: your_api_key_here"
Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 500 Server Error
Description: Success. Returns a paginated list of audit entries.
Response Body: ApiResponse<PaginationModel<AuditTrailModel>>
{
"Success": true,
"Result": {
"Data": [
{
"AuditId": "3fa85f64-5717-4562-b3fc-2c963f66afd1",
"ActionType": "Update",
"ActionMassage": "Updated component status",
"PerformedBy": "admin@example.com",
"Timestamp": "2023-10-25T14:30:00Z"
}
],
"TotalRecords": 150,
"TotalPages": 30
}
}
Description: Invalid query parameters.
{
"Success": false,
"Result": null,
"Message": "Invalid PageNumber."
}
Description: Authentication failed.
{
"Success": false,
"Result": null,
"Message": "Invalid or missing API key."
}
Description: Internal server error.
{
"Success": false,
"Result": null,
"Message": "An unexpected error occurred."
}
Uptime Reports
Retrieve monthly uptime statistics for your components.
HTTP Method & URL: GET /api/admin/Reports/GetMonthlyUptimeReports
Request
- Headers
- cURL
| Name | Value | Required | Description |
|---|---|---|---|
X-API-KEY | string | Yes | Your unique API key. |
curl -X GET "https://stg.itechops.com/api/admin/Reports/GetMonthlyUptimeReports" \
-H "X-API-KEY: your_api_key_here"
Responses
- 200 OK
- 401 Unauthorized
- 500 Server Error
Description: Success. Returns monthly uptime percentages.
[
{
"Month": "October",
"Year": 2023,
"UptimePercentage": 99.98,
"IncidentCount": 2
}
]
Description: Authentication failed.
{
"Success": false,
"Result": null,
"Message": "Invalid or missing API key."
}
Description: Internal server error.
{
"Success": false,
"Result": null,
"Message": "An unexpected error occurred."
}