cloudflare
Version:
The official TypeScript library for the Cloudflare API
155 lines • 5.59 kB
TypeScript
import { APIResource } from "../../../../resource.js";
import * as Core from "../../../../core.js";
import * as TopAPI from "./top.js";
import { Top, TopAsesParams, TopAsesResponse, TopLocationsParams, TopLocationsResponse } from "./top.js";
export declare class Speed extends APIResource {
top: TopAPI.Top;
/**
* Retrieves a histogram from the previous 90 days of Cloudflare Speed Test data,
* split into fixed bandwidth (Mbps), latency (ms), or jitter (ms) buckets.
*/
histogram(query?: SpeedHistogramParams, options?: Core.RequestOptions): Core.APIPromise<SpeedHistogramResponse>;
histogram(options?: Core.RequestOptions): Core.APIPromise<SpeedHistogramResponse>;
/**
* Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the
* previous 90 days of Cloudflare Speed Test data.
*/
summary(query?: SpeedSummaryParams, options?: Core.RequestOptions): Core.APIPromise<SpeedSummaryResponse>;
summary(options?: Core.RequestOptions): Core.APIPromise<SpeedSummaryResponse>;
}
export interface SpeedHistogramResponse {
histogram_0: SpeedHistogramResponse.Histogram0;
meta: unknown;
}
export declare namespace SpeedHistogramResponse {
interface Histogram0 {
bandwidthDownload: Array<string>;
bandwidthUpload: Array<string>;
bucketMin: Array<string>;
}
}
export interface SpeedSummaryResponse {
meta: SpeedSummaryResponse.Meta;
summary_0: SpeedSummaryResponse.Summary0;
}
export declare namespace SpeedSummaryResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
bandwidthDownload: string;
bandwidthUpload: string;
jitterIdle: string;
jitterLoaded: string;
latencyIdle: string;
latencyLoaded: string;
packetLoss: string;
}
}
export interface SpeedHistogramParams {
/**
* Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to
* exclude ASNs from results. For example, `-174, 3356` excludes results from
* AS174, but includes results from AS3356.
*/
asn?: Array<string>;
/**
* Width for every bucket in the histogram.
*/
bucketSize?: number;
/**
* Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to
* exclude continents from results. For example, `-EU,NA` excludes results from EU,
* but includes results from NA.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude
* locations from results. For example, `-US,PT` excludes results from the US, but
* includes results from PT.
*/
location?: Array<string>;
/**
* Metrics to be returned.
*/
metricGroup?: 'BANDWIDTH' | 'LATENCY' | 'JITTER';
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
}
export interface SpeedSummaryParams {
/**
* Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to
* exclude ASNs from results. For example, `-174, 3356` excludes results from
* AS174, but includes results from AS3356.
*/
asn?: Array<string>;
/**
* Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to
* exclude continents from results. For example, `-EU,NA` excludes results from EU,
* but includes results from NA.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude
* locations from results. For example, `-US,PT` excludes results from the US, but
* includes results from PT.
*/
location?: Array<string>;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
}
export declare namespace Speed {
export { type SpeedHistogramResponse as SpeedHistogramResponse, type SpeedSummaryResponse as SpeedSummaryResponse, type SpeedHistogramParams as SpeedHistogramParams, type SpeedSummaryParams as SpeedSummaryParams, };
export { Top as Top, type TopAsesResponse as TopAsesResponse, type TopLocationsResponse as TopLocationsResponse, type TopAsesParams as TopAsesParams, type TopLocationsParams as TopLocationsParams, };
}
//# sourceMappingURL=speed.d.ts.map