import { APIResource } from "../../../../core/resource.js"; import { APIPromise } from "../../../../core/api-promise.js"; import { RequestOptions } from "../../../../internal/request-options.js"; export declare class BaseSummary extends APIResource { static readonly _key: readonly ['radar', 'attacks', 'layer7', 'summary']; /** * Retrieves the distribution of layer 7 attacks by HTTP method. * * @deprecated Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. */ httpMethod(query?: SummaryHTTPMethodParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of layer 7 attacks by HTTP version. * * @deprecated Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. */ httpVersion(query?: SummaryHTTPVersionParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of layer 7 attacks by targeted industry. * * @deprecated Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. */ industry(query?: SummaryIndustryParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of layer 7 attacks by IP version. * * @deprecated Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. */ ipVersion(query?: SummaryIPVersionParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of layer 7 attacks by managed rules. * * @deprecated Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. */ managedRules(query?: SummaryManagedRulesParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of layer 7 attacks by mitigation product. * * @deprecated Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. */ mitigationProduct(query?: SummaryMitigationProductParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of layer 7 attacks by targeted vertical. * * @deprecated Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead. */ vertical(query?: SummaryVerticalParams | null | undefined, options?: RequestOptions): APIPromise; } export declare class Summary extends BaseSummary { } export interface SummaryHTTPMethodResponse { /** * Metadata for the results. */ meta: SummaryHTTPMethodResponse.Meta; summary_0: { [key: string]: string; }; } export declare namespace SummaryHTTPMethodResponse { /** * 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 { /** * Data source for annotations. */ dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI'; description: string; endDate: string; /** * Event type for annotations. */ eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY'; /** * Whether event is a single point in time or a time range. */ isInstantaneous: boolean; linkedUrl: string; startDate: string; tags?: Array; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryHTTPVersionResponse { /** * Metadata for the results. */ meta: SummaryHTTPVersionResponse.Meta; summary_0: SummaryHTTPVersionResponse.Summary0; } export declare namespace SummaryHTTPVersionResponse { /** * 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 { /** * Data source for annotations. */ dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI'; description: string; endDate: string; /** * Event type for annotations. */ eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY'; /** * Whether event is a single point in time or a time range. */ isInstantaneous: boolean; linkedUrl: string; startDate: string; tags?: Array; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } interface Summary0 { 'HTTP/1.x': string; 'HTTP/2': string; 'HTTP/3': string; } } export interface SummaryIndustryResponse { /** * Metadata for the results. */ meta: SummaryIndustryResponse.Meta; summary_0: { [key: string]: string; }; } export declare namespace SummaryIndustryResponse { /** * 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 { /** * Data source for annotations. */ dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI'; description: string; endDate: string; /** * Event type for annotations. */ eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY'; /** * Whether event is a single point in time or a time range. */ isInstantaneous: boolean; linkedUrl: string; startDate: string; tags?: Array; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryIPVersionResponse { /** * Metadata for the results. */ meta: SummaryIPVersionResponse.Meta; summary_0: SummaryIPVersionResponse.Summary0; } export declare namespace SummaryIPVersionResponse { /** * 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 { /** * Data source for annotations. */ dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI'; description: string; endDate: string; /** * Event type for annotations. */ eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY'; /** * Whether event is a single point in time or a time range. */ isInstantaneous: boolean; linkedUrl: string; startDate: string; tags?: Array; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } interface Summary0 { IPv4: string; IPv6: string; } } export interface SummaryManagedRulesResponse { /** * Metadata for the results. */ meta: SummaryManagedRulesResponse.Meta; summary_0: { [key: string]: string; }; } export declare namespace SummaryManagedRulesResponse { /** * 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 { /** * Data source for annotations. */ dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI'; description: string; endDate: string; /** * Event type for annotations. */ eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY'; /** * Whether event is a single point in time or a time range. */ isInstantaneous: boolean; linkedUrl: string; startDate: string; tags?: Array; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryMitigationProductResponse { /** * Metadata for the results. */ meta: SummaryMitigationProductResponse.Meta; summary_0: { [key: string]: string; }; } export declare namespace SummaryMitigationProductResponse { /** * 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 { /** * Data source for annotations. */ dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI'; description: string; endDate: string; /** * Event type for annotations. */ eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY'; /** * Whether event is a single point in time or a time range. */ isInstantaneous: boolean; linkedUrl: string; startDate: string; tags?: Array; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryVerticalResponse { /** * Metadata for the results. */ meta: SummaryVerticalResponse.Meta; summary_0: { [key: string]: string; }; } export declare namespace SummaryVerticalResponse { /** * 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 { /** * Data source for annotations. */ dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI'; description: string; endDate: string; /** * Event type for annotations. */ eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY'; /** * Whether event is a single point in time or a time range. */ isInstantaneous: boolean; linkedUrl: string; startDate: string; tags?: Array; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryHTTPMethodParams { /** * 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). Alternative to `dateRange`; provide together * with `dateStart`. When requesting comparison series, every series must resolve * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored * to the nearest 15 minutes before evaluation, so windows whose durations match * only before alignment may be rejected. */ dateEnd?: Array; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `w` * for weeks (up to `52w`). Append `control` to request the equivalent previous * period for comparison: the comparison window is shifted back by the current * window's length rounded up to a whole number of weeks, so it keeps the same * weekday alignment and does not overlap the current window (e.g. `7dcontrol` * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass * `7d` and `7dcontrol` to compare this week with the previous week. All series * must resolve to the same duration as the main series; relative ranges (including * `control`) satisfy this automatically. Use this parameter or set specific start * and end dates (`dateStart` and `dateEnd` parameters). */ dateRange?: Array; /** * Start of the date range. Alternative to `dateRange`; provide together with * `dateEnd`. When requesting comparison series, every series must resolve to the * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the * nearest 15 minutes before evaluation, so windows whose durations match only * before alignment may be rejected. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * 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 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. Only supported on high-cardinality dimensions; otherwise * the request is rejected. Minimum value is 2. */ limitPerGroup?: 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; /** * Filters the results by layer 7 mitigation product. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names used to label the series in the response. */ name?: Array; } export interface SummaryHTTPVersionParams { /** * 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). Alternative to `dateRange`; provide together * with `dateStart`. When requesting comparison series, every series must resolve * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored * to the nearest 15 minutes before evaluation, so windows whose durations match * only before alignment may be rejected. */ dateEnd?: Array; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `w` * for weeks (up to `52w`). Append `control` to request the equivalent previous * period for comparison: the comparison window is shifted back by the current * window's length rounded up to a whole number of weeks, so it keeps the same * weekday alignment and does not overlap the current window (e.g. `7dcontrol` * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass * `7d` and `7dcontrol` to compare this week with the previous week. All series * must resolve to the same duration as the main series; relative ranges (including * `control`) satisfy this automatically. Use this parameter or set specific start * and end dates (`dateStart` and `dateEnd` parameters). */ dateRange?: Array; /** * Start of the date range. Alternative to `dateRange`; provide together with * `dateEnd`. When requesting comparison series, every series must resolve to the * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the * nearest 15 minutes before evaluation, so windows whose durations match only * before alignment may be rejected. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by HTTP method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * Filters results by IP version (Ipv4 vs. IPv6). */ ipVersion?: Array<'IPv4' | 'IPv6'>; /** * 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; /** * Filters the results by layer 7 mitigation product. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names used to label the series in the response. */ name?: Array; } export interface SummaryIndustryParams { /** * 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). Alternative to `dateRange`; provide together * with `dateStart`. When requesting comparison series, every series must resolve * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored * to the nearest 15 minutes before evaluation, so windows whose durations match * only before alignment may be rejected. */ dateEnd?: Array; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `w` * for weeks (up to `52w`). Append `control` to request the equivalent previous * period for comparison: the comparison window is shifted back by the current * window's length rounded up to a whole number of weeks, so it keeps the same * weekday alignment and does not overlap the current window (e.g. `7dcontrol` * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass * `7d` and `7dcontrol` to compare this week with the previous week. All series * must resolve to the same duration as the main series; relative ranges (including * `control`) satisfy this automatically. Use this parameter or set specific start * and end dates (`dateStart` and `dateEnd` parameters). */ dateRange?: Array; /** * Start of the date range. Alternative to `dateRange`; provide together with * `dateEnd`. When requesting comparison series, every series must resolve to the * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the * nearest 15 minutes before evaluation, so windows whose durations match only * before alignment may be rejected. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by HTTP method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * 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 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. Only supported on high-cardinality dimensions; otherwise * the request is rejected. Minimum value is 2. */ limitPerGroup?: 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; /** * Filters the results by layer 7 mitigation product. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names used to label the series in the response. */ name?: Array; } export interface SummaryIPVersionParams { /** * 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). Alternative to `dateRange`; provide together * with `dateStart`. When requesting comparison series, every series must resolve * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored * to the nearest 15 minutes before evaluation, so windows whose durations match * only before alignment may be rejected. */ dateEnd?: Array; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `w` * for weeks (up to `52w`). Append `control` to request the equivalent previous * period for comparison: the comparison window is shifted back by the current * window's length rounded up to a whole number of weeks, so it keeps the same * weekday alignment and does not overlap the current window (e.g. `7dcontrol` * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass * `7d` and `7dcontrol` to compare this week with the previous week. All series * must resolve to the same duration as the main series; relative ranges (including * `control`) satisfy this automatically. Use this parameter or set specific start * and end dates (`dateStart` and `dateEnd` parameters). */ dateRange?: Array; /** * Start of the date range. Alternative to `dateRange`; provide together with * `dateEnd`. When requesting comparison series, every series must resolve to the * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the * nearest 15 minutes before evaluation, so windows whose durations match only * before alignment may be rejected. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by HTTP method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * Filters results by HTTP version. */ httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>; /** * 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; /** * Filters the results by layer 7 mitigation product. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names used to label the series in the response. */ name?: Array; } export interface SummaryManagedRulesParams { /** * 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). Alternative to `dateRange`; provide together * with `dateStart`. When requesting comparison series, every series must resolve * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored * to the nearest 15 minutes before evaluation, so windows whose durations match * only before alignment may be rejected. */ dateEnd?: Array; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `w` * for weeks (up to `52w`). Append `control` to request the equivalent previous * period for comparison: the comparison window is shifted back by the current * window's length rounded up to a whole number of weeks, so it keeps the same * weekday alignment and does not overlap the current window (e.g. `7dcontrol` * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass * `7d` and `7dcontrol` to compare this week with the previous week. All series * must resolve to the same duration as the main series; relative ranges (including * `control`) satisfy this automatically. Use this parameter or set specific start * and end dates (`dateStart` and `dateEnd` parameters). */ dateRange?: Array; /** * Start of the date range. Alternative to `dateRange`; provide together with * `dateEnd`. When requesting comparison series, every series must resolve to the * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the * nearest 15 minutes before evaluation, so windows whose durations match only * before alignment may be rejected. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by HTTP method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * 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 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. Only supported on high-cardinality dimensions; otherwise * the request is rejected. Minimum value is 2. */ limitPerGroup?: 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; /** * Filters the results by layer 7 mitigation product. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names used to label the series in the response. */ name?: Array; } export interface SummaryMitigationProductParams { /** * 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). Alternative to `dateRange`; provide together * with `dateStart`. When requesting comparison series, every series must resolve * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored * to the nearest 15 minutes before evaluation, so windows whose durations match * only before alignment may be rejected. */ dateEnd?: Array; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `w` * for weeks (up to `52w`). Append `control` to request the equivalent previous * period for comparison: the comparison window is shifted back by the current * window's length rounded up to a whole number of weeks, so it keeps the same * weekday alignment and does not overlap the current window (e.g. `7dcontrol` * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass * `7d` and `7dcontrol` to compare this week with the previous week. All series * must resolve to the same duration as the main series; relative ranges (including * `control`) satisfy this automatically. Use this parameter or set specific start * and end dates (`dateStart` and `dateEnd` parameters). */ dateRange?: Array; /** * Start of the date range. Alternative to `dateRange`; provide together with * `dateEnd`. When requesting comparison series, every series must resolve to the * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the * nearest 15 minutes before evaluation, so windows whose durations match only * before alignment may be rejected. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by HTTP method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * 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 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. Only supported on high-cardinality dimensions; otherwise * the request is rejected. Minimum value is 2. */ limitPerGroup?: 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 SummaryVerticalParams { /** * 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). Alternative to `dateRange`; provide together * with `dateStart`. When requesting comparison series, every series must resolve * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored * to the nearest 15 minutes before evaluation, so windows whose durations match * only before alignment may be rejected. */ dateEnd?: Array; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `w` * for weeks (up to `52w`). Append `control` to request the equivalent previous * period for comparison: the comparison window is shifted back by the current * window's length rounded up to a whole number of weeks, so it keeps the same * weekday alignment and does not overlap the current window (e.g. `7dcontrol` * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass * `7d` and `7dcontrol` to compare this week with the previous week. All series * must resolve to the same duration as the main series; relative ranges (including * `control`) satisfy this automatically. Use this parameter or set specific start * and end dates (`dateStart` and `dateEnd` parameters). */ dateRange?: Array; /** * Start of the date range. Alternative to `dateRange`; provide together with * `dateEnd`. When requesting comparison series, every series must resolve to the * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the * nearest 15 minutes before evaluation, so windows whose durations match only * before alignment may be rejected. */ dateStart?: Array; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by HTTP method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * 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 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. Only supported on high-cardinality dimensions; otherwise * the request is rejected. Minimum value is 2. */ limitPerGroup?: 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; /** * Filters the results by layer 7 mitigation product. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names used to label the series in the response. */ name?: Array; } export declare namespace Summary { export { type SummaryHTTPMethodResponse as SummaryHTTPMethodResponse, type SummaryHTTPVersionResponse as SummaryHTTPVersionResponse, type SummaryIndustryResponse as SummaryIndustryResponse, type SummaryIPVersionResponse as SummaryIPVersionResponse, type SummaryManagedRulesResponse as SummaryManagedRulesResponse, type SummaryMitigationProductResponse as SummaryMitigationProductResponse, type SummaryVerticalResponse as SummaryVerticalResponse, type SummaryHTTPMethodParams as SummaryHTTPMethodParams, type SummaryHTTPVersionParams as SummaryHTTPVersionParams, type SummaryIndustryParams as SummaryIndustryParams, type SummaryIPVersionParams as SummaryIPVersionParams, type SummaryManagedRulesParams as SummaryManagedRulesParams, type SummaryMitigationProductParams as SummaryMitigationProductParams, type SummaryVerticalParams as SummaryVerticalParams, }; } //# sourceMappingURL=summary.d.ts.map