cloudflare
Version:
The official TypeScript library for the Cloudflare API
401 lines (328 loc) • 9.8 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../resource';
import * as Core from '../../../core';
export class IQI extends APIResource {
/**
* Retrieves a summary (percentiles) of bandwidth, latency, or DNS response time
* from the Radar Internet Quality Index (IQI).
*
* @example
* ```ts
* const response = await client.radar.quality.iqi.summary({
* metric: 'BANDWIDTH',
* });
* ```
*/
summary(query: IQISummaryParams, options?: Core.RequestOptions): Core.APIPromise<IQISummaryResponse> {
return (
this._client.get('/radar/quality/iqi/summary', { query, ...options }) as Core.APIPromise<{
result: IQISummaryResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves a time series (percentiles) of bandwidth, latency, or DNS response
* time from the Radar Internet Quality Index (IQI).
*
* @example
* ```ts
* const response =
* await client.radar.quality.iqi.timeseriesGroups({
* metric: 'BANDWIDTH',
* });
* ```
*/
timeseriesGroups(
query: IQITimeseriesGroupsParams,
options?: Core.RequestOptions,
): Core.APIPromise<IQITimeseriesGroupsResponse> {
return (
this._client.get('/radar/quality/iqi/timeseries_groups', { query, ...options }) as Core.APIPromise<{
result: IQITimeseriesGroupsResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export interface IQISummaryResponse {
/**
* Metadata for the results.
*/
meta: IQISummaryResponse.Meta;
summary_0: IQISummaryResponse.Summary0;
}
export namespace IQISummaryResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
dateRange: Array<Meta.DateRange>;
/**
* Timestamp of the last dataset update.
*/
lastUpdated: string;
/**
* Normalization method applied to the results. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization:
| 'PERCENTAGE'
| 'MIN0_MAX'
| 'MIN_MAX'
| 'RAW_VALUES'
| 'PERCENTAGE_CHANGE'
| 'ROLLING_AVERAGE'
| 'OVERLAPPED_PERCENTAGE'
| 'RATIO';
/**
* Measurement units for the results.
*/
units: Array<Meta.Unit>;
}
export namespace Meta {
export interface ConfidenceInfo {
annotations: Array<ConfidenceInfo.Annotation>;
/**
* Provides an indication of how much confidence Cloudflare has in the data.
*/
level: number;
}
export namespace ConfidenceInfo {
/**
* Annotation associated with the result (e.g. outage or other type of event).
*/
export interface Annotation {
dataSource: string;
description: string;
endDate: string;
eventType: string;
/**
* Whether event is a single point in time or a time range.
*/
isInstantaneous: boolean;
linkedUrl: string;
startDate: string;
}
}
export interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
export interface Unit {
name: string;
value: string;
}
}
export interface Summary0 {
p25: string;
p50: string;
p75: string;
}
}
export interface IQITimeseriesGroupsResponse {
/**
* Metadata for the results.
*/
meta: IQITimeseriesGroupsResponse.Meta;
serie_0: IQITimeseriesGroupsResponse.Serie0;
}
export namespace IQITimeseriesGroupsResponse {
/**
* Metadata for the results.
*/
export interface Meta {
/**
* Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
* Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
confidenceInfo: Meta.ConfidenceInfo;
dateRange: Array<Meta.DateRange>;
/**
* Timestamp of the last dataset update.
*/
lastUpdated: string;
/**
* Normalization method applied to the results. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization:
| 'PERCENTAGE'
| 'MIN0_MAX'
| 'MIN_MAX'
| 'RAW_VALUES'
| 'PERCENTAGE_CHANGE'
| 'ROLLING_AVERAGE'
| 'OVERLAPPED_PERCENTAGE'
| 'RATIO';
/**
* Measurement units for the results.
*/
units: Array<Meta.Unit>;
}
export namespace Meta {
export interface ConfidenceInfo {
annotations: Array<ConfidenceInfo.Annotation>;
/**
* Provides an indication of how much confidence Cloudflare has in the data.
*/
level: number;
}
export namespace ConfidenceInfo {
/**
* Annotation associated with the result (e.g. outage or other type of event).
*/
export interface Annotation {
dataSource: string;
description: string;
endDate: string;
eventType: string;
/**
* Whether event is a single point in time or a time range.
*/
isInstantaneous: boolean;
linkedUrl: string;
startDate: string;
}
}
export interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
export interface Unit {
name: string;
value: string;
}
}
export interface Serie0 {
p25: Array<string>;
p50: Array<string>;
p75: Array<string>;
timestamps: Array<string>;
}
}
export interface IQISummaryParams {
/**
* Defines which metric to return (bandwidth, latency, or DNS response time).
*/
metric: 'BANDWIDTH' | 'DNS' | 'LATENCY';
/**
* Filters results by Autonomous System. Specify one or more Autonomous System
* Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
* results. For example, `-174, 3356` excludes results from AS174, but includes
* results from AS3356.
*/
asn?: Array<string>;
/**
* Filters results by continent. Specify a comma-separated list of alpha-2 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>;
/**
* Filters results by date range. For example, use `7d` and `7dcontrol` to compare
* this week with the previous week. Use this parameter or set specific start and
* end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
dateStart?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by location. Specify a comma-separated list of 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 interface IQITimeseriesGroupsParams {
/**
* Defines which metric to return (bandwidth, latency, or DNS response time).
*/
metric: 'BANDWIDTH' | 'DNS' | 'LATENCY';
/**
* Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
* Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* Filters results by Autonomous System. Specify one or more Autonomous System
* Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
* results. For example, `-174, 3356` excludes results from AS174, but includes
* results from AS3356.
*/
asn?: Array<string>;
/**
* Filters results by continent. Specify a comma-separated list of alpha-2 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>;
/**
* Filters results by date range. For example, use `7d` and `7dcontrol` to compare
* this week with the previous week. Use this parameter or set specific start and
* end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
dateStart?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Enables interpolation for all series (using the average).
*/
interpolation?: boolean;
/**
* Filters results by location. Specify a comma-separated list of 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 IQI {
export {
type IQISummaryResponse as IQISummaryResponse,
type IQITimeseriesGroupsResponse as IQITimeseriesGroupsResponse,
type IQISummaryParams as IQISummaryParams,
type IQITimeseriesGroupsParams as IQITimeseriesGroupsParams,
};
}