> ## 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.

# Headline figures per tool type

> Reviews and the native-scale headline of each type (woku stars, NPS score, CSAT satisfied %, CES mean) for the whole company or one folder and its subfolders. Scales are never mixed. A type that fails to compute reports `{ error: true }` and the others stay valid.



## OpenAPI

````yaml /openapi-v1.json get /v1/tools/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/tools/stats:
    get:
      tags:
        - v1 - tools
      summary: Headline figures per tool type
      description: >-
        Reviews and the native-scale headline of each type (woku stars, NPS
        score, CSAT satisfied %, CES mean) for the whole company or one folder
        and its subfolders. Scales are never mixed. A type that fails to compute
        reports `{ error: true }` and the others stay valid.
      operationId: V1ToolsController_getToolsStats
      parameters:
        - name: folderId
          required: false
          in: query
          description: >-
            Scope the figures to this folder and its subfolders. Omit for the
            whole company.
          schema:
            type: string
            format: ObjectId
        - name: from
          required: false
          in: query
          description: Only responses on or after this date (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: to
          required: false
          in: query
          description: Only responses on or before this date (ISO 8601).
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Figures per type
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Company secret API key.

````

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