APIs.io Engineering Platform Radar Verified Bots API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Radar Verified Bots 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 Verified Bots
paths:
  /radar/verified_bots/top/bots:
    get:
      description: Get top verified bots by HTTP requests, with owner and category.
      operationId: radar-get-verified-bots-top-by-http-requests
      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: 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: 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
                        required:
                        - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            botCategory:
                              example: Search Engine Crawler
                              type: string
                            botName:
                              example: GoogleBot
                              type: string
                            botOwner:
                              example: Google
                              type: string
                            value:
                              example: '29.034407'
                              type: string
                          required:
                          - botName
                          - botCategory
                          - botOwner
                          - value
                          type: object
                        type: array
                    required:
                    - meta
                    - top_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 Top Verified Bots By HTTP Requests
      tags:
      - Radar Verified Bots
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/verified_bots/top/categories:
    get:
      description: Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.
      operationId: radar-get-verified-bots-top-categories-by-http-requests
      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: 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: 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
                        required:
                        - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            botCategory:
                              example: Search
                              type: string
                            value:
                              example: '65'
                              type: string
                          required:
                          - botCategory
                          - value
                          type: object
                        type: array
                    required:
                    - meta
                    - top_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 Top Verified Bot Categories By HTTP Requests
      tags:
      - Radar Verified Bots
      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