import { APIResource } from "../../../../resource.js"; import * as Core from "../../../../core.js"; import * as UserAgentsAPI from "./user-agents.js"; import { UserAgentDirectiveParams, UserAgentDirectiveResponse, UserAgents } from "./user-agents.js"; export declare class Top extends APIResource { userAgents: UserAgentsAPI.UserAgents; /** * Retrieves the top domain categories by the number of robots.txt files parsed. * * @example * ```ts * const response = * await client.radar.robotsTXT.top.domainCategories(); * ``` */ domainCategories(query?: TopDomainCategoriesParams, options?: Core.RequestOptions): Core.APIPromise; domainCategories(options?: Core.RequestOptions): Core.APIPromise; } export interface TopDomainCategoriesResponse { /** * Metadata for the results. */ meta: TopDomainCategoriesResponse.Meta; top_0: Array; } export declare namespace TopDomainCategoriesResponse { /** * 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 { name: string; value: number; } } export interface TopDomainCategoriesParams { /** * Filters results by the specified array of dates. */ date?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Limits the number of objects returned in the response. */ limit?: number; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by user agent category. */ userAgentCategory?: 'AI'; } export declare namespace Top { export { type TopDomainCategoriesResponse as TopDomainCategoriesResponse, type TopDomainCategoriesParams as TopDomainCategoriesParams, }; export { UserAgents as UserAgents, type UserAgentDirectiveResponse as UserAgentDirectiveResponse, type UserAgentDirectiveParams as UserAgentDirectiveParams, }; } //# sourceMappingURL=top.d.ts.map