For the complete documentation index, see llms.txt. This page is also available as Markdown.

Error Log

get

API view for logging errors.

Args: request: The HTTP request object.

Returns: CustomResponse: The response object containing formatted error logs.

Raises: IOError: If there is an error reading the error log file.

Examples: >>> logger_api = LoggerAPI() >>> response = logger_api.get(request)

Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Responses
200

No response body

No content

get/api/v1/dashboard/error-log/
GET /api/v1/dashboard/error-log/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

patch

API view for logging errors.

Args: request: The HTTP request object.

Returns: CustomResponse: The response object containing formatted error logs.

Raises: IOError: If there is an error reading the error log file.

Examples: >>> logger_api = LoggerAPI() >>> response = logger_api.get(request)

Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Responses
200

No response body

No content

patch/api/v1/dashboard/error-log/
PATCH /api/v1/dashboard/error-log/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

get
Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Path parameters
log_namestringRequired
Responses
200

No response body

No content

get/api/v1/dashboard/error-log/{log_name}/
GET /api/v1/dashboard/error-log/{log_name}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

post
Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Path parameters
log_namestringRequired
Responses
200

No response body

No content

post/api/v1/dashboard/error-log/clear/{log_name}/
POST /api/v1/dashboard/error-log/clear/{log_name}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

get

A class representing the ErrorGraphAPI view.

This view handles the GET request to retrieve formatted error data including a heatmap of URL hits, incident information, and affected users. It requires authentication and specific roles to access.

Args: self: The instance of the class itself.

Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Responses
200

No response body

No content

get/api/v1/dashboard/error-log/graph/
GET /api/v1/dashboard/error-log/graph/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

get

API view for logging errors.

Args: request: The HTTP request object.

Returns: CustomResponse: The response object containing formatted error logs.

Raises: IOError: If there is an error reading the error log file.

Examples: >>> logger_api = LoggerAPI() >>> response = logger_api.get(request)

Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Path parameters
error_idstringRequired
Responses
200

No response body

No content

get/api/v1/dashboard/error-log/patch/{error_id}/
GET /api/v1/dashboard/error-log/patch/{error_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

patch

API view for logging errors.

Args: request: The HTTP request object.

Returns: CustomResponse: The response object containing formatted error logs.

Raises: IOError: If there is an error reading the error log file.

Examples: >>> logger_api = LoggerAPI() >>> response = logger_api.get(request)

Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Path parameters
error_idstringRequired
Responses
200

No response body

No content

patch/api/v1/dashboard/error-log/patch/{error_id}/
PATCH /api/v1/dashboard/error-log/patch/{error_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

get

A class representing the ErrorTabAPI view.

This view handles the GET request to retrieve grouped URL patterns based on user roles. It requires authentication and specific roles to access.

Args: self: The instance of the class itself.

Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Responses
200

No response body

No content

get/api/v1/dashboard/error-log/tab/
GET /api/v1/dashboard/error-log/tab/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

get
Authorizations
AuthorizationstringOptional

JWT Token Authentication. Enter "Bearer "

Path parameters
log_namestringRequired
Responses
200

No response body

No content

get/api/v1/dashboard/error-log/view/{log_name}/
GET /api/v1/dashboard/error-log/view/{log_name}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Last updated

Was this helpful?