> ## Documentation Index
> Fetch the complete documentation index at: https://docs.server.express/llms.txt
> Use this file to discover all available pages before exploring further.

# Get usage statistics

> Live VM state plus the Proxmox RRD usage series for the chosen window, with a rough CO₂e estimate (per-vCPU power model
× PUE 1.2 × the node country's grid intensity — not billing-grade). Empty RRD slots are dropped. Owners, any team role
and staff can read it.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/cloud/{id}/stats
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/cloud/{id}/stats:
    get:
      tags:
        - Cloud
      summary: Get usage statistics
      description: >-
        Live VM state plus the Proxmox RRD usage series for the chosen window,
        with a rough CO₂e estimate (per-vCPU power model

        × PUE 1.2 × the node country's grid intensity — not billing-grade).
        Empty RRD slots are dropped. Owners, any team role

        and staff can read it.
      operationId: publicCloudGetStats
      parameters:
        - name: id
          in: path
          required: true
          description: Service id of the cloud server.
          schema:
            type: string
            format: uuid
        - name: timeframe
          in: query
          required: false
          description: Window for the series. Unknown values fall back to hour.
          schema:
            type: string
            enum:
              - hour
              - day
              - week
              - month
            default: hour
      responses:
        '200':
          description: Statistics.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/PublicCloudStats'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          description: The server hasn't been built yet. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
        - apiToken: []
components:
  schemas:
    PublicCloudStats:
      type: object
      required:
        - timeframe
        - current
        - emissions
        - series
      properties:
        timeframe:
          type: string
          enum:
            - hour
            - day
            - week
            - month
        current:
          type: object
          required:
            - status
            - uptime
            - cpus
            - cpu
            - mem
            - maxmem
            - disk
            - maxdisk
          properties:
            status:
              type: string
            uptime:
              type: integer
              description: Seconds.
            cpus:
              type: integer
            cpu:
              type: number
              description: Fraction of all vCPUs, 0–1.
            mem:
              type: integer
              description: Bytes.
            maxmem:
              type: integer
            disk:
              type: integer
            maxdisk:
              type: integer
        emissions:
          type: object
          required:
            - intensity
            - country
            - currentGph
            - windowTotalG
          properties:
            intensity:
              type: number
              description: Grid intensity used, gCO₂e/kWh.
            country:
              type:
                - string
                - 'null'
            currentGph:
              type: number
              description: Estimated gCO₂e per hour right now; 0 when not running.
            windowTotalG:
              type: number
              description: Estimated gCO₂e over the window.
        series:
          type: array
          items:
            type: object
            required:
              - time
              - cpu
              - mem
              - maxmem
              - netin
              - netout
              - diskread
              - diskwrite
              - emissionsGph
            properties:
              time:
                type: integer
                description: Unix seconds.
              cpu:
                type:
                  - number
                  - 'null'
              mem:
                type:
                  - number
                  - 'null'
                description: Bytes.
              maxmem:
                type:
                  - number
                  - 'null'
              netin:
                type:
                  - number
                  - 'null'
                description: Bytes per second.
              netout:
                type:
                  - number
                  - 'null'
              diskread:
                type:
                  - number
                  - 'null'
                description: Bytes per second.
              diskwrite:
                type:
                  - number
                  - 'null'
              emissionsGph:
                type:
                  - number
                  - 'null'
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The resource doesn't exist or isn't visible to you.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.