> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lighton.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get documents usage report

> This endpoint allows retrieving company used documents report.

The start date is required, but the end date is by default today.

It is restricted to admin and company admin users.

Admin users can optionally filter by company.



## OpenAPI

````yaml /api-reference/openapi-v2.yaml get /api/v2/reporting/used-documents/
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v2)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Models
    description: Operations about AI models
  - name: Files Search
    description: Operations about files search
  - name: Files
    description: Operations about files
  - name: Upload Sessions
    description: Operations about upload sessions
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
  - name: Feedbacks
    description: Operations about feedbacks
  - name: Reporting
    description: Operations about reporting
  - name: Monitoring
    description: Operations about monitoring
  - name: Platform Status
    description: Operations about platform status
paths:
  /api/v2/reporting/used-documents/:
    get:
      tags:
        - Reporting
      summary: Get documents usage report
      description: |-
        This endpoint allows retrieving company used documents report.

        The start date is required, but the end date is by default today.

        It is restricted to admin and company admin users.

        Admin users can optionally filter by company.
      operationId: api_v2_reporting_used_documents_retrieve
      parameters:
        - in: query
          name: company_id
          schema:
            type: integer
          description: The unique identifier of the company (for admin users only).
        - in: query
          name: end_date
          schema:
            type: string
            format: date
          description: The end date for the report (defaults to today).
        - in: query
          name: start_date
          schema:
            type: string
            format: date
          description: The start date for the report.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsedDocumentsReportResponse'
          description: ''
      security:
        - bearerAuth: []
components:
  schemas:
    UsedDocumentsReportResponse:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/RetrieveUsedDocumentsReportMetadata'
        reporting:
          type: array
          items:
            $ref: '#/components/schemas/CompanyUsedDocumentsReport'
      required:
        - metadata
        - reporting
    RetrieveUsedDocumentsReportMetadata:
      type: object
      properties:
        usage_count:
          $ref: '#/components/schemas/ReportsMetadataItemResponse'
      required:
        - usage_count
    CompanyUsedDocumentsReport:
      type: object
      properties:
        company:
          $ref: '#/components/schemas/CompanyUsedDocumentsReportCompany'
        dates:
          type: array
          items:
            $ref: '#/components/schemas/UsedDocumentReportPerDate'
      required:
        - company
        - dates
    ReportsMetadataItemResponse:
      type: object
      properties:
        description:
          type: string
        unit:
          type: string
      required:
        - description
        - unit
    CompanyUsedDocumentsReportCompany:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
    UsedDocumentReportPerDate:
      type: object
      properties:
        date:
          type: string
          format: date
        documents:
          type: array
          items:
            $ref: '#/components/schemas/UsedDocument'
      required:
        - date
        - documents
    UsedDocument:
      type: object
      properties:
        document_filename:
          type: string
        document_title:
          type: string
        document_id:
          type: integer
        usage_count:
          type: integer
      required:
        - document_filename
        - document_id
        - document_title
        - usage_count
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````