cloudflare
Version:
The official TypeScript library for the Cloudflare API
111 lines • 4.27 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
export declare class TimeseriesGroups extends APIResource {
/**
* Retrieves the distribution of HTTP authentication requests by bot class over
* time.
*/
botClass(query?: TimeseriesGroupBotClassParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBotClassResponse>;
botClass(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBotClassResponse>;
/**
* Retrieves the distribution of HTTP authentication requests by compromised
* credential status over time.
*/
compromised(query?: TimeseriesGroupCompromisedParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupCompromisedResponse>;
compromised(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupCompromisedResponse>;
}
export interface TimeseriesGroupBotClassResponse {
meta: unknown;
serie_0: TimeseriesGroupBotClassResponse.Serie0;
}
export declare namespace TimeseriesGroupBotClassResponse {
interface Serie0 {
bot: Array<string>;
human: Array<string>;
timestamps: Array<string>;
}
}
export interface TimeseriesGroupCompromisedResponse {
meta: unknown;
serie_0: TimeseriesGroupCompromisedResponse.Serie0;
}
export declare namespace TimeseriesGroupCompromisedResponse {
interface Serie0 {
CLEAN: Array<string>;
COMPROMISED: Array<string>;
timestamps: Array<string>;
}
}
export interface TimeseriesGroupBotClassParams {
/**
* Aggregation interval results should be returned in (for example, 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 compromised credential status (clean vs. compromised).
*/
compromised?: Array<'CLEAN' | 'COMPROMISED'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified 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';
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
}
export interface TimeseriesGroupCompromisedParams {
/**
* Aggregation interval results should be returned in (for example, 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 class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified 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';
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
}
export declare namespace TimeseriesGroups {
export { type TimeseriesGroupBotClassResponse as TimeseriesGroupBotClassResponse, type TimeseriesGroupCompromisedResponse as TimeseriesGroupCompromisedResponse, type TimeseriesGroupBotClassParams as TimeseriesGroupBotClassParams, type TimeseriesGroupCompromisedParams as TimeseriesGroupCompromisedParams, };
}
//# sourceMappingURL=timeseries-groups.d.ts.map