## Get BGP time series

`client.radar.bgp.timeseries(BGPTimeseriesParamsquery?, RequestOptionsoptions?): BGPTimeseriesResponse`

**get** `/radar/bgp/timeseries`

Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned.

### Parameters

- `query: BGPTimeseriesParams`

  - `aggInterval?: "15m" | "1h" | "1d" | "1w"`

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

    - `"15m"`

    - `"1h"`

    - `"1d"`

    - `"1w"`

  - `asn?: Array<string>`

    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.

  - `dateEnd?: Array<string>`

    End of the date range (inclusive).

  - `dateRange?: 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).

  - `dateStart?: Array<string>`

    Start of the date range.

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `name?: Array<string>`

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

  - `prefix?: Array<string>`

    Filters results by BGP network prefix.

  - `updateType?: Array<"ANNOUNCEMENT" | "WITHDRAWAL">`

    Filters results by BGP update type.

    - `"ANNOUNCEMENT"`

    - `"WITHDRAWAL"`

### Returns

- `BGPTimeseriesResponse`

  - `meta: Meta`

    - `aggInterval: "15m" | "1h" | "1d" | "1w"`

      - `"15m"`

      - `"1h"`

      - `"1d"`

      - `"1w"`

    - `confidenceInfo: ConfidenceInfo`

      - `annotations: Array<Annotation>`

        - `dataSource: "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: string`

        - `endDate: string`

        - `eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `isInstantaneous: boolean`

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

        - `linkedUrl: string`

        - `startDate: string`

      - `level: number`

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

    - `dateRange: Array<DateRange>`

      - `endTime: string`

        Adjusted end of date range.

      - `startTime: string`

        Adjusted start of date range.

    - `lastUpdated: string`

  - `serie_0: Serie0`

    - `timestamps: Array<string>`

    - `values: Array<string>`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.radar.bgp.timeseries();

console.log(response.meta);
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "15m",
      "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"
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z"
    },
    "serie_0": {
      "timestamps": [
        "2019-12-27T18:11:19.117Z"
      ],
      "values": [
        "10"
      ]
    }
  },
  "success": true
}
```