# Ranking

## Get domains rank time series

`radar.ranking.timeseries_groups(RankingTimeseriesGroupsParams**kwargs)  -> RankingTimeseriesGroupsResponse`

**get** `/radar/ranking/timeseries_groups`

Retrieves domains rank over time.

### Parameters

- `date_end: Optional[Sequence[Union[str, datetime]]]`

  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.

- `date_range: Optional[Sequence[str]]`

  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).

- `date_start: Optional[Sequence[Union[str, datetime]]]`

  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.

- `domain_category: Optional[Sequence[str]]`

  Filters results by domain category.

- `domains: Optional[Sequence[str]]`

  Filters results by domain name. Specify a comma-separated list of domain names.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `limit: Optional[int]`

  Limits the number of objects returned in the response.

- `location: Optional[Sequence[str]]`

  Filters results by location. Specify a comma-separated list of alpha-2 location codes.

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

- `ranking_type: Optional[Literal["POPULAR", "TRENDING_RISE", "TRENDING_STEADY"]]`

  The ranking type.

  - `"POPULAR"`

  - `"TRENDING_RISE"`

  - `"TRENDING_STEADY"`

### Returns

- `class RankingTimeseriesGroupsResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `agg_interval: Literal["FIFTEEN_MINUTES", "ONE_HOUR", "ONE_DAY", 2 more]`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `serie_0: Serie0`

    - `timestamps: List[datetime]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.ranking.timeseries_groups()
print(response.meta)
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "serie_0": {
      "timestamps": [
        "2019-12-27T18:11:19.117Z"
      ]
    }
  },
  "success": true
}
```

## Get top or trending domains

`radar.ranking.top(RankingTopParams**kwargs)  -> RankingTopResponse`

**get** `/radar/ranking/top`

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/.

### Parameters

- `date: Optional[Sequence[Union[null, null]]]`

  Filters results by the specified array of dates.

- `domain_category: Optional[Sequence[str]]`

  Filters results by domain category.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `limit: Optional[int]`

  Limits the number of objects returned in the response.

- `location: Optional[Sequence[str]]`

  Filters results by location. Specify a comma-separated list of alpha-2 location codes.

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

- `ranking_type: Optional[Literal["POPULAR", "TRENDING_RISE", "TRENDING_STEADY"]]`

  The ranking type.

  - `"POPULAR"`

  - `"TRENDING_RISE"`

  - `"TRENDING_STEADY"`

### Returns

- `class RankingTopResponse: …`

  - `meta: Meta`

    - `confidence_info: Optional[MetaConfidenceInfo]`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `top_0: List[Top0]`

    - `categories: List[Top0Category]`

      - `id: float`

      - `name: str`

      - `super_category_id: float`

    - `domain: str`

    - `rank: int`

    - `pct_rank_change: Optional[float]`

      Only available in TRENDING rankings.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.ranking.top()
print(response.meta)
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "top_0": [
      {
        "categories": [
          {
            "id": 81,
            "name": "Content Servers",
            "superCategoryId": 26
          }
        ],
        "domain": "google.com",
        "rank": 1,
        "pctRankChange": 10.8
      }
    ]
  },
  "success": true
}
```

## Domain Types

### Ranking Timeseries Groups Response

- `class RankingTimeseriesGroupsResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `agg_interval: Literal["FIFTEEN_MINUTES", "ONE_HOUR", "ONE_DAY", 2 more]`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `serie_0: Serie0`

    - `timestamps: List[datetime]`

### Ranking Top Response

- `class RankingTopResponse: …`

  - `meta: Meta`

    - `confidence_info: Optional[MetaConfidenceInfo]`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `top_0: List[Top0]`

    - `categories: List[Top0Category]`

      - `id: float`

      - `name: str`

      - `super_category_id: float`

    - `domain: str`

    - `rank: int`

    - `pct_rank_change: Optional[float]`

      Only available in TRENDING rankings.

# Domain

## Get domain rank details

`radar.ranking.domain.get(strdomain, DomainGetParams**kwargs)  -> DomainGetResponse`

**get** `/radar/ranking/domain/{domain}`

Retrieves domain rank details. Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints.

### Parameters

- `domain: str`

  Domain name.

- `date: Optional[Sequence[Union[null, null]]]`

  Filters results by the specified array of dates.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `include_top_locations: Optional[bool]`

  Includes top locations in the response.

- `limit: Optional[int]`

  Limits the number of objects returned in the response.

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

- `ranking_type: Optional[Literal["POPULAR", "TRENDING_RISE", "TRENDING_STEADY"]]`

  The ranking type.

  - `"POPULAR"`

  - `"TRENDING_RISE"`

  - `"TRENDING_STEADY"`

### Returns

- `class DomainGetResponse: …`

  - `details_0: Details0`

    - `categories: List[Details0Category]`

      - `id: int`

      - `name: str`

      - `super_category_id: int`

    - `bucket: Optional[str]`

      Only available in POPULAR ranking for the most recent ranking.

    - `rank: Optional[int]`

    - `top_locations: Optional[List[Details0TopLocation]]`

      - `location_code: str`

      - `location_name: str`

      - `rank: int`

  - `meta: Meta`

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
domain = client.radar.ranking.domain.get(
    domain="google.com",
)
print(domain.details_0)
```

