> ## 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 stats overview > Get high-level statistics overview. Returns summary counts for documents, jobs (grouped by status), and schemas. Useful for dashboard widgets and quick health checks. ## OpenAPI ````yaml openapi.json get /v1/stats/overview 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_ ``` 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/overview: get: tags: - stats summary: Get stats overview description: >- Get high-level statistics overview. Returns summary counts for documents, jobs (grouped by status), and schemas. Useful for dashboard widgets and quick health checks. operationId: get_stats_overview_v1_stats_overview_get responses: '200': description: High-level summary of documents, jobs, and schemas content: application/json: schema: $ref: '#/components/schemas/StatsOverviewResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: StatsOverviewResponse: properties: documents: $ref: '#/components/schemas/DocumentStats' description: Document statistics jobs: $ref: '#/components/schemas/JobStats' description: Job statistics schemas: $ref: '#/components/schemas/SchemaStats' description: Schema statistics type: object required: - documents - jobs - schemas title: StatsOverviewResponse description: >- Response for stats overview (GET /v1/stats/overview). High-level dashboard summary with counts for documents, jobs, and schemas. examples: - documents: total: 1247 total_pages: 48923 total_size_bytes: 2147483648 jobs: by_status: completed: 1489 failed: 19 pending: 12 processing: 3 total: 1523 schemas: total: 8 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError DocumentStats: properties: total: type: integer title: Total description: Total number of documents total_pages: type: integer title: Total Pages description: Total pages across all documents total_size_bytes: type: integer title: Total Size Bytes description: Total file size in bytes type: object required: - total - total_pages - total_size_bytes title: DocumentStats description: Document statistics summary. examples: - total: 1247 total_pages: 48923 total_size_bytes: 2147483648 JobStats: properties: total: type: integer title: Total description: Total number of jobs by_status: $ref: '#/components/schemas/JobStatsByStatus' description: Job counts grouped by status type: object required: - total - by_status title: JobStats description: Job statistics summary. examples: - by_status: completed: 1489 failed: 19 pending: 12 processing: 3 total: 1523 SchemaStats: properties: total: type: integer title: Total description: Total number of schemas type: object required: - total title: SchemaStats description: Schema statistics summary. examples: - total: 8 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 JobStatsByStatus: properties: pending: type: integer title: Pending description: Number of pending jobs default: 0 processing: type: integer title: Processing description: Number of processing jobs default: 0 completed: type: integer title: Completed description: Number of completed jobs default: 0 failed: type: integer title: Failed description: Number of failed jobs default: 0 type: object title: JobStatsByStatus description: Job counts grouped by status. examples: - completed: 1489 failed: 19 pending: 12 processing: 3 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: 'API Key authentication. Format: dk_test_ or dk_live_' ````