import { APIResource } from "../../../resource.js"; import * as Core from "../../../core.js"; export declare class WebCrawlers extends APIResource { /** * Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the * specified dimension. * * @example * ```ts * const response = * await client.radar.bots.webCrawlers.summary('USER_AGENT'); * ``` */ summary(dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO' | 'VERTICAL' | 'INDUSTRY', query?: WebCrawlerSummaryParams, options?: Core.RequestOptions): Core.APIPromise; summary(dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO' | 'VERTICAL' | 'INDUSTRY', options?: Core.RequestOptions): Core.APIPromise; /** * Retrieves the distribution of HTTP requests from crawlers, grouped by chosen the * specified dimension over time. * * @example * ```ts * const response = * await client.radar.bots.webCrawlers.timeseriesGroups( * 'USER_AGENT', * ); * ``` */ timeseriesGroups(dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO' | 'VERTICAL' | 'INDUSTRY', query?: WebCrawlerTimeseriesGroupsParams, options?: Core.RequestOptions): Core.APIPromise; timeseriesGroups(dimension: 'USER_AGENT' | 'REFERER' | 'CRAWL_REFER_RATIO' | 'VERTICAL' | 'INDUSTRY', options?: Core.RequestOptions): Core.APIPromise; } export interface WebCrawlerSummaryResponse { /** * Metadata for the results. */ meta: WebCrawlerSummaryResponse.Meta; summary_0: { [key: string]: string; }; } export declare namespace WebCrawlerSummaryResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo; 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; } } } export interface WebCrawlerTimeseriesGroupsResponse { /** * Metadata for the results. */ meta: WebCrawlerTimeseriesGroupsResponse.Meta; serie_0: WebCrawlerTimeseriesGroupsResponse.Serie0; } export declare namespace WebCrawlerTimeseriesGroupsResponse { /** * Metadata for the results. */ 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; /** * 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 Serie0 { timestamps: Array; [k: string]: Array | Array | undefined; } } export interface WebCrawlerSummaryParams { /** * Filters results by bot operator. */ botOperator?: 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 industry. */ industry?: Array; /** * Limits the number of objects per group to the top items within the specified * time range. When item count exceeds the limit, extra items appear grouped under * an "other" category. */ limitPerGroup?: number; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by vertical. */ vertical?: Array; } export interface WebCrawlerTimeseriesGroupsParams { /** * 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 bot operator. */ botOperator?: 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 industry. */ industry?: Array; /** * Limits the number of objects per group to the top items within the specified * time range. When item count exceeds the limit, extra items appear grouped under * an "other" category. */ limitPerGroup?: number; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by vertical. */ vertical?: Array; } export declare namespace WebCrawlers { export { type WebCrawlerSummaryResponse as WebCrawlerSummaryResponse, type WebCrawlerTimeseriesGroupsResponse as WebCrawlerTimeseriesGroupsResponse, type WebCrawlerSummaryParams as WebCrawlerSummaryParams, type WebCrawlerTimeseriesGroupsParams as WebCrawlerTimeseriesGroupsParams, }; } //# sourceMappingURL=web-crawlers.d.ts.map