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

# Get form insights

> Get visits, starts, submissions, completion rate, average time to submit, and the split by device, operating system and browser. Covers all time unless you give a date range.

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


## OpenAPI

````yaml bundled/submissions.yaml GET /forms/{form_id}/insights
openapi: 3.0.3
info:
  title: NeetoForm APIs
  version: 2.0.0
servers:
  - description: NeetoForm APIs
    url: https://{your-subdomain}.neetoform.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
paths:
  /forms/{form_id}/insights:
    get:
      tags:
        - Insights
      summary: Get form insights
      description: >-
        Get visits, starts, submissions, completion rate, average time to
        submit, and the split by device, operating system and browser. Covers
        all time unless you give a date range.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/form_id_param'
        - in: query
          name: start_date
          description: First day of the range, as `YYYY-MM-DD`. Use it with `end_date`.
          required: false
          schema:
            type: string
            example: '2026-10-01'
        - in: query
          name: end_date
          description: >-
            Last day of the range (inclusive), as `YYYY-MM-DD`. Use it with
            `start_date`.
          required: false
          schema:
            type: string
            example: '2026-10-31'
        - in: query
          name: time_zone
          description: IANA time zone used for the date range, for example `Asia/Kolkata`.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/insights_response'
        '404':
          description: Not Found - The form does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: Form does not exist.
        '422':
          description: Unprocessable Entity - A date or the time zone is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: start_date and end_date must be given together.
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](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    form_id_param:
      in: path
      name: form_id
      description: >-
        Unique ID of the form for which you want to retrieve submissions. Refer
        to [Getting the Form ID](/api/getting-form-id) section for detailed
        instructions.
      required: true
      schema:
        type: string
  schemas:
    insights_response:
      type: object
      properties:
        visit_count:
          type: integer
        start_count:
          type: integer
        submission_count:
          type: integer
        completion_rate:
          type: number
          description: Percentage of started forms that were sent.
        average_submission_time:
          type: object
          properties:
            h:
              type: integer
            m:
              type: integer
            s:
              type: integer
        devices:
          type: object
          additionalProperties:
            type: integer
          description: Percentage of submissions for each device type.
        operating_systems:
          type: object
          additionalProperties:
            type: integer
          description: Percentage of submissions for each operating system.
        browsers:
          type: object
          additionalProperties:
            type: integer
          description: Percentage of submissions for each browser.
    error_response:
      type: object
      properties:
        error:
          type: string

````

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