Skip to main content
All analytics endpoints require admin authentication.

​
Get System Metrics

Fetch current system-wide metrics. 
curl -X GET https://api.stellarstack.io/analytics/system-metrics \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

​
totalServers
number
Total number of servers
​
totalUsers
number
Total number of users
​
activeConnections
number
Active WebSocket connections
​
averageCpuUsage
number
Average CPU usage percentage across all nodes
​
averageMemoryUsage
number
Average memory usage percentage
​
averageDiskUsage
number
Average disk usage percentage
​
uptime
number
API uptime in seconds
​
totalNodes
number
Total number of nodes
​
healthyNodes
number
Number of healthy nodes (heartbeat within last 5 minutes)

​
Get Node Metrics

Fetch node health and resource metrics. 
curl -X GET https://api.stellarstack.io/analytics/node-metrics \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

Returns an array of node metric objects.
​
nodeId
string
Node ID
​
nodeName
string
Node display name
​
status
string
Node status: “online” or “offline”
​
cpuUsage
number
CPU usage percentage (0-100)
​
memoryUsage
number
Memory used in bytes
​
memoryLimit
number
Total memory in bytes
​
diskUsage
number
Disk used in bytes
​
diskLimit
number
Total disk in bytes
​
activeContainers
number
Number of running containers
​
totalContainers
number
Total containers on node
​
lastHeartbeat
number
Unix timestamp of last heartbeat
​
uptime
number
Node uptime in seconds

​
Get Server Metrics

Fetch server resource metrics, optionally filtered by node. 
curl -X GET "https://api.stellarstack.io/analytics/server-metrics?nodeId=node-id" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Query Parameters

​
nodeId
string
Filter servers by node ID

​
Response

Returns an array of server metric objects (limited to 50 servers).
​
serverId
string
Server ID
​
serverName
string
Server name
​
status
string
Server status: “running”, “stopped”, “installing”, “suspended”, “error”
​
cpuUsage
number
CPU usage percentage
​
memoryUsage
number
Memory used in bytes
​
memoryLimit
number
Memory limit in bytes
​
diskUsage
number
Disk used in bytes
​
diskLimit
number
Disk limit in bytes
​
players
number
Number of connected players (game servers only)
​
fps
number
Frames per second (game servers only)
​
tps
number
Ticks per second (Minecraft servers only)
​
uptime
number
Server uptime in seconds
​
lastUpdate
number
Unix timestamp of last metrics update

​
Get CPU Time Series

Fetch CPU usage time series data. 
curl -X GET "https://api.stellarstack.io/analytics/cpu-series?timeRange=7d" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Query Parameters

​
timeRange
string
default:"7d"
Time range: “24h”, “7d”, “30d”, “90d”, “1y”

​
Response

​
dataPoints
array
Time series data points
​
average
number
Average CPU usage across all data points
​
min
number
Minimum CPU usage
​
max
number
Maximum CPU usage
​
peak
number
Peak CPU usage (same as max)

​
Get Memory Time Series

Fetch memory usage time series data. 
curl -X GET "https://api.stellarstack.io/analytics/memory-series?timeRange=7d" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Query Parameters

​
timeRange
string
default:"7d"
Time range: “24h”, “7d”, “30d”, “90d”, “1y”

​
Response

Same format as CPU time series, with memory usage percentages.

​
Get Disk Time Series

Fetch disk usage time series data. 
curl -X GET "https://api.stellarstack.io/analytics/disk-series?timeRange=7d" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Query Parameters

​
timeRange
string
default:"7d"
Time range: “24h”, “7d”, “30d”, “90d”, “1y”

​
Response

Same format as CPU time series, with disk usage percentages.

​
Get Backup Storage Metrics

Fetch backup storage metrics. 
curl -X GET https://api.stellarstack.io/analytics/backup-storage \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

