cloudflare
Version:
The official TypeScript library for the Cloudflare API
850 lines • 32.4 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as TimeseriesGroupsAPI from 'cloudflare/resources/radar/http/timeseries-groups';
export declare class TimeseriesGroups extends APIResource {
/**
* Get a time series of the percentage distribution of traffic classified as
* automated or human. Visit
* https://developers.cloudflare.com/radar/concepts/bot-classes/ for more
* information.
*/
botClass(query?: TimeseriesGroupBotClassParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBotClassResponse>;
botClass(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBotClassResponse>;
/**
* Get a time series of the percentage distribution of traffic of the top user
* agents.
*/
browser(query?: TimeseriesGroupBrowserParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBrowserResponse>;
browser(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBrowserResponse>;
/**
* Get a time series of the percentage distribution of traffic of the top user
* agents aggregated in families.
*/
browserFamily(query?: TimeseriesGroupBrowserFamilyParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBrowserFamilyResponse>;
browserFamily(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBrowserFamilyResponse>;
/**
* Get a time series of the percentage distribution of traffic per device type.
*/
deviceType(query?: TimeseriesGroupDeviceTypeParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupDeviceTypeResponse>;
deviceType(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupDeviceTypeResponse>;
/**
* Get a time series of the percentage distribution of traffic per HTTP protocol.
*/
httpProtocol(query?: TimeseriesGroupHTTPProtocolParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupHTTPProtocolResponse>;
httpProtocol(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupHTTPProtocolResponse>;
/**
* Get a time series of the percentage distribution of traffic per HTTP protocol
* version.
*/
httpVersion(query?: TimeseriesGroupHTTPVersionParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupHTTPVersionResponse>;
httpVersion(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupHTTPVersionResponse>;
/**
* Get a time series of the percentage distribution of traffic per IP protocol
* version.
*/
ipVersion(query?: TimeseriesGroupIPVersionParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIPVersionResponse>;
ipVersion(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIPVersionResponse>;
/**
* Get a time series of the percentage distribution of traffic of the top operating
* systems.
*/
os(query?: TimeseriesGroupOSParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupOSResponse>;
os(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupOSResponse>;
/**
* Get a time series of the percentage distribution of traffic per TLS protocol
* version.
*/
tlsVersion(query?: TimeseriesGroupTLSVersionParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupTLSVersionResponse>;
tlsVersion(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupTLSVersionResponse>;
}
export interface TimeseriesGroupBotClassResponse {
meta: unknown;
serie_0: TimeseriesGroupBotClassResponse.Serie0;
}
export declare namespace TimeseriesGroupBotClassResponse {
interface Serie0 {
bot: Array<string>;
human: Array<string>;
timestamps: Array<string>;
}
}
export interface TimeseriesGroupBrowserResponse {
meta: unknown;
serie_0: TimeseriesGroupBrowserResponse.Serie0;
}
export declare namespace TimeseriesGroupBrowserResponse {
interface Serie0 {
timestamps: Array<string>;
[]: Array<string>;
}
}
export interface TimeseriesGroupBrowserFamilyResponse {
meta: unknown;
serie_0: TimeseriesGroupBrowserFamilyResponse.Serie0;
}
export declare namespace TimeseriesGroupBrowserFamilyResponse {
interface Serie0 {
timestamps: Array<string>;
[]: Array<string>;
}
}
export interface TimeseriesGroupDeviceTypeResponse {
meta: unknown;
serie_0: TimeseriesGroupDeviceTypeResponse.Serie0;
}
export declare namespace TimeseriesGroupDeviceTypeResponse {
interface Serie0 {
desktop: Array<string>;
mobile: Array<string>;
other: Array<string>;
timestamps: Array<string>;
}
}
export interface TimeseriesGroupHTTPProtocolResponse {
meta: unknown;
serie_0: TimeseriesGroupHTTPProtocolResponse.Serie0;
}
export declare namespace TimeseriesGroupHTTPProtocolResponse {
interface Serie0 {
http: Array<string>;
https: Array<string>;
timestamps: Array<string>;
}
}
export interface TimeseriesGroupHTTPVersionResponse {
meta: unknown;
serie_0: TimeseriesGroupHTTPVersionResponse.Serie0;
}
export declare namespace TimeseriesGroupHTTPVersionResponse {
interface Serie0 {
'HTTP/1.x': Array<string>;
'HTTP/2': Array<string>;
'HTTP/3': Array<string>;
timestamps: Array<string>;
}
}
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 TimeseriesGroupOSResponse {
meta: unknown;
serie_0: TimeseriesGroupOSResponse.Serie0;
}
export declare namespace TimeseriesGroupOSResponse {
interface Serie0 {
timestamps: Array<string>;
[]: Array<string>;
}
}
export interface TimeseriesGroupTLSVersionResponse {
meta: unknown;
serie_0: TimeseriesGroupTLSVersionResponse.Serie0;
}
export declare namespace TimeseriesGroupTLSVersionResponse {
interface Serie0 {
timestamps: Array<string>;
'TLS 1.0': Array<string>;
'TLS 1.1': Array<string>;
'TLS 1.2': Array<string>;
'TLS 1.3': Array<string>;
'TLS QUIC': Array<string>;
}
}
export interface TimeseriesGroupBotClassParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TimeseriesGroupBrowserParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limit the number of objects (eg browsers, verticals, etc) to the top items over
* the time range.
*/
limitPerGroup?: number;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TimeseriesGroupBrowserFamilyParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TimeseriesGroupDeviceTypeParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TimeseriesGroupHTTPProtocolParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TimeseriesGroupHTTPVersionParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TimeseriesGroupOSParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TimeseriesGroupTLSVersionParams {
/**
* 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';
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
}
export declare namespace TimeseriesGroups {
export import TimeseriesGroupBotClassResponse = TimeseriesGroupsAPI.TimeseriesGroupBotClassResponse;
export import TimeseriesGroupBrowserResponse = TimeseriesGroupsAPI.TimeseriesGroupBrowserResponse;
export import TimeseriesGroupBrowserFamilyResponse = TimeseriesGroupsAPI.TimeseriesGroupBrowserFamilyResponse;
export import TimeseriesGroupDeviceTypeResponse = TimeseriesGroupsAPI.TimeseriesGroupDeviceTypeResponse;
export import TimeseriesGroupHTTPProtocolResponse = TimeseriesGroupsAPI.TimeseriesGroupHTTPProtocolResponse;
export import TimeseriesGroupHTTPVersionResponse = TimeseriesGroupsAPI.TimeseriesGroupHTTPVersionResponse;
export import TimeseriesGroupIPVersionResponse = TimeseriesGroupsAPI.TimeseriesGroupIPVersionResponse;
export import TimeseriesGroupOSResponse = TimeseriesGroupsAPI.TimeseriesGroupOSResponse;
export import TimeseriesGroupTLSVersionResponse = TimeseriesGroupsAPI.TimeseriesGroupTLSVersionResponse;
export import TimeseriesGroupBotClassParams = TimeseriesGroupsAPI.TimeseriesGroupBotClassParams;
export import TimeseriesGroupBrowserParams = TimeseriesGroupsAPI.TimeseriesGroupBrowserParams;
export import TimeseriesGroupBrowserFamilyParams = TimeseriesGroupsAPI.TimeseriesGroupBrowserFamilyParams;
export import TimeseriesGroupDeviceTypeParams = TimeseriesGroupsAPI.TimeseriesGroupDeviceTypeParams;
export import TimeseriesGroupHTTPProtocolParams = TimeseriesGroupsAPI.TimeseriesGroupHTTPProtocolParams;
export import TimeseriesGroupHTTPVersionParams = TimeseriesGroupsAPI.TimeseriesGroupHTTPVersionParams;
export import TimeseriesGroupIPVersionParams = TimeseriesGroupsAPI.TimeseriesGroupIPVersionParams;
export import TimeseriesGroupOSParams = TimeseriesGroupsAPI.TimeseriesGroupOSParams;
export import TimeseriesGroupTLSVersionParams = TimeseriesGroupsAPI.TimeseriesGroupTLSVersionParams;
}
//# sourceMappingURL=timeseries-groups.d.ts.map