cloudflare
Version:
The official TypeScript library for the Cloudflare API
2,444 lines (2,132 loc) • 64.4 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 Summary extends APIResource {
/**
* Retrieves the distribution of DNS queries by cache status.
*
* @example
* ```ts
* const response = await client.radar.dns.summary.cacheHit();
* ```
*/
cacheHit(
query?: SummaryCacheHitParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryCacheHitResponse>;
cacheHit(options?: Core.RequestOptions): Core.APIPromise<SummaryCacheHitResponse>;
cacheHit(
query: SummaryCacheHitParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryCacheHitResponse> {
if (isRequestOptions(query)) {
return this.cacheHit({}, query);
}
return (
this._client.get('/radar/dns/summary/cache_hit', { query, ...options }) as Core.APIPromise<{
result: SummaryCacheHitResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions)
* support.
*
* @example
* ```ts
* const response = await client.radar.dns.summary.dnssec();
* ```
*/
dnssec(query?: SummaryDNSSECParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECResponse>;
dnssec(options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECResponse>;
dnssec(
query: SummaryDNSSECParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryDNSSECResponse> {
if (isRequestOptions(query)) {
return this.dnssec({}, query);
}
return (
this._client.get('/radar/dns/summary/dnssec', { query, ...options }) as Core.APIPromise<{
result: SummaryDNSSECResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions)
* client awareness.
*
* @example
* ```ts
* const response =
* await client.radar.dns.summary.dnssecAware();
* ```
*/
dnssecAware(
query?: SummaryDNSSECAwareParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryDNSSECAwareResponse>;
dnssecAware(options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECAwareResponse>;
dnssecAware(
query: SummaryDNSSECAwareParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryDNSSECAwareResponse> {
if (isRequestOptions(query)) {
return this.dnssecAware({}, query);
}
return (
this._client.get('/radar/dns/summary/dnssec_aware', { query, ...options }) as Core.APIPromise<{
result: SummaryDNSSECAwareResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNSSEC-validated answers by end-to-end security
* status.
*
* @example
* ```ts
* const response = await client.radar.dns.summary.dnssecE2E();
* ```
*/
dnssecE2E(
query?: SummaryDNSSECE2EParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryDNSSECE2EResponse>;
dnssecE2E(options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECE2EResponse>;
dnssecE2E(
query: SummaryDNSSECE2EParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryDNSSECE2EResponse> {
if (isRequestOptions(query)) {
return this.dnssecE2E({}, query);
}
return (
this._client.get('/radar/dns/summary/dnssec_e2e', { query, ...options }) as Core.APIPromise<{
result: SummaryDNSSECE2EResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS queries by IP version.
*
* @example
* ```ts
* const response = await client.radar.dns.summary.ipVersion();
* ```
*/
ipVersion(
query?: SummaryIPVersionParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryIPVersionResponse>;
ipVersion(options?: Core.RequestOptions): Core.APIPromise<SummaryIPVersionResponse>;
ipVersion(
query: SummaryIPVersionParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryIPVersionResponse> {
if (isRequestOptions(query)) {
return this.ipVersion({}, query);
}
return (
this._client.get('/radar/dns/summary/ip_version', { query, ...options }) as Core.APIPromise<{
result: SummaryIPVersionResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS queries by matching answers.
*
* @example
* ```ts
* const response =
* await client.radar.dns.summary.matchingAnswer();
* ```
*/
matchingAnswer(
query?: SummaryMatchingAnswerParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryMatchingAnswerResponse>;
matchingAnswer(options?: Core.RequestOptions): Core.APIPromise<SummaryMatchingAnswerResponse>;
matchingAnswer(
query: SummaryMatchingAnswerParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryMatchingAnswerResponse> {
if (isRequestOptions(query)) {
return this.matchingAnswer({}, query);
}
return (
this._client.get('/radar/dns/summary/matching_answer', { query, ...options }) as Core.APIPromise<{
result: SummaryMatchingAnswerResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS queries by DNS transport protocol.
*
* @example
* ```ts
* const response = await client.radar.dns.summary.protocol();
* ```
*/
protocol(
query?: SummaryProtocolParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryProtocolResponse>;
protocol(options?: Core.RequestOptions): Core.APIPromise<SummaryProtocolResponse>;
protocol(
query: SummaryProtocolParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryProtocolResponse> {
if (isRequestOptions(query)) {
return this.protocol({}, query);
}
return (
this._client.get('/radar/dns/summary/protocol', { query, ...options }) as Core.APIPromise<{
result: SummaryProtocolResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS queries by type.
*
* @example
* ```ts
* const response = await client.radar.dns.summary.queryType();
* ```
*/
queryType(
query?: SummaryQueryTypeParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryQueryTypeResponse>;
queryType(options?: Core.RequestOptions): Core.APIPromise<SummaryQueryTypeResponse>;
queryType(
query: SummaryQueryTypeParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryQueryTypeResponse> {
if (isRequestOptions(query)) {
return this.queryType({}, query);
}
return (
this._client.get('/radar/dns/summary/query_type', { query, ...options }) as Core.APIPromise<{
result: SummaryQueryTypeResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS queries by response code.
*
* @example
* ```ts
* const response =
* await client.radar.dns.summary.responseCode();
* ```
*/
responseCode(
query?: SummaryResponseCodeParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryResponseCodeResponse>;
responseCode(options?: Core.RequestOptions): Core.APIPromise<SummaryResponseCodeResponse>;
responseCode(
query: SummaryResponseCodeParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryResponseCodeResponse> {
if (isRequestOptions(query)) {
return this.responseCode({}, query);
}
return (
this._client.get('/radar/dns/summary/response_code', { query, ...options }) as Core.APIPromise<{
result: SummaryResponseCodeResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of DNS queries by minimum response TTL.
*
* @example
* ```ts
* const response =
* await client.radar.dns.summary.responseTTL();
* ```
*/
responseTTL(
query?: SummaryResponseTTLParams,
options?: Core.RequestOptions,
): Core.APIPromise<SummaryResponseTTLResponse>;
responseTTL(options?: Core.RequestOptions): Core.APIPromise<SummaryResponseTTLResponse>;
responseTTL(
query: SummaryResponseTTLParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<SummaryResponseTTLResponse> {
if (isRequestOptions(query)) {
return this.responseTTL({}, query);
}
return (
this._client.get('/radar/dns/summary/response_ttl', { query, ...options }) as Core.APIPromise<{
result: SummaryResponseTTLResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export interface SummaryCacheHitResponse {
/**
* Metadata for the results.
*/
meta: SummaryCacheHitResponse.Meta;
summary_0: SummaryCacheHitResponse.Summary0;
}
export namespace SummaryCacheHitResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
NEGATIVE: string;
/**
* A numeric string.
*/
POSITIVE: string;
}
}
export interface SummaryDNSSECResponse {
/**
* Metadata for the results.
*/
meta: SummaryDNSSECResponse.Meta;
summary_0: SummaryDNSSECResponse.Summary0;
}
export namespace SummaryDNSSECResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
INSECURE: string;
/**
* A numeric string.
*/
INVALID: string;
/**
* A numeric string.
*/
OTHER: string;
/**
* A numeric string.
*/
SECURE: string;
}
}
export interface SummaryDNSSECAwareResponse {
/**
* Metadata for the results.
*/
meta: SummaryDNSSECAwareResponse.Meta;
summary_0: SummaryDNSSECAwareResponse.Summary0;
}
export namespace SummaryDNSSECAwareResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
NOT_SUPPORTED: string;
/**
* A numeric string.
*/
SUPPORTED: string;
}
}
export interface SummaryDNSSECE2EResponse {
/**
* Metadata for the results.
*/
meta: SummaryDNSSECE2EResponse.Meta;
summary_0: SummaryDNSSECE2EResponse.Summary0;
}
export namespace SummaryDNSSECE2EResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
NEGATIVE: string;
/**
* A numeric string.
*/
POSITIVE: string;
}
}
export interface SummaryIPVersionResponse {
/**
* Metadata for the results.
*/
meta: SummaryIPVersionResponse.Meta;
summary_0: SummaryIPVersionResponse.Summary0;
}
export namespace SummaryIPVersionResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
IPv4: string;
/**
* A numeric string.
*/
IPv6: string;
}
}
export interface SummaryMatchingAnswerResponse {
/**
* Metadata for the results.
*/
meta: SummaryMatchingAnswerResponse.Meta;
summary_0: SummaryMatchingAnswerResponse.Summary0;
}
export namespace SummaryMatchingAnswerResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
NEGATIVE: string;
/**
* A numeric string.
*/
POSITIVE: string;
}
}
export interface SummaryProtocolResponse {
/**
* Metadata for the results.
*/
meta: SummaryProtocolResponse.Meta;
summary_0: SummaryProtocolResponse.Summary0;
}
export namespace SummaryProtocolResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
HTTPS: string;
/**
* A numeric string.
*/
TCP: string;
/**
* A numeric string.
*/
TLS: string;
/**
* A numeric string.
*/
UDP: string;
}
}
export interface SummaryQueryTypeResponse {
/**
* Metadata for the results.
*/
meta: SummaryQueryTypeResponse.Meta;
summary_0: { [key: string]: string };
}
export namespace SummaryQueryTypeResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 SummaryResponseCodeResponse {
/**
* Metadata for the results.
*/
meta: SummaryResponseCodeResponse.Meta;
summary_0: { [key: string]: string };
}
export namespace SummaryResponseCodeResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 SummaryResponseTTLResponse {
/**
* Metadata for the results.
*/
meta: SummaryResponseTTLResponse.Meta;
summary_0: SummaryResponseTTLResponse.Summary0;
}
export namespace SummaryResponseTTLResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 Summary0 {
/**
* A numeric string.
*/
gt_15m_lte_1h: string;
/**
* A numeric string.
*/
gt_1d_lte_1w: string;
/**
* A numeric string.
*/
gt_1h_lte_1d: string;
/**
* A numeric string.
*/
gt_1m_lte_5m: string;
/**
* A numeric string.
*/
gt_1w: string;
/**
* A numeric string.
*/
gt_5m_lte_15m: string;
/**
* A numeric string.
*/
lte_1m: string;
}
}
export interface SummaryCacheHitParams {
/**
* 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 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>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* 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>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: boolean;
/**
* Filters results by DNS transport protocol.
*/
protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS';
/**
* Filters results by DNS query type.
*/
queryType?:
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT'
| 'SIG'
| 'SINK'
| 'SMIMEA'
| 'SOA'
| 'SPF'
| 'SRV'
| 'SSHFP'
| 'SVCB'
| 'TA'
| 'TALINK'
| 'TKEY'
| 'TLSA'
| 'TSIG'
| 'TXT'
| 'UINFO'
| 'UID'
| 'UNSPEC'
| 'URI'
| 'WKS'
| 'X25'
| 'ZONEMD'
| null;
/**
* Filters results by DNS response code.
*/
responseCode?:
| 'NOERROR'
| 'FORMERR'
| 'SERVFAIL'
| 'NXDOMAIN'
| 'NOTIMP'
| 'REFUSED'
| 'YXDOMAIN'
| 'YXRRSET'
| 'NXRRSET'
| 'NOTAUTH'
| 'NOTZONE'
| 'BADSIG'
| 'BADKEY'
| 'BADTIME'
| 'BADMODE'
| 'BADNAME'
| 'BADALG'
| 'BADTRUNC'
| 'BADCOOKIE';
/**
* Filters results by country code top-level domain (ccTLD).
*/
tld?: Array<string>;
}
export interface SummaryDNSSECParams {
/**
* 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 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>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* 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>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: boolean;
/**
* Filters results by DNS transport protocol.
*/
protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS';
/**
* Filters results by DNS query type.
*/
queryType?:
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT'
| 'SIG'
| 'SINK'
| 'SMIMEA'
| 'SOA'
| 'SPF'
| 'SRV'
| 'SSHFP'
| 'SVCB'
| 'TA'
| 'TALINK'
| 'TKEY'
| 'TLSA'
| 'TSIG'
| 'TXT'
| 'UINFO'
| 'UID'
| 'UNSPEC'
| 'URI'
| 'WKS'
| 'X25'
| 'ZONEMD'
| null;
/**
* Filters results by DNS response code.
*/
responseCode?:
| 'NOERROR'
| 'FORMERR'
| 'SERVFAIL'
| 'NXDOMAIN'
| 'NOTIMP'
| 'REFUSED'
| 'YXDOMAIN'
| 'YXRRSET'
| 'NXRRSET'
| 'NOTAUTH'
| 'NOTZONE'
| 'BADSIG'
| 'BADKEY'
| 'BADTIME'
| 'BADMODE'
| 'BADNAME'
| 'BADALG'
| 'BADTRUNC'
| 'BADCOOKIE';
/**
* Filters results by country code top-level domain (ccTLD).
*/
tld?: Array<string>;
}
export interface SummaryDNSSECAwareParams {
/**
* 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 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>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* 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>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: boolean;
/**
* Filters results by DNS transport protocol.
*/
protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS';
/**
* Filters results by DNS query type.
*/
queryType?:
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT'
| 'SIG'
| 'SINK'
| 'SMIMEA'
| 'SOA'
| 'SPF'
| 'SRV'
| 'SSHFP'
| 'SVCB'
| 'TA'
| 'TALINK'
| 'TKEY'
| 'TLSA'
| 'TSIG'
| 'TXT'
| 'UINFO'
| 'UID'
| 'UNSPEC'
| 'URI'
| 'WKS'
| 'X25'
| 'ZONEMD'
| null;
/**
* Filters results by DNS response code.
*/
responseCode?:
| 'NOERROR'
| 'FORMERR'
| 'SERVFAIL'
| 'NXDOMAIN'
| 'NOTIMP'
| 'REFUSED'
| 'YXDOMAIN'
| 'YXRRSET'
| 'NXRRSET'
| 'NOTAUTH'
| 'NOTZONE'
| 'BADSIG'
| 'BADKEY'
| 'BADTIME'
| 'BADMODE'
| 'BADNAME'
| 'BADALG'
| 'BADTRUNC'
| 'BADCOOKIE';
/**
* Filters results by country code top-level domain (ccTLD).
*/
tld?: Array<string>;
}
export interface SummaryDNSSECE2EParams {
/**
* 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 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>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* 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>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: boolean;
/**
* Filters results by DNS transport protocol.
*/
protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS';
/**
* Filters results by DNS query type.
*/
queryType?:
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT'
| 'SIG'
| 'SINK'
| 'SMIMEA'
| 'SOA'
| 'SPF'
| 'SRV'
| 'SSHFP'
| 'SVCB'
| 'TA'
| 'TALINK'
| 'TKEY'
| 'TLSA'
| 'TSIG'
| 'TXT'
| 'UINFO'
| 'UID'
| 'UNSPEC'
| 'URI'
| 'WKS'
| 'X25'
| 'ZONEMD'
| null;
/**
* Filters results by DNS response code.
*/
responseCode?:
| 'NOERROR'
| 'FORMERR'
| 'SERVFAIL'
| 'NXDOMAIN'
| 'NOTIMP'
| 'REFUSED'
| 'YXDOMAIN'
| 'YXRRSET'
| 'NXRRSET'
| 'NOTAUTH'
| 'NOTZONE'
| 'BADSIG'
| 'BADKEY'
| 'BADTIME'
| 'BADMODE'
| 'BADNAME'
| 'BADALG'
| 'BADTRUNC'
| 'BADCOOKIE';
/**
* Filters results by country code top-level domain (ccTLD).
*/
tld?: Array<string>;
}
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<string>;
/**
* 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>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* 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>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: boolean;
/**
* Filters results by DNS transport protocol.
*/
protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS';
/**
* Filters results by DNS query type.
*/
queryType?:
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT'
| 'SIG'
| 'SINK'
| 'SMIMEA'
| 'SOA'
| 'SPF'
| 'SRV'
| 'SSHFP'
| 'SVCB'
| 'TA'
| 'TALINK'
| 'TKEY'
| 'TLSA'
| 'TSIG'
| 'TXT'
| 'UINFO'
| 'UID'
| 'UNSPEC'
| 'URI'
| 'WKS'
| 'X25'
| 'ZONEMD'
| null;
/**
* Filters results by DNS response code.
*/
responseCode?:
| 'NOERROR'
| 'FORMERR'
| 'SERVFAIL'
| 'NXDOMAIN'
| 'NOTIMP'
| 'REFUSED'
| 'YXDOMAIN'
| 'YXRRSET'
| 'NXRRSET'
| 'NOTAUTH'
| 'NOTZONE'
| 'BADSIG'
| 'BADKEY'
| 'BADTIME'
| 'BADMODE'
| 'BADNAME'
| 'BADALG'
| 'BADTRUNC'
| 'BADCOOKIE';
/**
* Filters results by country code top-level domain (ccTLD).
*/
tld?: Array<string>;
}
export interface SummaryMatchingAnswerParams {
/**
* 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 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>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* 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>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: boolean;
/**
* Filters results by DNS transport protocol.
*/
protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS';
/**
* Filters results by DNS query type.
*/
queryType?:
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT