--- title: Get BGP time series --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Radar](https://developers.cloudflare.com/api/typescript/resources/radar) [BGP](https://developers.cloudflare.com/api/typescript/resources/radar/subresources/bgp) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get BGP time series client.radar.bgp.timeseries(BGPTimeseriesParams {aggInterval, asn, dateEnd, 6 more } query?, RequestOptionsoptions?): [BGPTimeseriesResponse]() {meta, serie\_0 } GET/radar/bgp/timeseries Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `User Details Write``User Details Read` ##### ParametersExpand Collapse

query: BGPTimeseriesParams {aggInterval, asn, dateEnd, 6 more }

aggInterval?: "15m"| "1h"| "1d"| "1w" Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to 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.

One of the following: "15m" Link to this property "1h" Link to this property "1d" Link to this property "1w" Link to this property

Link to this property 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. Link to this property dateEnd?: Array<string> 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. Link to this property dateRange?: 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). Link to this property dateStart?: 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. Link to this property

format?: "JSON"| "CSV" Format in which results will be returned.

One of the following: "JSON" Link to this property "CSV" Link to this property

Link to this property name?: Array<string> Array of names used to label the series in the response. Link to this property prefix?: Array<string> Filters results by BGP network prefix. Link to this property

updateType?: Array<"ANNOUNCEMENT"| "WITHDRAWAL"> Filters results by BGP update type.

One of the following: "ANNOUNCEMENT" Link to this property "WITHDRAWAL" Link to this property

Link to this property

[Link to this property](<#(resource)%20radar.bgp%20%3E%20(method)%20timeseries%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

BGPTimeseriesResponse {meta, serie\_0 }

meta: Meta {aggInterval, confidenceInfo, dateRange, lastUpdated }

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

One of the following: "15m" Link to this property "1h" Link to this property "1d" Link to this property "1w" Link to this property

Link to this property

confidenceInfo: ConfidenceInfo {annotations, level }

annotations: Array<Annotation>

dataSource: "ALL"| "AI\_BOTS"| "AI\_GATEWAY"| 22 more Data source for annotations.

Link to this property description: string Link to this property endDate: string formatdate-time Link to this property

eventType: "GENERAL"| "OUTAGE"| "PARTIAL\_PROJECTION"| 2 more Event type for annotations.

One of the following: "GENERAL" Link to this property "OUTAGE" Link to this property "PARTIAL\_PROJECTION" Link to this property "PIPELINE" Link to this property "TRAFFIC\_ANOMALY" Link to this property

Link to this property isInstantaneous: boolean Whether event is a single point in time or a time range. Link to this property linkedUrl: string formaturi Link to this property startDate: string formatdate-time Link to this property tags?: Array<string> Link to this property

Link to this property level: number Provides an indication of how much confidence Cloudflare has in the data. Link to this property

Link to this property

dateRange: Array<DateRange>

endTime: string Adjusted end of date range. formatdate-time Link to this property startTime: string Adjusted start of date range. formatdate-time Link to this property

Link to this property lastUpdated: string formatdate-time Link to this property

Link to this property

serie\_0: Serie0 {timestamps, values }

timestamps: Array<string> Link to this property values: Array<string> Link to this property

Link to this property

[Link to this property](<#(resource)%20radar.bgp%20%3E%20(model)%20bgp_timeseries_response%20%3E%20(schema)>) ### Get BGP time series TypeScript HTTPTypeScriptPythonGoTerraform ``` 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); ``` 200 example ``` { "result": { "meta": { "aggInterval": "15m", "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "GENERAL", "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" }, "serie_0": { "timestamps": [ "2019-12-27T18:11:19.117Z" ], "values": [ "10" ] } }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "meta": { "aggInterval": "15m", "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "GENERAL", "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" }, "serie_0": { "timestamps": [ "2019-12-27T18:11:19.117Z" ], "values": [ "10" ] } }, "success": true } ```