Get BGP time series

Gets BGP updates change over time. Raw values are returned. When requesting updates of an autonomous system (AS), only BGP updates of type announcement are returned.

Request

Query Params

aggInterval

string

optional

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

name

array[string]

optional

Array of names that will be used to name the series in responses.

dateRange

array[string]

optional

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]

optional

Array of datetimes to filter the start of a series.

dateEnd

array[string]

optional

Array of datetimes to filter the end of a series.

prefix

string

optional

Network prefix, IPv4 or IPv6.

updateType

array[string]

optional

Array of BGP update types.

asn

array[string]

optional

Array of comma separated list of ASNs, start with - to exclude from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.

format

string

optional

Format results are returned in.

Responses

🟢200Successful Response

application/json

Body

result

object

required

meta

object

required

series

object

required

success

boolean

required

Example:

true

Example

{
    "result": {
        "meta": {
            "aggInterval": "1h",
            "confidenceInfo": {
                "annotations": [
                    {
                        "dataSource": "ALL",
                        "description": "Cable cut in Tonga",
                        "endTime": "2022-09-15T00:00:00Z",
                        "eventType": "OUTAGE",
                        "startTime": "2022-09-15T00:00:00Z"
                    }
                ],
                "level": 0
            },
            "dateRange": {
                "endTime": "2022-09-17T10:22:57.555Z",
                "startTime": "2022-09-16T10:22:57.555Z"
            },
            "lastUpdated": "2022-09-15T00:00:00Z"
        },
        "series": {
            "timestamps": [
                "2022-09-15T00:00:00Z"
            ],
            "values": [
                0.56
            ]
        }
    },
    "success": true
}

Request

Request samples

Responses