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

# Get form summary

> Generate a comprehensive summary of form data and submission status for a specific form-site-year combination.

**Parameters**:
- `formId`: Form identifier
- `siteId`: Site identifier  
- `year`: Reporting year

**Summary includes**:
- **Completion Status**: Overall progress, missing data, validation status
- **Element Coverage**: Which form elements have been completed
- **Data Quality**: Validation issues, incomplete submissions
- **Temporal Analysis**: Period-by-period completion for time-series data
- **File Attachments**: Count and status of supporting documents
- **Submission History**: Timeline of data entry and modifications

**Use Cases**:
- Progress tracking for data collection campaigns
- Compliance reporting preparation
- Data quality assessment and gap analysis
- Dashboard widgets showing completion metrics
- Automated reporting and alert systems

**Quality Indicators**:
- Required vs. optional field completion
- Data validation status across all elements
- Period coverage for time-based reporting
- Supporting documentation completeness



## OpenAPI

````yaml https://app.azalt.co/api/v1/openapi.json get /forms/{formId}/sites/{siteId}/years/{year}/summary
openapi: 3.0.3
info:
  title: Erguvan Public API
  version: 1.0.0
servers:
  - url: https://app.azalt.co/api/v1
security: []
paths:
  /forms/{formId}/sites/{siteId}/years/{year}/summary:
    get:
      tags:
        - Form
      summary: Get form summary
      description: >-
        Generate a comprehensive summary of form data and submission status for
        a specific form-site-year combination.


        **Parameters**:

        - `formId`: Form identifier

        - `siteId`: Site identifier  

        - `year`: Reporting year


        **Summary includes**:

        - **Completion Status**: Overall progress, missing data, validation
        status

        - **Element Coverage**: Which form elements have been completed

        - **Data Quality**: Validation issues, incomplete submissions

        - **Temporal Analysis**: Period-by-period completion for time-series
        data

        - **File Attachments**: Count and status of supporting documents

        - **Submission History**: Timeline of data entry and modifications


        **Use Cases**:

        - Progress tracking for data collection campaigns

        - Compliance reporting preparation

        - Data quality assessment and gap analysis

        - Dashboard widgets showing completion metrics

        - Automated reporting and alert systems


        **Quality Indicators**:

        - Required vs. optional field completion

        - Data validation status across all elements

        - Period coverage for time-based reporting

        - Supporting documentation completeness
      operationId: getFormSummary
      parameters:
        - in: path
          name: formId
          schema:
            type: string
          required: true
        - in: path
          name: siteId
          schema:
            type: string
          required: true
        - in: path
          name: year
          schema:
            type: number
          required: true
        - in: query
          name: scoreMin
          schema:
            type: number
        - in: query
          name: scoreMax
          schema:
            type: number
        - in: query
          name: elementId
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSubmissions:
                    type: number
                  elementSummaries:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        type:
                          type: string
                        label:
                          type: string
                        periodStats:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              count:
                                type: number
                              periodUnit:
                                type: number
                              average:
                                type: number
                              min:
                                type: number
                              max:
                                type: number
                              sum:
                                type: number
                              optionCounts:
                                type: object
                                additionalProperties:
                                  type: number
                              textResponses:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    text:
                                      type: string
                                    length:
                                      type: number
                                    submissionId:
                                      type: string
                                  required:
                                    - text
                                    - length
                            required:
                              - count
                              - periodUnit
                      required:
                        - type
                        - label
                        - periodStats
                  progressRate:
                    type: number
                required:
                  - totalSubmissions
                  - elementSummaries
                  - progressRate
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - Authorization: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````