cloudflare

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../../resource'; import * as Core from '../../../../core'; import * as EventsAPI from './events'; export class Summaries extends APIResource { /** * Retrieves a list of summarised aggregate metrics over a given time period. */ get(params: SummaryGetParams, options?: Core.RequestOptions): Core.APIPromise<SummaryGetResponse> { const { zone_id, ...query } = params; return ( this._client.get(`/zones/${zone_id}/spectrum/analytics/events/summary`, { query, ...options, }) as Core.APIPromise<{ result: SummaryGetResponse }> )._thenUnwrap((obj) => obj.result); } } export interface SummaryGetResponse { /** * List of columns returned by the analytics query. */ data: Array<SummaryGetResponse.Data>; /** * Number of seconds between current time and last processed event, i.e. how many * seconds of data could be missing. */ data_lag: number; /** * Maximum result for each selected metrics across all data. */ max: { [key: string]: number }; /** * Minimum result for each selected metrics across all data. */ min: { [key: string]: number }; query: SummaryGetResponse.Query; /** * Total number of rows in the result. */ rows: number; /** * Total result for each selected metrics across all data. */ totals: { [key: string]: number }; /** * List of time interval buckets: [start, end] */ time_intervals?: Array<Array<string>>; } export namespace SummaryGetResponse { export interface Data { dimensions?: Array<string>; metrics?: Array<number> | Array<Array<number>>; } export interface Query { /** * Can be used to break down the data by given attributes. Options are: * * | Dimension | Name | Example | * | --------- | ----------------------------- | ---------------------------------------------------------- | * | event | Connection Event | connect, progress, disconnect, originError, clientFiltered | * | appID | Application ID | 40d67c87c6cd4b889a4fd57805225e85 | * | coloName | Colo Name | SFO | * | ipVersion | IP version used by the client | 4, 6. | */ dimensions?: Array<EventsAPI.Dimension>; /** * Used to filter rows by one or more dimensions. Filters can be combined using OR * and AND boolean logic. AND takes precedence over OR in all the expressions. The * OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. * The AND operator is defined using a semicolon (;) or AND keyword surrounded by * whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) * and needs to be percent-encoded as %3B. Comparison options are: * * | Operator | Name | URL Encoded | * | -------- | ------------------------ | ----------- | * | == | Equals | %3D%3D | * | != | Does not equals | !%3D | * | \> | Greater Than | %3E | * | \< | Less Than | %3C | * | \>= | Greater than or equal to | %3E%3D | * | \<= | Less than or equal to | %3C%3D | */ filters?: string; /** * Limit number of returned metrics. */ limit?: number; /** * One or more metrics to compute. Options are: * * | Metric | Name | Example | Unit | * | -------------- | ----------------------------------- | ------- | --------------------- | * | count | Count of total events | 1000 | Count | * | bytesIngress | Sum of ingress bytes | 1000 | Sum | * | bytesEgress | Sum of egress bytes | 1000 | Sum | * | durationAvg | Average connection duration | 1.0 | Time in milliseconds | * | durationMedian | Median connection duration | 1.0 | Time in milliseconds | * | duration90th | 90th percentile connection duration | 1.0 | Time in milliseconds | * | duration99th | 99th percentile connection duration | 1.0 | Time in milliseconds. | */ metrics?: Array< | 'count' | 'bytesIngress' | 'bytesEgress' | 'durationAvg' | 'durationMedian' | 'duration90th' | 'duration99th' >; /** * Start of time interval to query, defaults to `until` - 6 hours. Timestamp must * be in RFC3339 format and uses UTC unless otherwise specified. */ since?: string; /** * The sort order for the result set; sort fields must be included in `metrics` or * `dimensions`. */ sort?: Array<string>; /** * End of time interval to query, defaults to current time. Timestamp must be in * RFC3339 format and uses UTC unless otherwise specified. */ until?: string; } } export interface SummaryGetParams { /** * Path param: Identifier. */ zone_id: string; /** * Query param: Can be used to break down the data by given attributes. Options * are: * * | Dimension | Name | Example | * | --------- | ----------------------------- | ---------------------------------------------------------- | * | event | Connection Event | connect, progress, disconnect, originError, clientFiltered | * | appID | Application ID | 40d67c87c6cd4b889a4fd57805225e85 | * | coloName | Colo Name | SFO | * | ipVersion | IP version used by the client | 4, 6. | */ dimensions?: Array<EventsAPI.DimensionParam>; /** * Query param: Used to filter rows by one or more dimensions. Filters can be * combined using OR and AND boolean logic. AND takes precedence over OR in all the * expressions. The OR operator is defined using a comma (,) or OR keyword * surrounded by whitespace. The AND operator is defined using a semicolon (;) or * AND keyword surrounded by whitespace. Note that the semicolon is a reserved * character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison * options are: * * | Operator | Name | URL Encoded | * | -------- | ------------------------ | ----------- | * | == | Equals | %3D%3D | * | != | Does not equals | !%3D | * | \> | Greater Than | %3E | * | \< | Less Than | %3C | * | \>= | Greater than or equal to | %3E%3D | * | \<= | Less than or equal to | %3C%3D | */ filters?: string; /** * Query param: One or more metrics to compute. Options are: * * | Metric | Name | Example | Unit | * | -------------- | ----------------------------------- | ------- | --------------------- | * | count | Count of total events | 1000 | Count | * | bytesIngress | Sum of ingress bytes | 1000 | Sum | * | bytesEgress | Sum of egress bytes | 1000 | Sum | * | durationAvg | Average connection duration | 1.0 | Time in milliseconds | * | durationMedian | Median connection duration | 1.0 | Time in milliseconds | * | duration90th | 90th percentile connection duration | 1.0 | Time in milliseconds | * | duration99th | 99th percentile connection duration | 1.0 | Time in milliseconds. | */ metrics?: Array< | 'count' | 'bytesIngress' | 'bytesEgress' | 'durationAvg' | 'durationMedian' | 'duration90th' | 'duration99th' >; /** * Query param: Start of time interval to query, defaults to `until` - 6 hours. * Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. */ since?: string; /** * Query param: The sort order for the result set; sort fields must be included in * `metrics` or `dimensions`. */ sort?: Array<string>; /** * Query param: End of time interval to query, defaults to current time. Timestamp * must be in RFC3339 format and uses UTC unless otherwise specified. */ until?: string; } export declare namespace Summaries { export { type SummaryGetResponse as SummaryGetResponse, type SummaryGetParams as SummaryGetParams }; }