cloudflare
Version:
The official TypeScript library for the Cloudflare API
559 lines • 21.4 kB
TypeScript
import { APIResource } from "../../../../resource.js";
import * as Core from "../../../../core.js";
export declare class TimeseriesGroups extends APIResource {
/**
* Retrieves the distribution of layer 3 attacks by bitrate over time.
*/
bitrate(query?: TimeseriesGroupBitrateParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBitrateResponse>;
bitrate(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBitrateResponse>;
/**
* Retrieves the distribution of layer 3 attacks by duration over time.
*/
duration(query?: TimeseriesGroupDurationParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupDurationResponse>;
duration(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupDurationResponse>;
/**
* Retrieves the distribution of layer 3 attacks by targeted industry over time.
*/
industry(query?: TimeseriesGroupIndustryParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIndustryResponse>;
industry(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIndustryResponse>;
/**
* Retrieves the distribution of layer 3 attacks by IP version over time.
*/
ipVersion(query?: TimeseriesGroupIPVersionParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIPVersionResponse>;
ipVersion(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIPVersionResponse>;
/**
* Retrieves the distribution of layer 3 attacks by protocol over time.
*/
protocol(query?: TimeseriesGroupProtocolParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupProtocolResponse>;
protocol(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupProtocolResponse>;
/**
* Retrieves the distribution of layer 3 attacks by vector over time.
*/
vector(query?: TimeseriesGroupVectorParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVectorResponse>;
vector(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVectorResponse>;
/**
* Retrieves the distribution of layer 3 attacks by targeted vertical over time.
*/
vertical(query?: TimeseriesGroupVerticalParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVerticalResponse>;
vertical(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVerticalResponse>;
}
export interface TimeseriesGroupBitrateResponse {
meta: unknown;
serie_0: TimeseriesGroupBitrateResponse.Serie0;
}
export declare namespace TimeseriesGroupBitrateResponse {
interface Serie0 {
_1_GBPS_TO_10_GBPS: Array<string>;
_10_GBPS_TO_100_GBPS: Array<string>;
_500_MBPS_TO_1_GBPS: Array<string>;
OVER_100_GBPS: Array<string>;
timestamps: Array<string>;
UNDER_500_MBPS: Array<string>;
}
}
export interface TimeseriesGroupDurationResponse {
meta: unknown;
serie_0: TimeseriesGroupDurationResponse.Serie0;
}
export declare namespace TimeseriesGroupDurationResponse {
interface Serie0 {
_1_HOUR_TO_3_HOURS: Array<string>;
_10_MINS_TO_20_MINS: Array<string>;
_20_MINS_TO_40_MINS: Array<string>;
_40_MINS_TO_1_HOUR: Array<string>;
OVER_3_HOURS: Array<string>;
timestamps: Array<string>;
UNDER_10_MINS: Array<string>;
}
}
export interface TimeseriesGroupIndustryResponse {
meta: unknown;
serie_0: TimeseriesGroupIndustryResponse.Serie0;
}
export declare namespace TimeseriesGroupIndustryResponse {
interface Serie0 {
timestamps: Array<string>;
[]: Array<string> | undefined;
}
}
export interface TimeseriesGroupIPVersionResponse {
meta: unknown;
serie_0: TimeseriesGroupIPVersionResponse.Serie0;
}
export declare namespace TimeseriesGroupIPVersionResponse {
interface Serie0 {
IPv4: Array<string>;
IPv6: Array<string>;
timestamps: Array<string>;
}
}
export interface TimeseriesGroupProtocolResponse {
meta: unknown;
serie_0: TimeseriesGroupProtocolResponse.Serie0;
}
export declare namespace TimeseriesGroupProtocolResponse {
interface Serie0 {
GRE: Array<string>;
ICMP: Array<string>;
TCP: Array<string>;
timestamps: Array<string>;
UDP: Array<string>;
}
}
export interface TimeseriesGroupVectorResponse {
meta: unknown;
serie_0: TimeseriesGroupVectorResponse.Serie0;
}
export declare namespace TimeseriesGroupVectorResponse {
interface Serie0 {
timestamps: Array<string>;
[]: Array<string> | undefined;
}
}
export interface TimeseriesGroupVerticalResponse {
meta: unknown;
serie_0: TimeseriesGroupVerticalResponse.Serie0;
}
export declare namespace TimeseriesGroupVerticalResponse {
interface Serie0 {
timestamps: Array<string>;
[]: Array<string> | undefined;
}
}
export interface TimeseriesGroupBitrateParams {
/**
* Aggregation interval results should be returned in (for example, in 15 minutes
* or 1 hour intervals). Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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>;
/**
* Filters results by the specified 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>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* 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>;
/**
* Normalization method applied. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN0_MAX';
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface TimeseriesGroupDurationParams {
/**
* Aggregation interval results should be returned in (for example, in 15 minutes
* or 1 hour intervals). Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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>;
/**
* Filters results by the specified 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>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* 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>;
/**
* Normalization method applied. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN0_MAX';
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface TimeseriesGroupIndustryParams {
/**
* Aggregation interval results should be returned in (for example, in 15 minutes
* or 1 hour intervals). Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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>;
/**
* Filters results by the specified 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>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects per group to the top items within the specified
* time range. If there are more items than the limit, the response will include
* the count of items, with any remaining items grouped together under an "other"
* category.
*/
limitPerGroup?: number;
/**
* 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>;
/**
* Normalization method applied. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN0_MAX';
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface TimeseriesGroupIPVersionParams {
/**
* Aggregation interval results should be returned in (for example, in 15 minutes
* or 1 hour intervals). Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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>;
/**
* Filters results by the specified 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>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* 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>;
/**
* Normalization method applied. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN0_MAX';
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface TimeseriesGroupProtocolParams {
/**
* Aggregation interval results should be returned in (for example, in 15 minutes
* or 1 hour intervals). Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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>;
/**
* Filters results by the specified 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>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* 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>;
/**
* Normalization method applied. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN0_MAX';
}
export interface TimeseriesGroupVectorParams {
/**
* Aggregation interval results should be returned in (for example, in 15 minutes
* or 1 hour intervals). Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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>;
/**
* Filters results by the specified 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>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects per group to the top items within the specified
* time range. If there are more items than the limit, the response will include
* the count of items, with any remaining items grouped together under an "other"
* category.
*/
limitPerGroup?: number;
/**
* 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>;
/**
* Normalization method applied. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN0_MAX';
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface TimeseriesGroupVerticalParams {
/**
* Aggregation interval results should be returned in (for example, in 15 minutes
* or 1 hour intervals). Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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>;
/**
* Filters results by the specified 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>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects per group to the top items within the specified
* time range. If there are more items than the limit, the response will include
* the count of items, with any remaining items grouped together under an "other"
* category.
*/
limitPerGroup?: number;
/**
* 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>;
/**
* Normalization method applied. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN0_MAX';
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export declare namespace TimeseriesGroups {
export { type TimeseriesGroupBitrateResponse as TimeseriesGroupBitrateResponse, type TimeseriesGroupDurationResponse as TimeseriesGroupDurationResponse, type TimeseriesGroupIndustryResponse as TimeseriesGroupIndustryResponse, type TimeseriesGroupIPVersionResponse as TimeseriesGroupIPVersionResponse, type TimeseriesGroupProtocolResponse as TimeseriesGroupProtocolResponse, type TimeseriesGroupVectorResponse as TimeseriesGroupVectorResponse, type TimeseriesGroupVerticalResponse as TimeseriesGroupVerticalResponse, type TimeseriesGroupBitrateParams as TimeseriesGroupBitrateParams, type TimeseriesGroupDurationParams as TimeseriesGroupDurationParams, type TimeseriesGroupIndustryParams as TimeseriesGroupIndustryParams, type TimeseriesGroupIPVersionParams as TimeseriesGroupIPVersionParams, type TimeseriesGroupProtocolParams as TimeseriesGroupProtocolParams, type TimeseriesGroupVectorParams as TimeseriesGroupVectorParams, type TimeseriesGroupVerticalParams as TimeseriesGroupVerticalParams, };
}
//# sourceMappingURL=timeseries-groups.d.ts.map