openapi: 3.0.0
info:
version: "1.0.0"
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Radar Quality API
description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: apigateway
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
converter:
url: https://github.com/mermade/aws2openapi
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Radar Quality
paths:
/radar/quality/iqi/summary:
get:
description: Get a summary (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI).
operationId: radar-get-quality-index-summary
parameters:
- description: Array of names that will be used to name the series in responses.
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
- 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).
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).
example: 7d
items:
example: 7d
pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
type: string
type: array
- description: Array of datetimes to filter the start of a series.
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
- description: End of the date range (inclusive).
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
- 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.
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
- 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.
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
- 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.
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
- description: 'Which metric to return: bandwidth, latency or DNS response time.'
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
- description: Format results are returned in.
in: query
name: format
schema:
description: Format results are returned in.
enum:
- JSON
- CSV
example: json
type: string
responses:
'200':
content:
application/json:
schema:
properties:
result:
properties:
meta:
properties:
confidenceInfo:
properties:
annotations:
items:
properties:
dataSource:
example: ALL
type: string
description:
example: Cable cut in Tonga
type: string
endTime:
format: date-time
type: string
eventType:
example: OUTAGE
type: string
isInstantaneous:
example: true
type: boolean
linkedUrl:
type: string
startTime:
format: date-time
type: string
required:
- dataSource
- eventType
- description
- isInstantaneous
type: object
type: array
level:
type: integer
type: object
dateRange:
items:
properties:
endTime:
description: Adjusted end of date range.
example: '2022-09-17T10:22:57.555Z'
format: date-time
type: string
startTime:
description: Adjusted start of date range.
example: '2022-09-16T10:22:57.555Z'
format: date-time
type: string
required:
- startTime
- endTime
type: object
type: array
lastUpdated:
example: '2023-07-26T08:59:57Z'
type: string
normalization:
example: PERCENTAGE
type: string
required:
- dateRange
- normalization
- lastUpdated
type: object
summary_0:
properties:
p25:
example: '32.20938'
type: string
p50:
example: '61.819881'
type: string
p75:
example: '133.813087'
type: string
required:
- p75
- p50
- p25
type: object
required:
- meta
- summary_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
security:
- api_email: []
api_key: []
api_token: []
summary: APIs.io Engineering Platform Get IQI Summary
tags:
- Radar Quality
x-cfPermissionsRequired:
enum:
- com.cloudflare.api.user.read
x-cfPlanAvailability:
business: true
enterprise: true
free: true
pro: true
/radar/quality/iqi/timeseries_groups:
get:
description: Get a time series (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI).
operationId: radar-get-quality-index-timeseries-group
parameters:
- 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/).
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
- description: Array of names that will be used to name the series in responses.
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
- 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).
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).
example: 7d
items:
example: 7d
pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
type: string
type: array
- description: Array of datetimes to filter the start of a series.
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
- description: End of the date range (inclusive).
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
- 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.
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
- 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.
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
- 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.
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
- description: Enable interpolation for all series (using the average).
in: query
name: interpolation
schema:
description: Enable interpolation for all series (using the average).
type: boolean
- description: 'Which metric to return: bandwidth, latency or DNS response time.'
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
- description: Format results are returned in.
in: query
name: format
schema:
description: Format results are returned in.
enum:
- JSON
- CSV
example: json
type: string
responses:
'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
security:
- api_email: []
api_key: []
api_token: []
summary: APIs.io Engineering Platform Get IQI Time Series
tags:
- Radar Quality
x-cfPermissionsRequired:
enum:
- com.cloudflare.api.user.read
x-cfPlanAvailability:
business: true
enterprise: true
free: true
pro: true
/radar/quality/speed/histogram:
get:
description: Get an histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets.
operationId: radar-get-quality-speed-histogram
parameters:
- description: Array of names that will be used to name the series in responses.
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
- description: End of the date range (inclusive).
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
- 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.
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
- 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.
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
- 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.
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
- description: The width for every bucket in the histogram.
in: query
name: bucketSize
schema:
description: The width for every bucket in the histogram.
type: integer
- description: Metrics to be returned.
in: query
name: metricGroup
schema:
default: bandwidth
description: Metrics to be returned.
enum:
- BANDWIDTH
- LATENCY
- JITTER
example: bandwidth
type: string
- description: Format results are returned in.
in: query
name: format
schema:
description: Format results are returned in.
enum:
- JSON
- CSV
example: json
type: string
responses:
'200':
content:
application/json:
schema:
properties:
result:
properties:
histogram_0:
properties:
bandwidthDownload:
items:
example: '83681'
type: string
type: array
bandwidthUpload:
items:
example: '181079'
type: string
type: array
bucketMin:
items:
example: '0'
type: string
type: array
required:
- bandwidthUpload
- bandwidthDownload
- bucketMin
type: object
meta:
type: object
required:
- meta
- histogram_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
security:
- api_email: []
api_key: []
api_token: []
summary: APIs.io Engineering Platform Get Speed Tests Histogram
tags:
- Radar Quality
x-cfPermissionsRequired:
enum:
- com.cloudflare.api.user.read
x-cfPlanAvailability:
business: true
enterprise: true
free: true
pro: true
/radar/quality/speed/summary:
get:
description: Get a summary of bandwidth, latency, jitter and packet loss, from the previous 90 days of Cloudflare Speed Test data.
operationId: radar-get-quality-speed-summary
parameters:
- description: Array of names that will be used to name the series in responses.
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
- description: End of the date range (inclusive).
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
- 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.
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
- 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.
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
- 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.
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
- description: Format results are returned in.
in: query
name: format
schema:
description: Format results are returned in.
enum:
- JSON
- CSV
example: json
type: string
responses:
'200':
content:
application/json:
schema:
properties:
result:
properties:
meta:
properties:
confidenceInfo:
properties:
annotations:
items:
properties:
dataSource:
example: ALL
type: string
description:
example: Cable cut in Tonga
type: string
endTime:
format: date-time
type: string
eventType:
example: OUTAGE
type: string
isInstantaneous:
example: true
type: boolean
linkedUrl:
type: string
startTime:
format: date-time
type: string
required:
- dataSource
- eventType
- description
- isInstantaneous
type: object
type: array
level:
type: integer
type: object
dateRange:
items:
properties:
endTime:
description: Adjusted end of date range.
example: '2022-09-17T10:22:57.555Z'
format: date-time
type: string
startTime:
description: Adjusted start of date range.
example: '2022-09-16T10:22:57.555Z'
format: date-time
type: string
required:
- startTime
- endTime
type: object
type: array
lastUpdated:
example: '2023-07-26T08:59:57Z'
type: string
normalizat
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-radar-quality-api-openapi.yml