openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Radar Datasets API
description:
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.
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 version: 1.0.0 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 Datasets paths: /radar/datasets: get: description: Get a list of datasets. operationId: radar-get-reports-datasets parameters: - description: Limit the number of objects in the response. in: query name: limit schema: description: Limit the number of objects in the response. example: 5 type: integer - description: Number of objects to skip before grabbing results. in: query name: offset schema: description: Number of objects to skip before grabbing results. type: integer - description: Dataset type. in: query name: datasetType schema: default: RANKING_BUCKET description: Dataset type. enum: - RANKING_BUCKET - REPORT example: RANKING_BUCKET 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: datasets: items: properties: description: example: This dataset contains a list of the op 20000 domains globally type: string id: example: 3 type: integer meta: type: object tags: items: example: global type: string type: array title: example: Top bucket 20000 domains type: string type: example: RANKING_BUCKET type: string required: - id - title - description - type - tags - meta type: object type: array required: - datasets 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 Datasets tags: - Radar Datasets x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/datasets/{alias}: get: description: Get the csv content of a given dataset by alias or id. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date. operationId: radar-get-reports-dataset-download parameters: - description: Dataset alias or id in: path name: alias required: true schema: description: Dataset alias or id example: ranking_top_1000 type: string responses: '200': content: text/csv: schema: type: string 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 Dataset csv Stream tags: - Radar Datasets x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/datasets/download: post: description: Get a url to download a single dataset. operationId: radar-post-reports-dataset-download-url parameters: - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string requestBody: content: application/json: schema: properties: datasetId: example: 3 type: integer required: - datasetId type: object responses: '200': content: application/json: schema: properties: result: properties: dataset: properties: url: example: https://example.com/download type: string required: - url type: object required: - dataset type: object required: - result 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 Dataset download url tags: - Radar Datasets x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true components: securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true