# Top Files

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/files/top:
    get:
      summary: Top Files
      deprecated: false
      description: >-
        Get top files list based on number of download requests or amount of
        data served
      tags:
        - Snapbyte APIs/Files
      parameters:
        - name: offset
          in: query
          description: Query offset
          required: false
          example: 0
          schema:
            type: integer
        - name: limit
          in: query
          description: 'Number of file per page, max: 100'
          required: false
          example: 100
          schema:
            type: integer
        - name: search
          in: query
          description: Search file name by this string
          required: false
          example: abc
          schema:
            type: string
        - name: range
          in: query
          description: Get top files in this day range
          required: false
          example: 7d
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - 60d
              - 90d
            x-apidog-enum:
              - value: 7d
                name: 7 Days
                description: Top file in 7 days range
              - value: 30d
                name: 30 Days
                description: Top file in 30 days range
              - value: 60d
                name: 60 Days
                description: Top file in 60 days range
              - value: 90d
                name: 90 Days
                description: Top file in 90 days range
        - name: sortBy
          in: query
          description: ''
          required: false
          example: data_served
          schema:
            type: string
            enum:
              - data_served
              - total_requests
            x-apidog-enum:
              - value: data_served
                name: Data Served
                description: Sort by Data Byte Served
              - value: total_requests
                name: Total Requests
                description: Sort by Total Requests Number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: Number of file in the result
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: File ID generated by Snapbyte
                      file_name:
                        type: string
                        description: File name
                      file_size:
                        type: integer
                        description: File size
                      file_md5:
                        type: string
                      file_id:
                        type: string
                        description: File ID provided by client via API
                      status:
                        type: integer
                        enum:
                          - 1
                          - 2
                          - 3
                          - 4
                        x-apidog-enum:
                          - value: 1
                            name: New
                            description: File just created and waiting to be process
                          - value: 2
                            name: Done
                            description: File is processed and cached
                          - value: 3
                            name: Error
                            description: Failed to processed
                          - value: 4
                            name: Processing
                            description: File is caching
                      mine_type:
                        type: string
                        description: File mine type
                      total_requests:
                        type: string
                        description: Total download request to this file during {range}
                      data_served:
                        type: string
                        description: >-
                          Total download byte served for this file during
                          {range}
                    x-apidog-orders:
                      - id
                      - file_name
                      - file_size
                      - file_id
                      - file_md5
                      - mine_type
                      - status
                      - total_requests
                      - data_served
                    required:
                      - id
                      - file_id
                      - file_size
                      - file_name
                      - status
                      - data_served
                      - total_requests
                      - mine_type
                x-apidog-orders:
                  - total
                  - data
                required:
                  - total
                  - data
              example:
                success: true
                data:
                  - id: f1bc65d5-3548-42ad-b67a-b7e271767921
                    file_id: f1bc65d5-3548-42ad-b67a-b7e271767921
                    file_md5: ''
                    file_name: 300MB-Corrupt-Testfile.Org.zip
                    file_size: '314572800'
                    mime_type: application/x-zip-compressed
                    status: 2
                    total_requests: '21268'
                    data_served: '474116431'
                  - id: 6965abb8-e3e3-4e6f-a556-07a2084e437c
                    file_id: 6965abb8-e3e3-4e6f-a556-07a2084e437c
                    file_md5: e18053b11ecdfe8329caba3d601f5425
                    file_name: Screen Recording 2025-06-30 at 09.15.25.mov
                    file_size: '50902249'
                    mime_type: video/quicktime
                    status: 2
                    total_requests: '28659'
                    data_served: '470121843'
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Snapbyte APIs/Files
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/991601/apis/api-18895353-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.snapbyte.io
    description: Prod Env
security: []

```