View .md

System endpoints (Admin API)

3 FeatherPanel Admin API endpoints from admin/kpi/system.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/admin/kpi/system.php. Authentication used here: Admin. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

Endpoints

GET/api/admin/analytics/mail-queue/stats

Auth: AdminPermission: admin.dashboard.viewRoute name: admin-analytics-mail-queue-statsController: SystemController::getMailQueueStatsroute source

Get mail queue statistics Retrieve statistics about mail queue.

curl -X GET "$PANEL_URL/api/admin/analytics/mail-queue/stats" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Mail queue stats retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/system/feature-adoption

Auth: AdminPermission: admin.dashboard.viewRoute name: admin-analytics-system-feature-adoptionController: SystemController::getFeatureAdoptionStatsroute source

Get feature adoption statistics Retrieve adoption metrics for chatbot, API clients, OAuth2, and OIDC features.

curl -X GET "$PANEL_URL/api/admin/analytics/system/feature-adoption" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Feature adoption stats retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/system/dashboard

Auth: AdminPermission: admin.dashboard.viewRoute name: admin-analytics-system-dashboardController: SystemController::getDashboardroute source

Get comprehensive system analytics dashboard Retrieve all system analytics data.

curl -X GET "$PANEL_URL/api/admin/analytics/system/dashboard" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 System dashboard retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions