> ## 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 historical service provider client usage

> Returns a paginated list of usage rows, one per client of the current service provider team. Only service provider teams can call this endpoint. Values come from nightly usage snapshots, which only include ingestion volume starting October 1, 2026. Billable counts come from the latest snapshot in the range. Byte totals are int64 values encoded as strings. Provide either month, or both startDate and endDate; a date range can be at most one year.



## OpenAPI

````yaml https://api.wirespeed.co/v1/openapi.json post /v1/team/clients/usage
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/team/clients/usage:
    post:
      tags:
        - Team
      summary: Get historical service provider client usage
      description: >-
        Returns a paginated list of usage rows, one per client of the current
        service provider team. Only service provider teams can call this
        endpoint. Values come from nightly usage snapshots, which only include
        ingestion volume starting October 1, 2026. Billable counts come from the
        latest snapshot in the range. Byte totals are int64 values encoded as
        strings. Provide either month, or both startDate and endDate; a date
        range can be at most one year.
      operationId: TeamController_getServiceProviderClientUsage
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceProviderClientUsageSearchDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceProviderClientUsageResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
      security:
        - bearer: []
components:
  schemas:
    ServiceProviderClientUsageSearchDto:
      type: object
      properties:
        size:
          type: number
        page:
          type: number
        filter:
          type: string
        search:
          type: string
        orderBy:
          type: string
        orderDir:
          type: string
          enum:
            - asc
            - desc
          default: asc
          x-extensible-enum: true
        startDate:
          type: string
          description: Start date (inclusive, ISO8601 string)
        endDate:
          type: string
          description: End date (inclusive, ISO8601 string)
        month:
          type: string
          description: >-
            UTC snapshot month in YYYY-MM format. Required when endDate is
            omitted; ignored when endDate is provided.
          example: 2026-08
    ServiceProviderClientUsageResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ServiceProviderClientUsageRow'
        totalCount:
          type: number
      required:
        - data
        - totalCount
    HttpError:
      type: object
      properties:
        message:
          type: string
        statusCode:
          type: number
        code:
          type: string
          description: >-
            Stable machine-readable error code. Clients should branch and
            translate on this instead of `message`.
        params:
          type: object
          description: Values interpolated into the message for `code`.
          additionalProperties:
            oneOf:
              - type: string
              - type: number
              - type: boolean
            nullable: true
        validationErrors:
          description: >-
            Per-property failures when `code` is `VALIDATION_FAILED` from
            request validation.
          type: array
          items:
            $ref: '#/components/schemas/HttpValidationIssue'
      required:
        - message
        - statusCode
    ServiceProviderClientUsageRow:
      type: object
      properties:
        id:
          type: string
          description: Client team ID
        name:
          type: string
          description: Client team name
        logoUrl:
          type: string
          nullable: true
          description: Client logo URL
        demo:
          type: boolean
          description: Whether the client is a demo team
        sku:
          type: string
          enum:
            - identity
            - adr
          description: Subscription SKU tier for the client
          x-extensible-enum: true
        addOns:
          type: array
          description: Active add-on SKUs for the client
          items:
            type: string
            enum:
              - data
            x-extensible-enum: true
        isTrial:
          type: boolean
          description: Whether the client is a proof-of-value trial
        skuEndDate:
          type: string
          nullable: true
          description: Contract/subscription end date
        billableUsers:
          type: number
          nullable: true
          description: >-
            Billable users on the latest snapshot in the date range. Null when
            the client has no snapshot in the range.
        billableEndpoints:
          type: number
          nullable: true
          description: >-
            Billable endpoints on the latest snapshot in the date range. Null
            when the client has no snapshot in the range.
        premiumIngestedBytes:
          type: string
          format: int64
          nullable: true
          description: Premium ingested bytes in the date range
        ingestedBytes:
          type: string
          format: int64
          nullable: true
          description: Ingested bytes in the date range
        integrationsConnected:
          type: number
          nullable: true
          description: Connected integrations on the latest snapshot in the date range
        premiumRetentionType:
          type: string
          enum:
            - THIRTY_DAYS
            - NINETY_DAYS
            - ONE_YEAR
            - THIRTEEN_MONTHS
          nullable: true
          description: >-
            Client's default premium integration data retention. Null when the
            client has no Data add-on.
          x-extensible-enum: true
      required:
        - id
        - name
        - logoUrl
        - demo
        - sku
        - addOns
        - isTrial
        - skuEndDate
        - billableUsers
        - billableEndpoints
        - premiumIngestedBytes
        - ingestedBytes
        - integrationsConnected
        - premiumRetentionType
    HttpValidationIssue:
      type: object
      properties:
        property:
          type: string
          description: Dotted path of the invalid property.
        constraint:
          type: string
          description: >-
            class-validator constraint name; clients translate
            `errors:validation.<constraint>`.
        params:
          type: object
          description: Values interpolated into the constraint message.
          additionalProperties:
            oneOf:
              - type: string
              - type: number
              - type: boolean
            nullable: true
        code:
          type: string
          description: Catalog code overriding the constraint translation.
      required:
        - property
        - constraint
        - params
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: >-
        Team API key sent as a Bearer token. Create a key in Wirespeed under
        Settings → Team. See
        https://docs.wirespeed.co/api-reference/authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.