APIs.io Engineering Platform Radar Robots.txt API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Radar Robots.txt API
  version: 4.0.0
tags:
- name: Radar Robots.txt
paths:
  /radar/robots_txt/domains:
    get:
      description: Get the top User-Agents on robots.txt files by domain.
      operationId: radar-get-robots-txt-top-by-domain
      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: Filter domains by category
        in: query
        name: domainCategory
        schema:
          description: Filter domains by category
          type: string
      - description: Filter domains by name
        in: query
        name: domainName
        schema:
          description: Filter domains by name
          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:
                      date:
                        type: string
                      domains:
                        items:
                          properties:
                            '*':
                              type: string
                            amazonbot:
                              type: string
                            categories_parent:
                              type: string
                            categories_sub:
                              type: string
                            domain:
                              type: string
                          required:
                          - domain
                          - categories_sub
                          - categories_parent
                          - '*'
                          - amazonbot
                          type: object
                        type: array
                      userAgents:
                        items:
                          example: amazonbot
                          type: string
                        type: array
                    required:
                    - date
                    - userAgents
                    - domains
                    type: object
                  resultInfo:
                    properties:
                      limit:
                        type: integer
                      offset:
                        type: integer
                      total:
                        type: integer
                    required:
                    - limit
                    - offset
                    - total
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - resultInfo
                - 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 User-Agents by Domain
      tags:
      - Radar Robots.txt
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/robots_txt/top/{directive}:
    get:
      description: Get the top User-Agents on robots.txt files by directive.
      operationId: radar-get-robots-txt-top-by-directive
      parameters:
      - description: Robots.txt directive.
        in: path
        name: directive
        required: true
        schema:
          description: Robots.txt directive.
          enum:
          - ALLOW
          - DISALLOW
          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: 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: Filter by user agent category.
        in: query
        name: agentCategory
        schema:
          default: AI
          description: Filter by user agent category.
          enum:
          - AI
          example: AI
          type: string
      - description: Date to filter the ranking.
        in: query
        name: date
        schema:
          description: Date to filter the ranking.
          example: '2024-09-19'
          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
                        required:
                        - dateRange
                        - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            date:
                              type: string
                            fully:
                              example: 235
                              type: integer
                            partially:
                              example: 38
                              type: integer
                            total:
                              example: 273
                              type: integer
                            userAgent:
                              example: GPTBot
                              type: string
                          required:
                          - userAgent
                          - fully
                          - partially
                          - total
                          - date
                          type: object
                        type: array
                    required:
                    - meta
                    - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                - error
                type: object
          description: Not found
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get Top User-Agents by Directive
      tags:
      - Radar Robots.txt
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey