--- title: Get BGP time series --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Radar](https://developers.cloudflare.com/api/go/resources/radar) [BGP](https://developers.cloudflare.com/api/go/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(ctx, query) (\*[BGPTimeseriesResponse](), error) 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 param.Field\[BGPTimeseriesParamsAggInterval]Optional 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. const BGPTimeseriesParamsAggInterval15m BGPTimeseriesParamsAggInterval = "15m" Link to this property const BGPTimeseriesParamsAggInterval1h BGPTimeseriesParamsAggInterval = "1h" Link to this property const BGPTimeseriesParamsAggInterval1d BGPTimeseriesParamsAggInterval = "1d" Link to this property const BGPTimeseriesParamsAggInterval1w BGPTimeseriesParamsAggInterval = "1w" Link to this property
Link to this property ASN param.Field\[\[]string]Optional 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 param.Field\[\[]Time]Optional 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 param.Field\[\[]string]Optional 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 param.Field\[\[]Time]Optional 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 param.Field\[BGPTimeseriesParamsFormat]Optional Format in which results will be returned. const BGPTimeseriesParamsFormatJson BGPTimeseriesParamsFormat = "JSON" Link to this property const BGPTimeseriesParamsFormatCsv BGPTimeseriesParamsFormat = "CSV" Link to this property
Link to this property Name param.Field\[\[]string]Optional Array of names used to label the series in the response. Link to this property Prefix param.Field\[\[]string]Optional Filters results by BGP network prefix. Link to this property
UpdateType param.Field\[\[]BGPTimeseriesParamsUpdateType]Optional Filters results by BGP update type. const BGPTimeseriesParamsUpdateTypeAnnouncement BGPTimeseriesParamsUpdateType = "ANNOUNCEMENT" Link to this property const BGPTimeseriesParamsUpdateTypeWithdrawal BGPTimeseriesParamsUpdateType = "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
type BGPTimeseriesResponse struct{…}
Meta BGPTimeseriesResponseMeta
AggInterval BGPTimeseriesResponseMetaAggInterval One of the following: const BGPTimeseriesResponseMetaAggInterval15m BGPTimeseriesResponseMetaAggInterval = "15m" Link to this property const BGPTimeseriesResponseMetaAggInterval1h BGPTimeseriesResponseMetaAggInterval = "1h" Link to this property const BGPTimeseriesResponseMetaAggInterval1d BGPTimeseriesResponseMetaAggInterval = "1d" Link to this property const BGPTimeseriesResponseMetaAggInterval1w BGPTimeseriesResponseMetaAggInterval = "1w" Link to this property
Link to this property
ConfidenceInfo BGPTimeseriesResponseMetaConfidenceInfo
Annotations \[]BGPTimeseriesResponseMetaConfidenceInfoAnnotation
DataSource BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource Data source for annotations. One of the following: const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceAll BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "ALL" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceAIBots BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "AI\_BOTS" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "AI\_GATEWAY" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceBGP BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "BGP" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceBots BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION\_ANOMALY" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceCT BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "CT" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceDNS BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS\_MAGNITUDE" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS\_AS112" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceDos BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "DOS" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL\_ROUTING" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL\_SECURITY" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceFw BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "FW" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceFwPg BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "FW\_PG" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTP BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP\_CONTROL" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP\_CRAWLER\_REFERER" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP\_ORIGINS" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceIQI BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "IQI" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED\_CREDENTIALS" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceNet BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "NET" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS\_TXT" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceSpeed BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI BGPTimeseriesResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS\_AI" Link to this property
Link to this property Description string Link to this property EndDate Time formatdate-time Link to this property
EventType BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventType Event type for annotations. One of the following: const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventTypeGeneral BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventTypeOutage BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL\_PROJECTION" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventTypePipeline BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE" Link to this property const BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly BGPTimeseriesResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC\_ANOMALY" Link to this property
Link to this property IsInstantaneous bool Whether event is a single point in time or a time range. Link to this property LinkedURL string formaturi Link to this property StartDate Time formatdate-time Link to this property Tags \[]stringOptional Link to this property
Link to this property Level int64 Provides an indication of how much confidence Cloudflare has in the data. Link to this property
Link to this property
DateRange \[]BGPTimeseriesResponseMetaDateRange EndTime Time Adjusted end of date range. formatdate-time Link to this property StartTime Time Adjusted start of date range. formatdate-time Link to this property
Link to this property LastUpdated Time formatdate-time Link to this property
Link to this property
Serie0 BGPTimeseriesResponseSerie0 Timestamps \[]Time Link to this property Values \[]string Link to this property
Link to this property
[Link to this property](<#(resource)%20radar.bgp%20%3E%20(model)%20BGPTimeseriesResponse%20%3E%20(schema)>) ### Get BGP time series Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/radar" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.Radar.BGP.Timeseries(context.TODO(), radar.BGPTimeseriesParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 } ```