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

# Get Target Health Score

> Returns a target's security health score and letter grade, along with its total number of findings.



## OpenAPI

````yaml /openapi.json get /v1/targets/{target_id}/health-score
openapi: 3.1.0
info:
  title: MindFort API
  version: 1.0.0
  description: >-
    The MindFort Public API supports targets, Discovery, assessments, finding
    lifecycle and analytics, and reports. Informational probe results are
    labeled `secured`.
servers:
  - url: https://api.mindfort.app
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/targets/{target_id}/health-score:
    get:
      tags:
        - Analytics
      summary: Get Target Health Score
      description: >-
        Returns a target's security health score and letter grade, along with
        its total number of findings.
      operationId: getTargetHealthScore
      parameters:
        - name: target_id
          in: path
          required: true
          description: Target UUID
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthScoreResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Not permitted for this organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    HealthScoreResponse:
      properties:
        target_id:
          type: string
          format: uuid
          title: Target Id
        health_score:
          title: Health Score
          minimum: 0
          maximum: 10
          description: >-
            Security health score from 0 to 10; higher is better. Null means the
            target has not completed a red-team assessment.
          type:
            - number
            - 'null'
        health_grade:
          type: string
          enum:
            - A
            - B
            - C
            - D
            - F
            - N/A
          title: Health Grade
          description: A >= 9, B >= 8, C >= 7, D >= 6, and F < 6; N/A means not assessed.
        total_findings:
          type: integer
          title: Total Findings
          description: Active vulnerable findings contributing to the health score.
      type: object
      required:
        - target_id
        - health_grade
        - total_findings
      title: HealthScoreResponse
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: Stable machine-readable error code when one is available
        request_id:
          type: string
          description: Unique request identifier for debugging
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key generated from the MindFort dashboard. Pass as `Authorization:
        Bearer <your-api-key>`.

````

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