listGauges¶

Aggregate usage gauge snapshots. Gauges are point-in-time values (storage totals, resource counts, …); each point carries the latest snapshot in its interval via argMax(value, time). metrics[] (1-10) is required; the response always contains one entry per requested metric, each with its own points[] time series.

Two response shapes: - Omit interval for a flat top-N table — argMax(value, time) per dimension combination over the whole window, no time axis. Useful for "top 10 resources by current storage". - Pass interval (1m, 15m, 30m, 1h, 1d) for a time series — one snapshot per (time bucket × dimension combination).

dimensions[] breaks each point down further. Supported on gauges: resourceId, teamId, service, resource. service and resource enable per-service / per-resource-type panels (e.g. storage-by-service: group files.storage, deployments.storage, builds.storage, databases.storage by service). Pass multiple metrics to render stacked charts in one round-trip. resourceId and teamId parameters filter the underlying rows. orderBy=value+orderDir=desc+limit=N returns the top-N. When startAt is omitted, the default window adapts to interval (or 7d when interval is omitted).

Usage Example¶

extends Node

func _ready():
    # You can skip setup if you have .env
    Appwrite.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
    Appwrite.set_project('<YOUR_PROJECT_ID>') # Your project ID
    Appwrite.set_key('<YOUR_API_KEY>') # Your secret API key

    var result = await Appwrite.usage.list_gauges(
        [],
        '<RESOURCE_ID>', # optional
        '<TEAM_ID>', # optional
        '1m', # optional
        [], # optional
        '2020-10-15T06:38:00.000+00:00', # optional
        '2020-10-15T06:38:00.000+00:00', # optional
        'time', # optional
        'asc', # optional
        1, # optional
        0 # optional
    )

    if result is AppwriteException:
        push_error(result.message)

    if result is AppwriteUsageGaugeList:
        print(result.to_dict())