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

# Obtener reporte de herramienta NPS

> Recupera los datos del reporte NPS de una herramienta NPS especifica, incluyendo la distribucion de puntaje, el conteo de respuestas y analiticas detalladas.



## OpenAPI

````yaml /openapi.es.json get /reports/nps-tool/{npsToolId}
openapi: 3.0.3
info:
  title: Woku Client API
  description: >-
    API para integrarse con la plataforma de recoleccion de feedback de Woku.
    Esta API te permite crear wokus (herramientas de recoleccion de feedback),
    enviar reseñas y obtener reportes.


    ## Autenticacion


    Todos los endpoints requieren autenticacion mediante un token Bearer en el
    header Authorization. Puedes obtener tu API key desde el dashboard de Woku.


    ```

    Authorization: Bearer your_api_key_here

    ```


    ## Base URL


    Produccion: `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: Servidor de produccion
security: []
tags:
  - name: Wokus
    description: >-
      Endpoints para crear y gestionar wokus (herramientas de recoleccion de
      feedback)
  - name: Reseñas
    description: Endpoints para enviar y obtener reseñas
  - name: Empresas
    description: Endpoints para obtener datos de la empresa
  - name: Reportes
    description: Endpoints para obtener reportes de NPS y analitica
paths:
  /reports/nps-tool/{npsToolId}:
    get:
      tags:
        - Reportes
      summary: Obtener reporte de herramienta NPS
      description: >-
        Recupera los datos del reporte NPS de una herramienta NPS especifica,
        incluyendo la distribucion de puntaje, el conteo de respuestas y
        analiticas detalladas.
      operationId: getNpsToolReport
      parameters:
        - name: npsToolId
          in: path
          required: true
          description: MongoDB ObjectId de la herramienta NPS
          schema:
            type: string
            format: objectid
            example: 507f1f77bcf86cd799439011
      responses:
        '200':
          description: Reporte de herramienta NPS recuperado correctamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NpsToolReportResponse'
        '401':
          description: Clave de autorizacion invalida o faltante
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '404':
          description: Herramienta NPS o empresa no encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
        - BearerAuth: []
components:
  schemas:
    NpsToolReportResponse:
      type: object
      properties:
        npsToolId:
          type: string
          format: objectid
          description: Identificador de la herramienta NPS
          example: 507f1f77bcf86cd799439021
        name:
          type: string
          description: Nombre de la herramienta NPS
          example: Post-Purchase Survey
        npsScore:
          type: number
          description: Net Promoter Score de esta herramienta (-100 a 100)
          example: 55
        totalResponses:
          type: integer
          description: Numero total de respuestas de esta herramienta
          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: Distribucion de puntajes de 0 a 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: Respuestas NPS recientes
    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: >-
        Clave de API de la empresa. Obtenla desde tu dashboard de Woku en
        Settings > API Keys.

````