APIs.io Engineering Platform Radar Datasets 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 Datasets API
  version: 4.0.0
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:
    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