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

# Get endpoint statistics

> Returns aggregated statistics including total counts, live/contained counts, and OS distribution



## OpenAPI

````yaml https://api.wirespeed.co/v1/openapi.json post /v1/endpoint/stats
openapi: 3.0.0
info:
  title: Wirespeed API
  description: The public Wirespeed API. v1 is the first stable contract.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wirespeed.co
security: []
tags: []
paths:
  /v1/endpoint/stats:
    post:
      tags:
        - Endpoint
      summary: Get endpoint statistics
      description: >-
        Returns aggregated statistics including total counts, live/contained
        counts, and OS distribution
      operationId: EndpointController_getStats
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointStatsDto'
      responses:
        '200':
          description: Endpoint statistics for the current team
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointStats'
      security:
        - bearer: []
components:
  schemas:
    EndpointStatsDto:
      type: object
      properties:
        startDate:
          type: string
          description: Start date (inclusive, ISO8601 string)
        endDate:
          type: string
          description: End date (inclusive, ISO8601 string)
        showUnmanagedEndpoints:
          type: boolean
          description: Include unmanaged endpoints in statistics
        onlyContained:
          type: boolean
          description: Only include contained endpoints
        onlyLive:
          type: boolean
          description: Only include live/online endpoints
        operatingSystemCategories:
          type: array
          description: Filter by OS categories (supports multiple)
          items:
            type: string
            enum:
              - Windows
              - Windows Server
              - macOS
              - Linux
              - iOS
              - Android
              - ChromeOS
              - Network Device
              - Other
        dedupeCanonicalRoots:
          type: boolean
          description: >-
            When true, stats count only canonical representative rows
            (canonical_id IS NULL)
        onlyCanonicalClustersWithDuplicates:
          type: boolean
          description: >-
            When true together with dedupeCanonicalRoots, stats include only
            canonical roots that have at least one merged duplicate from another
            source
    EndpointStats:
      type: object
      properties:
        totalCount:
          type: number
          description: Total number of endpoints
        liveCount:
          type: number
          description: Number of live/online endpoints
        containedCount:
          type: number
          description: Number of contained endpoints
        uncontainedCount:
          type: number
          description: Number of uncontained endpoints
        operatingSystems:
          description: Endpoint counts grouped by OS category
          type: array
          items:
            $ref: '#/components/schemas/EndpointOsCount'
        integrations:
          description: Endpoint counts grouped by integration source
          type: array
          items:
            $ref: '#/components/schemas/EndpointIntegrationCount'
      required:
        - totalCount
        - liveCount
        - containedCount
        - uncontainedCount
        - operatingSystems
        - integrations
    EndpointOsCount:
      type: object
      properties:
        operatingSystem:
          type: string
          enum:
            - Windows
            - Windows Server
            - macOS
            - Linux
            - iOS
            - Android
            - ChromeOS
            - Network Device
            - Other
          description: OS category
        count:
          type: number
          description: Count of endpoints with this operating system
      required:
        - operatingSystem
        - count
    EndpointIntegrationCount:
      type: object
      properties:
        integrationId:
          type: string
          description: Integration ID
        platform:
          type: string
          description: Integration platform
        count:
          type: number
          description: Count of endpoints from this integration
      required:
        - integrationId
        - platform
        - count
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````