cloudflare
Version:
The official TypeScript library for the Cloudflare API
480 lines (396 loc) • 11.9 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../resource';
import { isRequestOptions } from '../../../core';
import * as Core from '../../../core';
export class Top extends APIResource {
/**
* Retrieves the top user agents by HTTP requests.
*
* @example
* ```ts
* const response = await client.radar.http.top.browser();
* ```
*/
browser(query?: TopBrowserParams, options?: Core.RequestOptions): Core.APIPromise<TopBrowserResponse>;
browser(options?: Core.RequestOptions): Core.APIPromise<TopBrowserResponse>;
browser(
query: TopBrowserParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserResponse> {
if (isRequestOptions(query)) {
return this.browser({}, query);
}
return (
this._client.get('/radar/http/top/browser', { query, ...options }) as Core.APIPromise<{
result: TopBrowserResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the top user agents, aggregated in families, by HTTP requests.
*
* @example
* ```ts
* const response =
* await client.radar.http.top.browserFamily();
* ```
*/
browserFamily(
query?: TopBrowserFamilyParams,
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserFamilyResponse>;
browserFamily(options?: Core.RequestOptions): Core.APIPromise<TopBrowserFamilyResponse>;
browserFamily(
query: TopBrowserFamilyParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserFamilyResponse> {
if (isRequestOptions(query)) {
return this.browserFamily({}, query);
}
return (
this._client.get('/radar/http/top/browser_family', { query, ...options }) as Core.APIPromise<{
result: TopBrowserFamilyResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export interface TopBrowserResponse {
/**
* Metadata for the results.
*/
meta: TopBrowserResponse.Meta;
top_0: Array<TopBrowserResponse.Top0>;
}
export namespace TopBrowserResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo | null;
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 Top0 {
name: string;
value: string;
}
}
export interface TopBrowserFamilyResponse {
/**
* Metadata for the results.
*/
meta: TopBrowserFamilyResponse.Meta;
top_0: Array<TopBrowserFamilyResponse.Top0>;
}
export namespace TopBrowserFamilyResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo | null;
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 Top0 {
name: string;
value: string;
}
}
export interface TopBrowserParams {
/**
* 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 bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Filters results by browser family.
*/
browserFamily?: Array<'CHROME' | 'EDGE' | 'FIREFOX' | 'SAFARI'>;
/**
* 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>;
/**
* Filters results by device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs.
* Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689`
* excludes results from the 2267056 (Lisbon), but includes results from 5128638
* (New York).
*/
geoId?: Array<string>;
/**
* Filters results by HTTP protocol (HTTP vs. HTTPS).
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filters results by HTTP version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* 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>;
/**
* Filters results by operating system.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filters results by TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TopBrowserFamilyParams {
/**
* 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 bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* 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>;
/**
* Filters results by device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs.
* Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689`
* excludes results from the 2267056 (Lisbon), but includes results from 5128638
* (New York).
*/
geoId?: Array<string>;
/**
* Filters results by HTTP protocol (HTTP vs. HTTPS).
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filters results by HTTP version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* 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>;
/**
* Filters results by operating system.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filters results by TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export declare namespace Top {
export {
type TopBrowserResponse as TopBrowserResponse,
type TopBrowserFamilyResponse as TopBrowserFamilyResponse,
type TopBrowserParams as TopBrowserParams,
type TopBrowserFamilyParams as TopBrowserFamilyParams,
};
}