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

# Instrument Health



## OpenAPI

````yaml /openapi.json get /v1/organizations/{organization_id}/apps/{app_id}/environments/{environment_id}/analytics/instrument-health
openapi: 3.1.0
info:
  description: Are we on the same page?
  title: Synapse
  version: 0.1.0
servers: []
security: []
paths:
  /v1/organizations/{organization_id}/apps/{app_id}/environments/{environment_id}/analytics/instrument-health:
    get:
      tags:
        - v1-platform
      summary: Instrument Health
      operationId: >-
        instrument_health_v1_organizations__organization_id__apps__app_id__environments__environment_id__analytics_instrument_health_get
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            format: uuid
            title: Organization Id
            type: string
        - in: path
          name: app_id
          required: true
          schema:
            format: uuid
            title: App Id
            type: string
        - in: path
          name: environment_id
          required: true
          schema:
            format: uuid
            title: Environment Id
            type: string
        - in: query
          name: starts_at
          required: true
          schema:
            format: date-time
            title: Starts At
            type: string
        - in: query
          name: ends_at
          required: true
          schema:
            format: date-time
            title: Ends At
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentInstrumentHealth'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Insufficient scope
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Resource not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Request validation failed
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Internal server error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
        - SessionCookie: []
components:
  schemas:
    EnvironmentInstrumentHealth:
      properties:
        completion_rate:
          maximum: 1
          minimum: 0
          title: Completion Rate
          type: number
        ends_at:
          format: date-time
          title: Ends At
          type: string
        environment_id:
          format: uuid
          title: Environment Id
          type: string
        median_active_ms:
          anyOf:
            - minimum: 0
              type: number
            - type: 'null'
          title: Median Active Ms
        median_questions:
          anyOf:
            - minimum: 0
              type: number
            - type: 'null'
          title: Median Questions
        privacy_floor_applied:
          title: Privacy Floor Applied
          type: boolean
        question_health:
          items:
            $ref: '#/components/schemas/QuestionHealth'
          title: Question Health
          type: array
        reasons:
          items:
            type: string
          title: Reasons
          type: array
        sessions_abandoned:
          minimum: 0
          title: Sessions Abandoned
          type: integer
        sessions_active:
          minimum: 0
          title: Sessions Active
          type: integer
        sessions_completed:
          minimum: 0
          title: Sessions Completed
          type: integer
        sessions_started:
          minimum: 0
          title: Sessions Started
          type: integer
        starts_at:
          format: date-time
          title: Starts At
          type: string
        status:
          enum:
            - healthy
            - attention_required
            - insufficient_data
          title: Status
          type: string
      required:
        - environment_id
        - starts_at
        - ends_at
        - sessions_started
        - sessions_completed
        - sessions_abandoned
        - sessions_active
        - completion_rate
        - status
        - privacy_floor_applied
      title: EnvironmentInstrumentHealth
      type: object
    ApiErrorResponse:
      additionalProperties: false
      properties:
        detail:
          anyOf:
            - $ref: '#/components/schemas/ErrorDetail'
            - type: string
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          title: Detail
      required:
        - detail
      title: ApiErrorResponse
      type: object
    QuestionHealth:
      properties:
        answer_change_rate:
          maximum: 1
          minimum: 0
          title: Answer Change Rate
          type: number
        answer_changes:
          minimum: 0
          title: Answer Changes
          type: integer
        answer_rate:
          maximum: 1
          minimum: 0
          title: Answer Rate
          type: number
        answers:
          minimum: 0
          title: Answers
          type: integer
        median_elapsed_ms:
          anyOf:
            - minimum: 0
              type: number
            - type: 'null'
          title: Median Elapsed Ms
        question_id:
          title: Question Id
          type: string
        reasons:
          items:
            type: string
          title: Reasons
          type: array
        respondents:
          minimum: 0
          title: Respondents
          type: integer
        skip_rate:
          maximum: 1
          minimum: 0
          title: Skip Rate
          type: number
        skips:
          minimum: 0
          title: Skips
          type: integer
        status:
          enum:
            - healthy
            - attention_required
          title: Status
          type: string
        views:
          minimum: 0
          title: Views
          type: integer
      required:
        - question_id
        - respondents
        - views
        - answers
        - answer_changes
        - skips
        - answer_rate
        - skip_rate
        - answer_change_rate
        - status
      title: QuestionHealth
      type: object
    ErrorDetail:
      additionalProperties: false
      description: Stable structured detail returned by versioned API errors.
      properties:
        code:
          title: Code
          type: string
        context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Context
        message:
          title: Message
          type: string
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
      required:
        - code
        - message
      title: ErrorDetail
      type: object
  securitySchemes:
    BearerAuth:
      description: Named syn_ API key or migration-only legacy key.
      scheme: bearer
      type: http
    ApiKeyAuth:
      description: Header alias for a named or legacy API key.
      in: header
      name: X-API-Key
      type: apiKey
    SessionCookie:
      description: Opaque administrator browser session.
      in: cookie
      name: synapse_session
      type: apiKey

````