Interface AggregatedUsageQuery

interface AggregatedUsageQuery {
    date[gte]: string;
    date[lte]: string;
    granularity?: "P1D" | "P1M";
    group?: string;
    limit?: number;
    order?: string;
    skip?: number;
    [filterKey: `filter[sys.dimensions.${string}.sys.${string}]`]: string | undefined;
    [filterInKey: `filter[sys.dimensions.${string}.sys.${string}][in]`]: string | undefined;
}

Indexable

  • [filterKey: `filter[sys.dimensions.${string}.sys.${string}]`]: string | undefined

    Filter by a single dimension value, e.g. filter[sys.dimensions.space.sys.id]=<id>. Allowed dimension keys per metric are documented in MetricDimensions in the Usage API reference docs.

  • [filterInKey: `filter[sys.dimensions.${string}.sys.${string}][in]`]: string | undefined

    Filter by multiple dimension values using the [in] operator, e.g. filter[sys.dimensions.space.sys.id][in]=id1,id2 (max 10 comma-separated values). Allowed dimension keys per metric are documented in MetricDimensions in the Usage API reference docs.

Properties

date[gte] date[lte] granularity? group? limit? order? skip?

Properties

date[gte]

date[gte]: string

Start date (inclusive) in YYYY-MM-DD format. Required.

date[lte]

date[lte]: string

End date (inclusive) in YYYY-MM-DD format. Required.

Optionalgranularity

granularity?: "P1D" | "P1M"

ISO-8601 granularity. Defaults to "P1D" server-side when omitted. "P1D" is limited to a 31-day range; "P1M" to 12 calendar months (including the current one).

Optionalgroup

group?: string

Comma-separated dimension keys to group results by

Optionallimit

limit?: number

Maximum number of items to return

Optionalorder

order?: string

Comma-separated columns in sys.dimensions.<name>.sys.<suffix> form (matching the group and filter grammar), optionally prefixed with - for descending, e.g. "total_usage" or "-total_usage" (descending). The synthetic aggregate total_usage is a bare-token passthrough ("total_usage", "-total_usage"). For api_call_* metrics, total_usage sorts by the per-group sum across the requested date range.

Optionalskip

skip?: number

Number of items to skip

Settings

Member Visibility

On This Page

Properties