import { APIResource } from "../../../resource.js"; import * as Core from "../../../core.js"; export declare class Top extends APIResource { /** * Retrieves the top autonomous systems by network traffic (NetFlows). * * @example * ```ts * const response = await client.radar.netflows.top.ases(); * ``` */ ases(query?: TopAsesParams, options?: Core.RequestOptions): Core.APIPromise; ases(options?: Core.RequestOptions): Core.APIPromise; /** * Retrieves the top locations by network traffic (NetFlows). * * @example * ```ts * const response = * await client.radar.netflows.top.locations(); * ``` */ locations(query?: TopLocationsParams, options?: Core.RequestOptions): Core.APIPromise; locations(options?: Core.RequestOptions): Core.APIPromise; } export interface TopAsesResponse { /** * Metadata for the results. */ meta: TopAsesResponse.Meta; top_0: Array; } export declare namespace TopAsesResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo | null; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * Provides an indication of how much confidence Cloudflare has in the data. */ level: number; } namespace ConfidenceInfo { /** * Annotation associated with the result (e.g. outage or other type of event). */ 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } interface Top0 { clientASN: number; clientASName: string; /** * A numeric string. */ value: string; } } export interface TopLocationsResponse { /** * Metadata for the results. */ meta: TopLocationsResponse.Meta; top_0: Array; } export declare namespace TopLocationsResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo | null; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * Provides an indication of how much confidence Cloudflare has in the data. */ level: number; } namespace ConfidenceInfo { /** * Annotation associated with the result (e.g. outage or other type of event). */ 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } interface Top0 { clientCountryAlpha2: string; clientCountryName: string; /** * A numeric string. */ value: string; } } export interface TopAsesParams { /** * 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; /** * 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; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Start of the date range. */ dateStart?: Array; /** * 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; /** * 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; /** * Array of names used to label the series in the response. */ name?: Array; } export interface TopLocationsParams { /** * 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; /** * 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; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Start of the date range. */ dateStart?: Array; /** * 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; /** * 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; /** * Array of names used to label the series in the response. */ name?: Array; } export declare namespace Top { export { type TopAsesResponse as TopAsesResponse, type TopLocationsResponse as TopLocationsResponse, type TopAsesParams as TopAsesParams, type TopLocationsParams as TopLocationsParams, }; } //# sourceMappingURL=top.d.ts.map