#### Response

```json
{
  "result": {
    "details_0": {
      "categories": [
        {
          "id": 81,
          "name": "Content Servers",
          "superCategoryId": 26
        }
      ],
      "bucket": "2000",
      "rank": 3,
      "top_locations": [
        {
          "locationCode": "US",
          "locationName": "United States",
          "rank": 1
        }
      ]
    },
    "meta": {
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Domain Get Response

- `class DomainGetResponse: …`

  - `details_0: Details0`

    - `categories: List[Details0Category]`

      - `id: int`

      - `name: str`

      - `super_category_id: int`

    - `bucket: Optional[str]`

      Only available in POPULAR ranking for the most recent ranking.

    - `rank: Optional[int]`

    - `top_locations: Optional[List[Details0TopLocation]]`

      - `location_code: str`

      - `location_name: str`

      - `rank: int`

  - `meta: Meta`

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

# Internet Services

## Get Internet services rank time series

`radar.ranking.internet_services.timeseries_groups(InternetServiceTimeseriesGroupsParams**kwargs)  -> InternetServiceTimeseriesGroupsResponse`

**get** `/radar/ranking/internet_services/timeseries_groups`

Retrieves Internet Services rank update changes over time.

### Parameters

- `date_end: Optional[Sequence[Union[str, datetime]]]`

  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.

- `date_range: Optional[Sequence[str]]`

  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).

- `date_start: Optional[Sequence[Union[str, datetime]]]`

  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.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `limit: Optional[int]`

  Limits the number of objects returned in the response.

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

- `service_category: Optional[Sequence[str]]`

  Filters results by Internet service category.

### Returns

- `class InternetServiceTimeseriesGroupsResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `agg_interval: Literal["FIFTEEN_MINUTES", "ONE_HOUR", "ONE_DAY", 2 more]`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `serie_0: Serie0`

    - `timestamps: List[datetime]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.ranking.internet_services.timeseries_groups()
print(response.meta)
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "serie_0": {
      "timestamps": [
        "2019-12-27T18:11:19.117Z"
      ]
    }
  },
  "success": true
}
```

## Get top Internet services

`radar.ranking.internet_services.top(InternetServiceTopParams**kwargs)  -> InternetServiceTopResponse`

**get** `/radar/ranking/internet_services/top`

Retrieves top Internet services based on their rank.

### Parameters

- `date: Optional[Sequence[Union[null, null]]]`

  Filters results by the specified array of dates.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `limit: Optional[int]`

  Limits the number of objects returned in the response.

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

- `service_category: Optional[Sequence[str]]`

  Filters results by Internet service category.

### Returns

- `class InternetServiceTopResponse: …`

  - `meta: Meta`

    - `confidence_info: Optional[MetaConfidenceInfo]`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `top_0: List[Top0]`

    - `rank: int`

    - `service: str`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.ranking.internet_services.top()
print(response.meta)
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "top_0": [
      {
        "rank": 1,
        "service": "Google"
      }
    ]
  },
  "success": true
}
```

## List Internet services categories

`radar.ranking.internet_services.categories(InternetServiceCategoriesParams**kwargs)  -> InternetServiceCategoriesResponse`

**get** `/radar/ranking/internet_services/categories`

Retrieves the list of Internet services categories.

### Parameters

- `date: Optional[Sequence[Union[null, null]]]`

  Filters results by the specified array of dates.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `limit: Optional[int]`

  Limits the number of objects returned in the response.

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

### Returns

- `class InternetServiceCategoriesResponse: …`

  - `categories_0: List[Categories0]`

    - `name: str`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.ranking.internet_services.categories()
print(response.categories_0)
```

#### Response

```json
{
  "result": {
    "categories_0": [
      {
        "name": "Generative AI"
      }
    ]
  },
  "success": true
}
```

## Domain Types

### Internet Service Timeseries Groups Response

- `class InternetServiceTimeseriesGroupsResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `agg_interval: Literal["FIFTEEN_MINUTES", "ONE_HOUR", "ONE_DAY", 2 more]`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `serie_0: Serie0`

    - `timestamps: List[datetime]`

### Internet Service Top Response

- `class InternetServiceTopResponse: …`

  - `meta: Meta`

    - `confidence_info: Optional[MetaConfidenceInfo]`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"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: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `top_0: List[Top0]`

    - `rank: int`

    - `service: str`

### Internet Service Categories Response

- `class InternetServiceCategoriesResponse: …`

  - `categories_0: List[Categories0]`

    - `name: str`