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

# Get customer satisfaction report

> Returns the workspace's customer satisfaction (CSAT) ratings over a date range, broken down by day and by rating.

Ratings come from the rating question on the post-chat survey. `csat_report` is `null` when the workspace has no such question configured.


> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](https://apidocs.neetochat.com/getting-started/workspace-subdomain.md).


## OpenAPI

````yaml bundled/reports.yaml GET /reports/customer_satisfactions
openapi: 3.0.3
info:
  title: NeetoChat Reports APIs
  version: 1.0.0
servers:
  - description: NeetoChat APIs
    url: https://{your-subdomain}.neetochat.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/getting-started/workspace-subdomain).
security: []
tags:
  - name: Reports
    description: APIs to retrieve reporting metrics for the workspace.
paths:
  /reports/customer_satisfactions:
    get:
      tags:
        - Reports
      summary: Get customer satisfaction report
      description: >
        Returns the workspace's customer satisfaction (CSAT) ratings over a date
        range, broken down by day and by rating.


        Ratings come from the rating question on the post-chat survey.
        `csat_report` is `null` when the workspace has no such question
        configured.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/accept_header'
        - $ref: '#/components/parameters/range_type_param'
        - $ref: '#/components/parameters/start_date_param'
        - $ref: '#/components/parameters/end_date_param'
      responses:
        '200':
          description: >-
            OK - Request succeeded. `csat_report` is `null` when no rating
            question is configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_satisfaction_response'
              example:
                csat_report:
                  dates:
                    - '2026-10-14'
                    - '2026-10-15'
                    - '2026-10-16'
                    - '2026-10-17'
                  data:
                    - name: good
                      values:
                        - 3
                        - 2
                        - 4
                        - 3
                    - name: okay
                      values:
                        - 1
                        - 2
                        - 1
                        - 1
                    - name: bad
                      values:
                        - 1
                        - 1
                        - 1
                        - 1
                  percentages:
                    good: 57
                    okay: 24
                    bad: 19
        '400':
          description: Bad Request - The date range is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                invalid_range_type:
                  summary: Unrecognized range_type
                  value:
                    error: 'Invalid date range name: not_a_real_range.'
                invalid_format:
                  summary: Unparsable date
                  value:
                    error: >-
                      Invalid start_date. It must be a date in the 'YYYY-MM-DD'
                      format.
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/getting-started/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    accept_header:
      in: header
      name: Accept
      description: >-
        Specifies the expected response format. Must be set to
        `application/json` for proper API communication.
      required: true
      schema:
        type: string
        enum:
          - application/json
        default: application/json
    range_type_param:
      in: query
      name: range_type
      description: >
        Pass `custom_duration` (or omit `range_type` while passing
        `start_date`/`end_date`) to report on an explicit range instead. When
        `range_type`, `start_date` and `end_date` are all omitted, the range
        defaults to `all_time`.
      required: false
      schema:
        type: string
        enum:
          - last_7_days
          - last_30_days
          - last_24_hours
          - this_month
          - last_month
          - this_year
          - last_year
          - this_quarter
          - last_quarter
          - this_week
          - last_week
          - all_time
          - custom_duration
        example: last_7_days
    start_date_param:
      in: query
      name: start_date
      description: >-
        Start of the date range to report on, as a `YYYY-MM-DD` date. Only used
        when `range_type` is `custom_duration` or omitted; ignored when
        `range_type` names a predefined range. Defaults to the workspace's
        creation date when omitted.
      required: false
      schema:
        type: string
        format: date
        example: '2026-10-01'
    end_date_param:
      in: query
      name: end_date
      description: >-
        End of the date range to report on, as a `YYYY-MM-DD` date. Only used
        when `range_type` is `custom_duration` or omitted; ignored when
        `range_type` names a predefined range. Defaults to today when omitted.
      required: false
      schema:
        type: string
        format: date
        example: '2026-10-17'
  schemas:
    customer_satisfaction_response:
      type: object
      properties:
        csat_report:
          $ref: '#/components/schemas/csat_report'
    error:
      type: object
      properties:
        error:
          type: string
          example: The request could not be processed.
    csat_report:
      type: object
      nullable: true
      description: >-
        Customer satisfaction data for the date range. `null` when the workspace
        has no rating question configured in its post-chat survey.
      properties:
        dates:
          type: array
          description: Every date in the requested range, oldest first.
          items:
            type: string
            format: date
          example:
            - '2026-10-16'
            - '2026-10-17'
        data:
          type: array
          description: >-
            One entry per rating, each holding a count for every date in
            `dates`, in the same order.
          items:
            type: object
            properties:
              name:
                type: string
                enum:
                  - good
                  - okay
                  - bad
                example: good
              values:
                type: array
                items:
                  type: integer
                example:
                  - 2
                  - 1
        percentages:
          type: object
          description: >-
            Share of total responses for each rating, rounded to the nearest
            integer percent. All zero when there are no responses in the range.
          properties:
            good:
              type: integer
              example: 62
            okay:
              type: integer
              example: 15
            bad:
              type: integer
              example: 23

````

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