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

# Response-rate metrics over the invitation dispatches

> responseRate = (responded + partially_responded) / total, or null when there are no dispatches in scope.



## OpenAPI

````yaml /openapi-v1.json get /v1/dispatches/stats
openapi: 3.0.0
info:
  title: Woku Client API v1
  description: >-
    Public REST API for programmatic management of woku Voice-of-Customer
    programs: trackers, VoC instruments (NPS, woku, CES, CSAT), action plans,
    support tickets, multi-channel sending and response capture. Requests are
    company-scoped by the API key; never send a company id.
  version: 1.0.0
  contact:
    name: Woku
    url: https://woku.app
    email: team@woku.app
servers:
  - url: https://clientapi.woku.app
    description: Production
security: []
tags: []
paths:
  /v1/dispatches/stats:
    get:
      tags:
        - v1 - dispatches
      summary: Response-rate metrics over the invitation dispatches
      description: >-
        responseRate = (responded + partially_responded) / total, or null when
        there are no dispatches in scope.
      operationId: V1DispatchesController_stats
      parameters:
        - name: channel
          required: false
          in: query
          description: Outbound channel of the send.
          schema:
            type: string
            enum:
              - email
              - whatsapp
        - name: responseType
          required: false
          in: query
          description: Only dispatches targeting this tool kind.
          schema:
            type: string
            enum:
              - woku
              - nps
              - form
              - client-form
              - csat
              - ces
        - name: targetId
          required: false
          in: query
          description: Only dispatches targeting this specific tool/woku/form id.
          schema:
            type: string
            format: ObjectId
        - name: createdFrom
          required: false
          in: query
          description: Lower bound for createdAt (ISO 8601).
          schema:
            type: string
        - name: createdTo
          required: false
          in: query
          description: Upper bound for createdAt (ISO 8601).
          schema:
            type: string
      responses:
        '200':
          description: Aggregate response-rate metrics
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Company secret API key.

````