Statly

Documentation

Learn how to integrate Statly with your game servers.
This guide covers all available API endpoints and how to use them effectively.

Quick Start

  1. 1Get your API token
    After signing up, navigate to your dashboard to generate an API token for your server.
  2. 2Integrate with your server
    Use our REST API to send pulses from your game server.
    Each pulse contains metrics like TPS, player count, memory usage and custom events.
  3. 3Monitor in real-time
    View your server metrics and events in the Statly dashboard with real-time updates.

Authentication

    All API requests require authentication using a token.
    Include your API token in the Token header.

    Token: your_api_token_here

    You can generate and manage your API tokens from the dashboard. Keep your tokens secure and never share them publicly.

Rate Limiting

    To ensure fair usage and maintain service quality, Statly implements rate limiting on all API endpoints.
    When you exceed the rate limit, you will receive a 429 response.

    Token: your_api_token_here

    You can generate and manage your API tokens from the dashboard. Keep your tokens secure and never share them publicly.

Ingestion

Endpoints for sending server metrics and events to Statly.

Event Types

Detailed schemas for each event type that can be sent in the 'events' array of a pulse.