openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Radar Ranking 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
      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 Ranking
paths:
  /radar/ranking/domain/{domain}:
    get:
      description: "Gets Domains Rank details. \n    Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets\n    like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints."
      operationId: radar-get-ranking-domain-details
      parameters:
      - in: path
        name: domain
        required: true
        schema:
          example: google.com
          pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$
          type: string
      - 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: The ranking type.
        in: query
        name: rankingType
        schema:
          default: POPULAR
          description: The ranking type.
          enum:
          - POPULAR
          - TRENDING_RISE
          - TRENDING_STEADY
          example: POPULAR
          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: Array of dates to filter the ranking.
        in: query
        name: date
        schema:
          description: Array of dates to filter the ranking.
          example: '2022-09-19'
          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:
                      details_0:
                        properties:
                          bucket:
                            description: Only available in POPULAR ranking for the most recent ranking.
                            example: '2000'
                            type: string
                          categories:
                            items:
                              properties:
                                id:
                                  example: 81
                                  type: number
                                name:
                                  example: Content Servers
                                  type: string
                                superCategoryId:
                                  example: 26
                                  type: number
                              required:
                              - superCategoryId
                              - name
                              - id
                              type: object
                            type: array
                          rank:
                            example: 3
                            type: integer
                          top_locations:
                            items:
                              properties:
                                locationCode:
                                  example: US
                                  type: string
                                locationName:
                                  example: United States
                                  type: string
                                rank:
                                  example: 1
                                  type: integer
                              required:
                              - rank
                              - locationName
                              - locationCode
                              type: object
                            type: array
                        required:
                        - categories
                        - top_locations
                        type: object
                    required:
                    - details_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 Domains Rank details
      tags:
      - Radar Ranking
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ranking/timeseries_groups:
    get:
      description: Gets Domains Rank updates change over time. Raw values are returned.
      operationId: radar-get-ranking-domain-timeseries
      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: The ranking type.
        in: query
        name: rankingType
        schema:
          default: POPULAR
          description: The ranking type.
          enum:
          - POPULAR
          - TRENDING_RISE
          - TRENDING_STEADY
          example: POPULAR
          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: Array of locations (alpha-2 country codes).
        in: query
        name: location
        schema:
          description: Array of locations (alpha-2 country codes).
          example: US
          items:
            type: string
          type: array
      - description: Array of comma separated list of domains names.
        in: query
        name: domains
        schema:
          description: Array of comma separated list of domains names.
          example: google.com,facebook.com
          items:
            pattern: ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$
            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: 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:
                          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
                      serie_0:
                        additionalProperties:
                          items:
                            anyOf:
                            - type: string
                            - type: number
                          type: array
                        example:
                          google.com:
                          - 2
                          timestamps:
                          - '2022-09-02'
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                        - timestamps
                        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 Domains Rank time series
      tags:
      - Radar Ranking
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ranking/top:
    get:
      description: Get top or trending domains based on their rank. Popular domains are domains of broad appeal based on how people use the Internet. Trending domains are domains that are generating a surge in interest. For more information on top domains, see https://blog.cloudflare.com/radar-domain-rankings/.
      operationId: radar-get-ranking-top-domains
      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: Array of locations (alpha-2 country codes).
        in: query
        name: location
        schema:
          description: Array of locations (alpha-2 country codes).
          example: US
          items:
            type: string
          type: array
      - description: Array of dates to filter the ranking.
        in: query
        name: date
        schema:
          description: Array of dates to filter the ranking.
          example: '2022-09-19'
          items:
            type: string
          type: array
      - description: The ranking type.
        in: query
        name: rankingType
        schema:
          default: POPULAR
          description: The ranking type.
          enum:
          - POPULAR
          - TRENDING_RISE
          - TRENDING_STEADY
          example: POPULAR
          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:
                          top_0:
                            properties:
                              date:
                                example: '2022-09-19'
                                type: string
                            required:
                            - date
                            type: object
                        required:
                        - top_0
                        type: object
                      top_0:
                        items:
                          properties:
                            categories:
                              items:
                                properties:
                                  id:
                                    example: 81
                                    type: number
                                  name:
                                    example: Content Servers
                                    type: string
                                  superCategoryId:
                                    example: 26
                                    type: number
                                required:
                                - superCategoryId
                                - name
                                - id
                                type: object
                              type: array
                            domain:
                              example: google.com
                              type: string
                            pctRankChange:
                              description: Only available in TRENDING rankings.
                              example: 10.8
                              type: number
                            rank:
                              example: 1
                              type: integer
                          required:
                          - rank
                          - domain
                          - categories
                          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 or Trending Domains
      tags:
      - Radar Ranking
      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