​
totalBackupSize
number
Total backup storage used in bytes
​
backupCount
number
Total number of backups
​
averageBackupSize
number
Average backup size in bytes
​
oldestBackup
number
Unix timestamp of oldest backup
​
newestBackup
number
Unix timestamp of newest backup
​
storageGrowthRate
number
Storage growth rate (calculated from historical data)
​
estimatedCostPerMonth
number
Estimated monthly cost in USD (at $0.02 per GB)

​
Get Blueprint Metrics

Fetch blueprint usage analytics. 
curl -X GET https://api.stellarstack.io/analytics/blueprint-metrics \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

Returns an array of blueprint metric objects.
​
blueprintId
string
Blueprint ID
​
blueprintName
string
Blueprint name
​
usageCount
number
Number of servers using this blueprint
​
activeServers
number
Number of running servers using this blueprint
​
category
string
Blueprint category
​
popularity
number
Popularity metric (same as usageCount)

​
Get API Metrics

Fetch API usage metrics for the last 24 hours. 
curl -X GET https://api.stellarstack.io/analytics/api-metrics \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

​
totalRequests
number
Total API requests in last 24 hours
​
requestsPerSecond
number
Average requests per second
​
averageLatency
number
Average response latency in milliseconds
​
errorRate
number
Error rate percentage (0-100)
​
topEndpoints
array
Top 5 most used endpoints

​
Get Webhook Metrics

Fetch webhook delivery metrics for the last 7 days. 
curl -X GET https://api.stellarstack.io/analytics/webhook-metrics \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

​
totalWebhooks
number
Total number of webhooks configured
​
totalDeliveries
number
Total delivery attempts in last 7 days
​
successRate
number
Success rate as decimal (0.0-1.0)
​
averageDeliveryTime
number
Average delivery time in milliseconds
​
failedDeliveries
number
Number of failed deliveries

​
Get Analytics Dashboard

Fetch complete analytics dashboard data in a single request. 
curl -X GET "https://api.stellarstack.io/analytics/dashboard?timeRange=7d" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Query Parameters

​
timeRange
string
default:"7d"
Time range: “24h”, “7d”, “30d”, “90d”, “1y”

​
Response

​
timeRange
string
Time range used for this data
​
generatedAt
number
Unix timestamp when data was generated
​
systemMetrics
object
System-wide metrics (see Get System Metrics)
​
nodeMetrics
array
Array of node metrics (see Get Node Metrics)
​
serverMetrics
array
Array of server metrics (see Get Server Metrics)
​
userActivityMetrics
array
User activity metrics
​
cpuTimeSeries
object
CPU time series data (see Get CPU Time Series)
​
memoryTimeSeries
object
Memory time series data (see Get Memory Time Series)
​
diskTimeSeries
object
Disk time series data (see Get Disk Time Series)
​
backupStorageMetrics
object
Backup storage metrics (see Get Backup Storage Metrics)
​
blueprintMetrics
array
Blueprint usage metrics (see Get Blueprint Metrics)
​
apiMetrics
object
API usage metrics (see Get API Metrics)
​
webhookMetrics
object
Webhook metrics (see Get Webhook Metrics)

​
Export Analytics

Export analytics data in CSV or JSON format. 
curl -X GET "https://api.stellarstack.io/analytics/export?timeRange=7d&format=csv" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o analytics.csv

​
Query Parameters

​
timeRange
string
default:"7d"
Time range: “24h”, “7d”, “30d”, “90d”, “1y”
​
format
string
default:"json"
Export format: “csv” or “json”

​
Response

CSV Format:
  • Content-Type: text/csv
  • Formatted CSV with sections for system metrics, node metrics, server metrics, backups, blueprints, API, and webhooks
JSON Format:
  • Content-Type: application/json
  • Complete analytics dashboard data (same as Get Analytics Dashboard)
400 Bad Request - Unsupported format
​
error
string
“Unsupported format. Supported formats: csv, json”

Build docs developers (and LLMs) love

Get started for freeTalk to us