> ## 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 groups report > Returns conversation metrics for every group in the workspace over a date range, each compared against the immediately preceding period of the same length. All groups are returned; the response is not paginated. > [!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/groups 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/groups: get: tags: - Reports summary: Get groups report description: > Returns conversation metrics for every group in the workspace over a date range, each compared against the immediately preceding period of the same length. All groups are returned; the response is not paginated. 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 content: application/json: schema: $ref: '#/components/schemas/groups_report_response' example: groups: - id: 42052a48-321b-4e6e-9c38-43b6fa467973 name: Customer Support assigned_conversations_count: present: 0 previous: 0 change_percentage: null open_conversations_count: present: 0 previous: 0 change_percentage: null closed_conversations_count: present: 0 previous: 0 change_percentage: null - id: abd828dd-bcfe-4197-ac1f-d7ca796b3ae0 name: Sales assigned_conversations_count: present: 3 previous: 0 change_percentage: null open_conversations_count: present: 1 previous: 0 change_percentage: null closed_conversations_count: present: 0 previous: 0 change_percentage: null total_count: 2 '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: groups_report_response: type: object properties: groups: type: array description: Every group in the workspace. The response is not paginated. items: $ref: '#/components/schemas/group_report' total_count: type: integer description: Number of groups in `groups`. example: 1 error: type: object properties: error: type: string example: The request could not be processed. group_report: type: object properties: id: type: string format: uuid example: abd828dd-bcfe-4197-ac1f-d7ca796b3ae0 name: type: string example: Sales assigned_conversations_count: $ref: '#/components/schemas/change_metric' open_conversations_count: $ref: '#/components/schemas/change_metric' closed_conversations_count: $ref: '#/components/schemas/change_metric' change_metric: type: object properties: present: type: integer description: Value for the requested date range. example: 4 previous: type: integer description: Value for the immediately preceding period of the same length. example: 2 change_percentage: type: number nullable: true description: >- Percentage change from `previous` to `present`. `null` when `previous` or `present` is zero. example: 100 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.