import { APIResource } from "../../../core/resource.mjs"; import { APIPromise } from "../../../core/api-promise.mjs"; import { RequestOptions } from "../../../internal/request-options.mjs"; export declare class BaseTimeseriesGroups extends APIResource { static readonly _key: readonly ['radar', 'ai', 'timeseriesGroups']; /** * Retrieves an aggregated summary of AI bots HTTP requests grouped by the * specified dimension. * * @deprecated Use [Radar > AI > Bots > Summary](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/summary_v2/) instead. */ summary(dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL' | 'CONTENT_TYPE' | 'RESPONSE_STATUS' | 'RESPONSE_STATUS_CATEGORY', query?: TimeseriesGroupSummaryParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves AI bots HTTP request volume over time. * * @deprecated Use [Radar > AI > Bots > Timeseries](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/timeseries/) instead. */ timeseries(query?: TimeseriesGroupTimeseriesParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of HTTP requests from AI bots, grouped by the * specified dimension over time. * * @deprecated Use [Radar > AI > Bots > Timeseries Groups](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/timeseries_groups/) instead. */ timeseriesGroups(dimension: 'USER_AGENT' | 'CRAWL_PURPOSE' | 'INDUSTRY' | 'VERTICAL' | 'CONTENT_TYPE' | 'RESPONSE_STATUS' | 'RESPONSE_STATUS_CATEGORY', query?: TimeseriesGroupTimeseriesGroupsParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of traffic by AI user agent over time. * * @deprecated Use [Radar AI Bots Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/timeseries_groups/) instead. */ userAgent(query?: TimeseriesGroupUserAgentParams | null | undefined, options?: RequestOptions): APIPromise; } export declare class TimeseriesGroups extends BaseTimeseriesGroups { } export interface TimeseriesGroupSummaryResponse { /** * Metadata for the results. */ meta: TimeseriesGroupSummaryResponse.Meta; summary_0: { [key: string]: string; }; } export declare namespace TimeseriesGroupSummaryResponse { /** * 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 TimeseriesGroupTimeseriesResponse { /** * Metadata for the results. */ meta: TimeseriesGroupTimeseriesResponse.Meta; [k: string]: TimeseriesGroupTimeseriesResponse.unnamed_schema_ref_75bae70cf28e6bcef364b9840db3bdeb | TimeseriesGroupTimeseriesResponse.Meta | undefined; } export declare namespace TimeseriesGroupTimeseriesResponse { /** * 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 { /** * 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 unnamed_schema_ref_75bae70cf28e6bcef364b9840db3bdeb { timestamps: Array; values: Array; } } export interface TimeseriesGroupTimeseriesGroupsResponse { /** * Metadata for the results. */ meta: TimeseriesGroupTimeseriesGroupsResponse.Meta; serie_0: TimeseriesGroupTimeseriesGroupsResponse.Serie0; } export declare namespace TimeseriesGroupTimeseriesGroupsResponse { /** * 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 { /** * 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 Serie0 { timestamps: Array; [k: string]: Array | Array | undefined; } } export interface TimeseriesGroupUserAgentResponse { /** * Metadata for the results. */ meta: TimeseriesGroupUserAgentResponse.Meta; serie_0: TimeseriesGroupUserAgentResponse.Serie0; } export declare namespace TimeseriesGroupUserAgentResponse { /** * 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 { /** * 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 Serie0 { timestamps: Array; [k: string]: Array | Array | undefined; } } export interface TimeseriesGroupSummaryParams { /** * 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 content type category. When set, results can only be further * filtered by location, continent, or Autonomous System. */ contentType?: Array<'HTML' | 'IMAGES' | 'JSON' | 'JAVASCRIPT' | 'CSS' | 'PLAIN_TEXT' | 'FONTS' | 'XML' | 'YAML' | 'VIDEO' | 'AUDIO' | 'MARKDOWN' | 'DOCUMENTS' | 'BINARY' | 'SERIALIZATION' | 'OTHER'>; /** * 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; /** * Filters results by bot crawl purpose. */ crawlPurpose?: 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 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. 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; /** * Filters results by HTTP response status code (e.g. 200, 403, 404). Only * [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) * are accepted. */ responseStatus?: Array; /** * Filters results by HTTP response status code category. */ responseStatusCategory?: Array<'INFORMATIONAL' | 'SUCCESS' | 'REDIRECTION' | 'CLIENT_ERROR' | 'SERVER_ERROR'>; /** * Filters results by user agent. */ userAgent?: Array; /** * Filters results by vertical. */ vertical?: Array; } export interface TimeseriesGroupTimeseriesParams { /** * 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/). * When omitted, the interval is auto-selected from the requested date range; finer * intervals are only available for shorter ranges. If the requested interval is * too granular for the date range, the request is rejected. */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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 content type category. When set, results can only be further * filtered by location, continent, or Autonomous System. */ contentType?: Array<'HTML' | 'IMAGES' | 'JSON' | 'JAVASCRIPT' | 'CSS' | 'PLAIN_TEXT' | 'FONTS' | 'XML' | 'YAML' | 'VIDEO' | 'AUDIO' | 'MARKDOWN' | 'DOCUMENTS' | 'BINARY' | 'SERIALIZATION' | 'OTHER'>; /** * 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; /** * Filters results by bot crawl purpose. */ crawlPurpose?: 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 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. 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; /** * Filters results by HTTP response status code (e.g. 200, 403, 404). Only * [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) * are accepted. */ responseStatus?: Array; /** * Filters results by HTTP response status code category. */ responseStatusCategory?: Array<'INFORMATIONAL' | 'SUCCESS' | 'REDIRECTION' | 'CLIENT_ERROR' | 'SERVER_ERROR'>; /** * Filters results by user agent. */ userAgent?: Array; /** * Filters results by vertical. */ vertical?: Array; } export interface TimeseriesGroupTimeseriesGroupsParams { /** * 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/). * When omitted, the interval is auto-selected from the requested date range; finer * intervals are only available for shorter ranges. If the requested interval is * too granular for the date range, the request is rejected. */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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 content type category. When set, results can only be further * filtered by location, continent, or Autonomous System. */ contentType?: Array<'HTML' | 'IMAGES' | 'JSON' | 'JAVASCRIPT' | 'CSS' | 'PLAIN_TEXT' | 'FONTS' | 'XML' | 'YAML' | 'VIDEO' | 'AUDIO' | 'MARKDOWN' | 'DOCUMENTS' | 'BINARY' | 'SERIALIZATION' | 'OTHER'>; /** * 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; /** * Filters results by bot crawl purpose. */ crawlPurpose?: 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 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. 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; /** * Normalization method applied to the results. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). * `PERCENTAGE_CHANGE` requires exactly one comparison series (e.g. a `control` * date range). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX' | 'PERCENTAGE_CHANGE'; /** * Filters results by HTTP response status code (e.g. 200, 403, 404). Only * [IANA-registered codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) * are accepted. */ responseStatus?: Array; /** * Filters results by HTTP response status code category. */ responseStatusCategory?: Array<'INFORMATIONAL' | 'SUCCESS' | 'REDIRECTION' | 'CLIENT_ERROR' | 'SERVER_ERROR'>; /** * Filters results by user agent. */ userAgent?: Array; /** * Filters results by vertical. */ vertical?: Array; } export interface TimeseriesGroupUserAgentParams { /** * 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/). * When omitted, the interval is auto-selected from the requested date range; finer * intervals are only available for shorter ranges. If the requested interval is * too granular for the date range, the request is rejected. */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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'; /** * 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 declare namespace TimeseriesGroups { export { type TimeseriesGroupSummaryResponse as TimeseriesGroupSummaryResponse, type TimeseriesGroupTimeseriesResponse as TimeseriesGroupTimeseriesResponse, type TimeseriesGroupTimeseriesGroupsResponse as TimeseriesGroupTimeseriesGroupsResponse, type TimeseriesGroupUserAgentResponse as TimeseriesGroupUserAgentResponse, type TimeseriesGroupSummaryParams as TimeseriesGroupSummaryParams, type TimeseriesGroupTimeseriesParams as TimeseriesGroupTimeseriesParams, type TimeseriesGroupTimeseriesGroupsParams as TimeseriesGroupTimeseriesGroupsParams, type TimeseriesGroupUserAgentParams as TimeseriesGroupUserAgentParams, }; } //# sourceMappingURL=timeseries-groups.d.mts.map