cloudflare/resources/spectrum/analytics/aggregates/currents.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../../core/resource.js";
import { APIPromise } from "../../../../core/api-promise.js";
import { RequestOptions } from "../../../../internal/request-options.js";
export declare class BaseCurrents extends APIResource {
    static readonly _key: readonly ['spectrum', 'analytics', 'aggregates', 'currents'];
    /**
     * Retrieves analytics aggregated from the last minute of usage on Spectrum
     * applications underneath a given zone.
     */
    get(params: CurrentGetParams, options?: RequestOptions): APIPromise<CurrentGetResponse>;
}
export declare class Currents extends BaseCurrents {
}
export type CurrentGetResponse = Array<CurrentGetResponse.CurrentGetResponseItem>;
export declare namespace CurrentGetResponse {
    interface CurrentGetResponseItem {
        /**
         * Application identifier.
         */
        appID: string;
        /**
         * Number of bytes sent.
         */
        bytesEgress: number;
        /**
         * Number of bytes received.
         */
        bytesIngress: number;
        /**
         * Number of connections.
         */
        connections: number;
        /**
         * Average duration of connections.
         */
        durationAvg: number;
    }
}
export interface CurrentGetParams {
    /**
     * Path param: Identifier.
     */
    zone_id: string;
    /**
     * Query param: Comma-delimited list of Spectrum Application Id(s). If provided,
     * the response will be limited to Spectrum Application Id(s) that match.
     */
    appID?: string;
    /**
     * Query param: Co-location identifier.
     */
    colo_name?: string;
}
export declare namespace Currents {
    export { type CurrentGetResponse as CurrentGetResponse, type CurrentGetParams as CurrentGetParams };
}
//# sourceMappingURL=currents.d.ts.map