@globalleaderboards/sdk - v0.5.0
    Preparing search index...

    Interface ApiInfoResponse

    API info response

    interface ApiInfoResponse {
        name: string;
        version: string;
        apiVersion: string;
        environment: "development" | "staging" | "production";
        timestamp: string;
        endpoints: {
            health: { basic: string; detailed: string };
            public: {
                description: string;
                scores: string;
                leaderboards: string;
                websocket: string;
            };
            dashboard: {
                description: string;
                auth: string;
                accounts: string;
                apps: string;
                leaderboards: string;
                analytics: string;
            };
            admin: {
                description: string;
                auth: string;
                accounts: string;
                apps: string;
                analytics: string;
            };
        };
        documentation: string;
        support: string;
    }
    Index

    Properties

    name: string

    API name

    version: string

    Package version

    apiVersion: string

    API version

    environment: "development" | "staging" | "production"

    Environment

    timestamp: string

    Current timestamp

    endpoints: {
        health: { basic: string; detailed: string };
        public: {
            description: string;
            scores: string;
            leaderboards: string;
            websocket: string;
        };
        dashboard: {
            description: string;
            auth: string;
            accounts: string;
            apps: string;
            leaderboards: string;
            analytics: string;
        };
        admin: {
            description: string;
            auth: string;
            accounts: string;
            apps: string;
            analytics: string;
        };
    }

    Available endpoints

    documentation: string

    Documentation URL

    support: string

    Support email