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

# Get document stats over time

> Get document upload statistics over time.

Returns document upload trends grouped by day, week, or month.
Includes counts, page totals, and file sizes for each period.



## OpenAPI

````yaml openapi.json get /v1/stats/documents
openapi: 3.1.0
info:
  title: DocIntell API
  description: >-

    # DocIntell API


    **Turn Documents into Data. Keep the Source Safe.**


    Financial document intelligence platform that turns PDFs into queryable data
    while keeping source files secure and compliant.


    ## Features


    - **Document Ingestion**: Upload PDFs with SEC 17a-4 compliant immutable
    storage

    - **Schema Projection**: Query extracted data with custom schemas (not data
    dumps!)

    - **Multi-Schema Support**: Same document, multiple query patterns

    - **Webhook Delivery**: Async notifications on job completion

    - **Row-Level Security**: Multi-tenant isolation built-in


    ## Authentication


    All API endpoints (except `/health`, `/`, `/docs`, and `/redoc`) require API
    key authentication.


    Include your API key in the `Authorization` header:


    ```

    Authorization: Bearer dk_live_<your_key>

    ```


    Test keys start with `dk_test_`, production keys with `dk_live_`.


    ## Rate Limiting


    Per-tenant rate limits:

    - **Document ingestion**: 100 documents/hour

    - **Projection queries**: 1,000 requests/hour

    - **Schema operations**: 10 creates/hour


    Rate limit info is returned in response headers:

    - `X-RateLimit-Limit`: Maximum requests allowed

    - `X-RateLimit-Remaining`: Remaining requests in window

    - `X-RateLimit-Reset`: Unix timestamp when limit resets


    ## Error Handling


    All errors follow RFC 7807 Problem Details format:


    ```json

    {
      "error": "error_code",
      "message": "Human-readable description",
      "details": {}
    }

    ```


    Common error codes:

    - `unauthorized` (401): Missing or invalid API key

    - `rate_limit_exceeded` (429): Too many requests

    - `invalid_file_type` (400): Only PDFs supported

    - `file_too_large` (413): File exceeds size limit (default 100MB,
    configurable via MAX_UPLOAD_SIZE_MB)

    - `job_not_found` (404): Job ID doesn't exist or doesn't belong to tenant


    ## Getting Started


    1. Obtain API key from dashboard

    2. Upload PDF: `POST /v1/documents`

    3. Poll status: `GET /v1/documents/{document_id}/status`

    4. Query results: `POST /v1/documents/{document_id}/project`


    Full documentation: [https://docs.docintel.com](https://docs.docintel.com)
        
  contact:
    name: DocIntell Support
    url: https://docintel.com/support
    email: support@docintel.com
  license:
    name: Proprietary
    url: https://docintel.com/terms
  version: 0.1.0
servers:
  - url: http://localhost:8000
    description: Local development
  - url: https://api.docintell.com
    description: Production API
  - url: https://api-staging.docintell.com
    description: Staging environment
security:
  - bearerAuth: []
tags:
  - name: health
    description: Health check operations. Verify service and dependency connectivity.
    x-mint-tag-group: System
  - name: api_keys
    description: API key management operations. Create, list, and revoke API keys.
    x-mint-tag-group: Management
  - name: documents
    description: Document ingestion operations. Upload PDFs for extraction.
    x-mint-tag-group: Core
  - name: jobs
    description: >-
      Job status and query operations. Check extraction status and query
      results.
    x-mint-tag-group: Core
  - name: document-types
    description: >-
      Document type schemas. List and retrieve extraction schema definitions for
      financial document types.
  - name: webhooks
    description: >-
      Webhook configuration management. Create, update, and manage webhook
      endpoints for job completion notifications.
    x-mint-tag-group: Integrations
  - name: stats
    description: Analytics and metrics endpoints. Get document, job, and schema statistics.
  - name: views
    description: >-
      View management for consumption layer. Define field subsets for querying
      extraction data.
paths:
  /v1/stats/documents:
    get:
      tags:
        - stats
      summary: Get document stats over time
      description: |-
        Get document upload statistics over time.

        Returns document upload trends grouped by day, week, or month.
        Includes counts, page totals, and file sizes for each period.
      operationId: get_stats_documents_v1_stats_documents_get
      parameters:
        - name: group_by
          in: query
          required: false
          schema:
            enum:
              - day
              - week
              - month
            type: string
            description: Time grouping interval
            default: day
            title: Group By
          description: Time grouping interval
        - name: start_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: 'Start date (ISO 8601, default: 30 days ago)'
            title: Start Date
          description: 'Start date (ISO 8601, default: 30 days ago)'
        - name: end_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: 'End date (ISO 8601, default: today)'
            title: End Date
          description: 'End date (ISO 8601, default: today)'
      responses:
        '200':
          description: Document upload trends with time-based grouping
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsDocumentsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    StatsDocumentsResponse:
      properties:
        period:
          $ref: '#/components/schemas/StatsPeriod'
          description: Time period covered
        group_by:
          type: string
          enum:
            - day
            - week
            - month
          title: Group By
          description: Grouping interval
        data:
          items:
            $ref: '#/components/schemas/DocumentStatsDataPoint'
          type: array
          title: Data
          description: Time series data points
        totals:
          $ref: '#/components/schemas/DocumentStatsTotals'
          description: Aggregated totals for the period
      type: object
      required:
        - period
        - group_by
        - data
        - totals
      title: StatsDocumentsResponse
      description: |-
        Response for document stats over time (GET /v1/stats/documents).

        Document upload trends with time-based grouping.
      examples:
        - data:
            - count: 23
              date: '2025-12-05'
              pages: 892
              size_bytes: 45678901
            - count: 31
              date: '2025-12-06'
              pages: 1204
              size_bytes: 62345678
            - count: 18
              date: '2025-12-07'
              pages: 712
              size_bytes: 38901234
          group_by: day
          period:
            end: '2025-12-07'
            start: '2025-11-07'
          totals:
            count: 72
            pages: 2808
            size_bytes: 146925813
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    StatsPeriod:
      properties:
        start:
          type: string
          title: Start
          description: Start date (ISO 8601)
        end:
          type: string
          title: End
          description: End date (ISO 8601)
      type: object
      required:
        - start
        - end
      title: StatsPeriod
      description: Time period for stats queries.
      examples:
        - end: '2025-12-07'
          start: '2025-11-07'
    DocumentStatsDataPoint:
      properties:
        date:
          type: string
          title: Date
          description: Date for this data point (ISO 8601)
        count:
          type: integer
          title: Count
          description: Number of documents uploaded
        pages:
          type: integer
          title: Pages
          description: Total pages uploaded
        size_bytes:
          type: integer
          title: Size Bytes
          description: Total size in bytes
      type: object
      required:
        - date
        - count
        - pages
        - size_bytes
      title: DocumentStatsDataPoint
      description: Single data point for document stats time series.
      examples:
        - count: 31
          date: '2025-12-06'
          pages: 1204
          size_bytes: 62345678
    DocumentStatsTotals:
      properties:
        count:
          type: integer
          title: Count
          description: Total document count in period
        pages:
          type: integer
          title: Pages
          description: Total pages in period
        size_bytes:
          type: integer
          title: Size Bytes
          description: Total size in bytes in period
      type: object
      required:
        - count
        - pages
        - size_bytes
      title: DocumentStatsTotals
      description: Aggregated totals for document stats.
      examples:
        - count: 72
          pages: 2808
          size_bytes: 146925813
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key authentication. Format: dk_test_<key> or dk_live_<key>'

````