Get a time series (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI).
/radar/quality/iqi/timeseries_groups
get
Radar Quality
radar-get-quality-index-timeseries-group
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"com.cloudflare.api.user.read"
]
}[
{
"in": "query",
"name": "aggInterval",
"schema": {
"description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).",
"enum": [
"15m",
"1h",
"1d",
"1w"
],
"example": "1h",
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Array of names that will be used to name the series in responses.",
"example": "main_series",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateRange",
"schema": {
"description": "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).",
"items": {
"enum": [
"1d",
"2d",
"7d",
"14d",
"28d",
"12w",
"24w",
"52w",
"1dControl",
"2dControl",
"7dControl",
"14dControl",
"28dControl",
"12wControl",
"24wControl"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateStart",
"schema": {
"description": "Array of datetimes to filter the start of a series.",
"example": "2023-09-01T11:41:33.782Z",
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateEnd",
"schema": {
"description": "End of the date range (inclusive).",
"example": "2023-09-01T11:41:33.782Z",
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "asn",
"schema": {
"description": "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.",
"example": "15169",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "location",
"schema": {
"description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.",
"example": "US,CA",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "continent",
"schema": {
"description": "Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.",
"example": "EU,NA",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "interpolation",
"schema": {
"description": "Enable interpolation for all series (using the average).",
"type": "boolean"
}
},
{
"in": "query",
"name": "metric",
"required": true,
"schema": {
"description": "Which metric to return: bandwidth, latency or DNS response time.",
"enum": [
"BANDWIDTH",
"DNS",
"LATENCY"
],
"example": "latency",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"description": "Format results are returned in.",
"enum": [
"JSON",
"CSV"
],
"example": "json",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"properties": {
"meta": {
"type": "object"
},
"serie_0": {
"properties": {
"p25": {
"items": {
"example": "31.253439",
"type": "string"
},
"type": "array"
},
"p50": {
"items": {
"example": "60.337738",
"type": "string"
},
"type": "array"
},
"p75": {
"items": {
"example": "125.940175",
"type": "string"
},
"type": "array"
},
"timestamps": {
"items": {
"example": "2023-04-17T00:00:00Z",
"type": "string"
},
"type": "array"
}
},
"required": [
"timestamps",
"p75",
"p50",
"p25"
],
"type": "object"
}
},
"required": [
"meta",
"serie_0"
],
"type": "object"
},
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"result",
"success"
],
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"result": {
"type": "object"
},
"success": {
"example": false,
"type": "boolean"
}
},
"required": [
"result",
"success",
"errors"
],
"type": "object"
}
}
},
"description": "Bad Request"
}
}[
{
"api_email": [],
"api_key": []
}
]