Skip to main content
GET
Metrics

Metrics API

Get peak metrics for a service or submit new metrics data.

GET /api/metrics

Retrieve peak metrics (24-hour and all-time) for a specific service.

Query Parameters

string
required
The service slug to get metrics for

Response

number
Peak online count in the last 24 hours
number
All-time peak online count

Example Request

Example Response


POST /api/metrics

Submit metrics data for a service. Used by service integrations to report online counts.

Request Body

string
required
Service identifier (1-64 alphanumeric characters, hyphens, underscores)
number
Current online player count (0 to 1,000,000)
boolean
Whether the service check was successful

Example Request

Response

Error Responses