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

# Get monitoring analysis

> Retrieve one customer health analysis produced by the monitoring agent.



## OpenAPI

````yaml get /v1/agents/monitoring/analyses/{analysis_id}
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/agents/monitoring/analyses/{analysis_id}:
    get:
      tags:
        - Monitoring
      summary: Get monitoring analysis
      description: Retrieve one customer health analysis produced by the monitoring agent.
      operationId: getMonitoringAnalysis
      parameters:
        - schema:
            type: string
          required: true
          name: analysis_id
          in: path
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringAnalysis'
        '404':
          description: Monitoring analysis not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    MonitoringAnalysis:
      type: object
      properties:
        id:
          type: string
          description: Analysis ID.
          example: moa_7Hn2kQp9XcLwRt
        run_id:
          type: string
          description: ID of the monitoring run that produced the analysis.
          example: agr_3Fm8vNq1ZsKdYb
        agent_id:
          type: string
          description: ID of the monitoring agent that produced the analysis.
          example: agt_9Lp4wEr6TyUiOa
        customer_id:
          type: string
          description: ID of the analysed customer.
          example: cus_Typ0px2W0aiEtl
        status:
          type: string
          enum:
            - in_progress
            - completed
            - skipped
            - failed
          description: |-
            Analysis status.

            - in_progress: The agent is analysing the customer.
            - completed: The customer was scored.
            - skipped: The agent skipped the customer in this run.
            - failed: The analysis failed.
          example: completed
        score:
          type:
            - number
            - 'null'
          description: >-
            Health score between 0 (critical) and 100 (healthy). `null` when the
            analysis did not produce a score.
          example: 42
        previous_score:
          type:
            - number
            - 'null'
          description: >-
            Score of the previous analysis of the customer. `null` for the first
            analysis.
          example: 58
        tier:
          type:
            - string
            - 'null'
          enum:
            - critical
            - at_risk
            - needs_attention
            - healthy
          description: >-
            Health tier derived from the score and the thresholds the analysis
            was scored with. `null` when there is no score.
          example: at_risk
        summary:
          type:
            - string
            - 'null'
          description: >-
            Short explanation of the score written by the agent. `null` when not
            available.
          example: >-
            Two invoices overdue for 30+ days and active usage down 40% over the
            last month.
        dimensions:
          $ref: '#/components/schemas/MonitoringAnalysisDimensions'
        risk_factors:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Risks identified by the agent. `null` when none.
          example:
            - Two invoices overdue for more than 30 days
        positive_signals:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Positive signals identified by the agent. `null` when none.
          example:
            - Renewed annual contract in January
        hard_rules_triggered:
          type:
            - array
            - 'null'
          items:
            type: string
          description: >-
            Scoring rules that capped the score. `null` when none were
            triggered.
          example: null
        created_at:
          type: string
          format: date-time
          description: Date the analysis was created.
          example: '2026-09-28T06:12:44.000Z'
      required:
        - id
        - run_id
        - agent_id
        - customer_id
        - status
        - score
        - previous_score
        - tier
        - summary
        - dimensions
        - risk_factors
        - positive_signals
        - hard_rules_triggered
        - created_at
    MonitoringAnalysisDimensions:
      type:
        - object
        - 'null'
      properties:
        payment_health:
          type:
            - object
            - 'null'
          properties:
            score:
              type:
                - number
                - 'null'
              description: >-
                Dimension score between 0 and 100. `null` when not enough data
                was available.
              example: 40
          required:
            - score
          description: >-
            Dimension score. `null` when the dimension was not scored in this
            analysis.
        usage_engagement:
          type:
            - object
            - 'null'
          properties:
            score:
              type:
                - number
                - 'null'
              description: >-
                Dimension score between 0 and 100. `null` when not enough data
                was available.
              example: 40
          required:
            - score
          description: >-
            Dimension score. `null` when the dimension was not scored in this
            analysis.
        support_signals:
          type:
            - object
            - 'null'
          properties:
            score:
              type:
                - number
                - 'null'
              description: >-
                Dimension score between 0 and 100. `null` when not enough data
                was available.
              example: 40
          required:
            - score
          description: >-
            Dimension score. `null` when the dimension was not scored in this
            analysis.
        contract_valuation:
          type:
            - object
            - 'null'
          properties:
            score:
              type:
                - number
                - 'null'
              description: >-
                Dimension score between 0 and 100. `null` when not enough data
                was available.
              example: 40
          required:
            - score
          description: >-
            Dimension score. `null` when the dimension was not scored in this
            analysis.
        communication:
          type:
            - object
            - 'null'
          properties:
            score:
              type:
                - number
                - 'null'
              description: >-
                Dimension score between 0 and 100. `null` when not enough data
                was available.
              example: 40
          required:
            - score
          description: >-
            Dimension score. `null` when the dimension was not scored in this
            analysis.
        custom:
          type:
            - object
            - 'null'
          properties:
            score:
              type:
                - number
                - 'null'
              description: >-
                Dimension score between 0 and 100. `null` when not enough data
                was available.
              example: 40
          required:
            - score
          description: >-
            Dimension score. `null` when the dimension was not scored in this
            analysis.
      required:
        - payment_health
        - usage_engagement
        - support_signals
        - contract_valuation
        - communication
        - custom
      description: >-
        Per-dimension scores the health score is computed from. `null` when the
        analysis has no breakdown.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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