@s2-dev/streamstore - v0.22.0
    Preparing search index...

    Type Alias StreamMetricsData

    type StreamMetricsData = {
        body?: never;
        path: { basin: BasinNameStr; stream: StreamNameStr };
        query: {
            end?: number;
            interval?: TimeseriesInterval;
            set: StreamMetricSet;
            start?: number;
        };
        url: "/metrics/{basin}/{stream}";
    }
    Index

    Properties

    body? path query url

    Properties

    Optionalbody

    body?: never
    path: { basin: BasinNameStr; stream: StreamNameStr }

    Type Declaration

    query: {
        end?: number;
        interval?: TimeseriesInterval;
        set: StreamMetricSet;
        start?: number;
    }

    Type Declaration

    • Optionalend?: number

      End timestamp as Unix epoch seconds, if applicable for metric set.

    • Optionalinterval?: TimeseriesInterval

      Interval to aggregate over for timeseries metric sets.

    • set: StreamMetricSet

      Metric set to return.

    • Optionalstart?: number

      Start timestamp as Unix epoch seconds, if applicable for the metric set.

    url: "/metrics/{basin}/{stream}"

    Settings

    Member Visibility

    On This Page

    Properties