screeps-api
    Preparing search index...

    Interface UserOverviewResponse

    GET /api/user/overview response

    interface UserOverviewResponse {
        ok: 1;
        shards: {
            [shardName: string]: {
                gameTimes: [
                    number,
                    undefined,
                    undefined,
                    undefined,
                    undefined,
                    undefined,
                    undefined,
                    undefined,
                ];
                rooms: string[];
                stats: { [roomName: string]: { endTime: number; value: number }[] };
            };
        };
        statsMax: number;
        totals: {
            creepsLost: number;
            creepsProduced: number;
            energyConstruction: number;
            energyControl: number;
            energyCreeps: number;
            energyHarvested: number;
            powerProcessed: number;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    ok: 1

    An API success response always contains { ok: 1 }

    shards: {
        [shardName: string]: {
            gameTimes: [
                number,
                undefined,
                undefined,
                undefined,
                undefined,
                undefined,
                undefined,
                undefined,
            ];
            rooms: string[];
            stats: { [roomName: string]: { endTime: number; value: number }[] };
        };
    }
    statsMax: number
    totals: {
        creepsLost: number;
        creepsProduced: number;
        energyConstruction: number;
        energyControl: number;
        energyCreeps: number;
        energyHarvested: number;
        powerProcessed: number;
    }