cloudflare
Version:
The official TypeScript library for the Cloudflare API
508 lines (428 loc) • 13.2 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../core/resource';
import * as DomainAPI from './domain';
import { BaseDomain, Domain, DomainGetParams, DomainGetResponse } from './domain';
import * as InternetServicesAPI from './internet-services';
import {
BaseInternetServices,
InternetServiceCategoriesParams,
InternetServiceCategoriesResponse,
InternetServiceTimeseriesGroupsParams,
InternetServiceTimeseriesGroupsResponse,
InternetServiceTopParams,
InternetServiceTopResponse,
InternetServices,
} from './internet-services';
import { APIPromise } from '../../../core/api-promise';
import { RequestOptions } from '../../../internal/request-options';
export class BaseRanking extends APIResource {
static override readonly _key: readonly ['radar', 'ranking'] = Object.freeze(['radar', 'ranking'] as const);
/**
* Retrieves domains rank over time.
*
* @example
* ```ts
* const response =
* await client.radar.ranking.timeseriesGroups();
* ```
*/
timeseriesGroups(
query: RankingTimeseriesGroupsParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<RankingTimeseriesGroupsResponse> {
return (
this._client.get('/radar/ranking/timeseries_groups', { query, ...options }) as APIPromise<{
result: RankingTimeseriesGroupsResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the top or trending domains based on their rank. Popular domains are
* domains of broad appeal based on how people use the Internet. Trending domains
* are domains that are generating a surge in interest. For more information on top
* domains, see https://blog.cloudflare.com/radar-domain-rankings/.
*
* @example
* ```ts
* const response = await client.radar.ranking.top();
* ```
*/
top(
query: RankingTopParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<RankingTopResponse> {
return (
this._client.get('/radar/ranking/top', { query, ...options }) as APIPromise<{
result: RankingTopResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export class Ranking extends BaseRanking {
domain: DomainAPI.Domain = new DomainAPI.Domain(this._client);
internetServices: InternetServicesAPI.InternetServices = new InternetServicesAPI.InternetServices(
this._client,
);
}
export interface RankingTimeseriesGroupsResponse {
/**
* Metadata for the results.
*/
meta: RankingTimeseriesGroupsResponse.Meta;
serie_0: RankingTimeseriesGroupsResponse.Serie0;
}
export namespace RankingTimeseriesGroupsResponse {
/**
* Metadata for the results.
*/
export 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<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 {
/**
* 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: '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<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 Serie0 {
timestamps: Array<string>;
[k: string]: Array<string | number> | Array<string> | undefined;
}
}
export interface RankingTopResponse {
meta: RankingTopResponse.Meta;
top_0: Array<RankingTopResponse.Top0>;
}
export namespace RankingTopResponse {
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo | null;
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';
top_0: Meta.Top0;
/**
* 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 {
/**
* 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: '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<string>;
}
}
export interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
export interface Top0 {
date: string;
}
export interface Unit {
name: string;
value: string;
}
}
export interface Top0 {
categories: Array<Top0.Category>;
domain: string;
rank: number;
/**
* Only available in TRENDING rankings.
*/
pctRankChange?: number;
}
export namespace Top0 {
export interface Category {
id: number;
name: string;
superCategoryId: number;
}
}
}
export interface RankingTimeseriesGroupsParams {
/**
* 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<string>;
/**
* Filters results by relative date range ending at the current time, with each
* value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>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<string>;
/**
* 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<string>;
/**
* Filters results by domain category.
*/
domainCategory?: Array<string>;
/**
* Filters results by domain name. Specify a comma-separated list of domain names.
*/
domains?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Filters results by location. Specify a comma-separated list of alpha-2 location
* codes.
*/
location?: Array<string>;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
/**
* The ranking type.
*/
rankingType?: 'POPULAR' | 'TRENDING_RISE' | 'TRENDING_STEADY';
}
export interface RankingTopParams {
/**
* Filters results by the specified array of dates.
*/
date?: Array<string>;
/**
* Filters results by domain category.
*/
domainCategory?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Filters results by location. Specify a comma-separated list of alpha-2 location
* codes.
*/
location?: Array<string>;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
/**
* The ranking type.
*/
rankingType?: 'POPULAR' | 'TRENDING_RISE' | 'TRENDING_STEADY';
}
Ranking.Domain = Domain;
Ranking.BaseDomain = BaseDomain;
Ranking.InternetServices = InternetServices;
Ranking.BaseInternetServices = BaseInternetServices;
export declare namespace Ranking {
export {
type RankingTimeseriesGroupsResponse as RankingTimeseriesGroupsResponse,
type RankingTopResponse as RankingTopResponse,
type RankingTimeseriesGroupsParams as RankingTimeseriesGroupsParams,
type RankingTopParams as RankingTopParams,
};
export {
Domain as Domain,
BaseDomain as BaseDomain,
type DomainGetResponse as DomainGetResponse,
type DomainGetParams as DomainGetParams,
};
export {
InternetServices as InternetServices,
BaseInternetServices as BaseInternetServices,
type InternetServiceCategoriesResponse as InternetServiceCategoriesResponse,
type InternetServiceTimeseriesGroupsResponse as InternetServiceTimeseriesGroupsResponse,
type InternetServiceTopResponse as InternetServiceTopResponse,
type InternetServiceCategoriesParams as InternetServiceCategoriesParams,
type InternetServiceTimeseriesGroupsParams as InternetServiceTimeseriesGroupsParams,
type InternetServiceTopParams as InternetServiceTopParams,
};
}