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

# Get NPS tool report

> Retrieves NPS report data for a specific NPS tool including score distribution, response count, and detailed analytics.



## OpenAPI

````yaml /openapi.json get /reports/nps-tool/{npsToolId}
openapi: 3.0.3
info:
  title: Woku Client API
  description: >-
    API for integrating with Woku's feedback collection platform. This API
    allows you to create wokus (feedback collection tools), submit reviews, and
    retrieve reports.


    ## Authentication


    All endpoints require authentication using a Bearer token in the
    Authorization header. You can obtain your API key from the Woku dashboard.


    ```

    Authorization: Bearer your_api_key_here

    ```


    ## Base URL


    Production: `https://api.woku.app`
  version: 1.0.0
  contact:
    name: Woku Support
    url: https://woku.app
    email: team@woku.app
servers:
  - url: https://clientapi.woku.app
    description: Production server
security: []
tags:
  - name: Wokus
    description: Endpoints for creating and managing wokus (feedback collection tools)
  - name: Reviews
    description: Endpoints for submitting and retrieving reviews
  - name: Companies
    description: Endpoints for retrieving company data
  - name: Reports
    description: Endpoints for retrieving NPS and analytics reports
paths:
  /reports/nps-tool/{npsToolId}:
    get:
      tags:
        - Reports
      summary: Get NPS tool report
      description: >-
        Retrieves NPS report data for a specific NPS tool including score
        distribution, response count, and detailed analytics.
      operationId: getNpsToolReport
      parameters:
        - name: npsToolId
          in: path
          required: true
          description: MongoDB ObjectId of the NPS tool
          schema:
            type: string
            format: objectid
            example: 507f1f77bcf86cd799439011
      responses:
        '200':
          description: NPS tool report retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NpsToolReportResponse'
        '401':
          description: Invalid or missing authorization key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '404':
          description: NPS tool or company not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
        - BearerAuth: []
components:
  schemas:
    NpsToolReportResponse:
      type: object
      properties:
        npsToolId:
          type: string
          format: objectid
          description: NPS tool identifier
          example: 507f1f77bcf86cd799439021
        name:
          type: string
          description: NPS tool name
          example: Post-Purchase Survey
        npsScore:
          type: number
          description: Net Promoter Score for this tool (-100 to 100)
          example: 55
        totalResponses:
          type: integer
          description: Total number of responses for this tool
          example: 120
        promoters:
          type: object
          properties:
            count:
              type: integer
              example: 75
            percentage:
              type: number
              example: 62.5
        passives:
          type: object
          properties:
            count:
              type: integer
              example: 30
            percentage:
              type: number
              example: 25
        detractors:
          type: object
          properties:
            count:
              type: integer
              example: 15
            percentage:
              type: number
              example: 12.5
        scoreDistribution:
          type: object
          additionalProperties:
            type: integer
          description: Distribution of scores from 0-10
        recentResponses:
          type: array
          items:
            type: object
            properties:
              score:
                type: integer
                minimum: 0
                maximum: 10
              comment:
                type: string
              createdAt:
                type: string
                format: date-time
          description: Recent NPS responses
    UnauthorizedError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 401
        message:
          type: string
          example: Invalid or missing API key
    NotFoundError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        message:
          type: string
          example: Resource not found
        error:
          type: string
          example: Not Found
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Company API key. Obtain this from your Woku dashboard under Settings >
        API Keys.

````