AssetLab LoS Status Snapshots API

openapi: 3.2.0
info:
  title: Assetlab Ca LoS Status Snapshots API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged LoS Status Snapshots across 2 of this provider''s published API definitions: assetlab-ca-openapi.yaml, assetlab-ca-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
  description: Production
security:
- BearerAuth: []
tags:
- name: LoS Status Snapshots
  description: Read-only monthly readings of technical LoS status, one per tracked pair and metric
paths:
  /los-status-snapshots:
    get:
      operationId: listLosStatusSnapshots
      summary: List LoS status snapshots
      tags:
      - LoS Status Snapshots
      description: 'Returns monthly technical level of service readings, newest month first. One reading is kept per tracked pair per month, taken the first time Status is opened in the app that month, so a month can be missing. A reading belongs either to a system in a building or to an infrastructure network. Read-only: readings are recorded by the app and cannot be written through the API. Requires `los_status:read` scope.'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: system_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by system
      - name: building_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by building
      - name: network_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by infrastructure network
      - name: metric
        in: query
        schema:
          type: string
          enum:
          - fci
          - asset_condition_avg
          - asset_past_useful_life_pct
          - risk_score_avg
        description: Filter by metric
      - name: period_from
        in: query
        schema:
          type: string
          format: date
        description: Earliest month to include (YYYY-MM-DD, compared with period_start)
      - name: period_to
        in: query
        schema:
          type: string
          format: date
        description: Latest month to include (YYYY-MM-DD, compared with period_start)
      responses:
        '200':
          description: Paginated LoS status snapshot list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LosStatusSnapshot'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /los-status-snapshots/{id}:
    get:
      operationId: getLosStatusSnapshot
      summary: Get LoS status snapshot by ID
      tags:
      - LoS Status Snapshots
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: LoS status snapshot detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/LosStatusSnapshot'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request (validation error or malformed input)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    LosStatusSnapshot:
      type: object
      description: 'One reading per tracked pair (a system in a building, or an infrastructure network) and

        metric per month, recorded the first time anyone opens the Status screen in that month,

        so months can be missing. Append-only. A reading has either system_id and building_id,

        or network_id.

        '
      properties:
        id:
          type: string
          format: uuid
        tenant_id:
          type: string
        period_start:
          type: string
          format: date
          description: First day of the month the reading belongs to
        system_id:
          type: string
          format: uuid
          nullable: true
        building_id:
          type: string
          format: uuid
          nullable: true
        network_id:
          type: string
          format: uuid
          nullable: true
        metric:
          type: string
          enum:
          - fci
          - asset_condition_avg
          - asset_past_useful_life_pct
          - risk_score_avg
        actual:
          type: number
          nullable: true
          description: Measured reading; null means no data. fci and asset_past_useful_life_pct are 0-100 percentages (not fractions), asset_condition_avg is 0-100, risk_score_avg is 0-25
        base_target:
          type: number
          description: The organization-wide target at the time (not money)
        derived_target:
          type: number
          description: 'What this facility was held to then: base_target adjusted by its criticality (not money)'
        criticality:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
        status:
          type: string
          enum:
          - exceeding
          - meeting
          - below
          - failing
          - no_data
        sample_size:
          type: integer
          minimum: 0
        captured_by:
          type: string
          nullable: true
        captured_at:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        total:
          type: integer
          example: 142
        total_pages:
          type: integer
          example: 6
    Error:
      type: object
      properties:
        error:
          type: string
          example: Asset not found
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Resource UUID
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number
    per_page:
      name: per_page
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 1000
      description: Items per page
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key from AssetLab Settings > API Keys
x-refined-from:
- assetlab-ca-openapi.yaml
- assetlab-ca-openapi.yaml
x-tagGroups:
- name: Core
  tags:
  - Assets
  - Work Orders
  - Work Requests
  - PM Schedules
  - PM Templates
- name: Facilities
  tags:
  - Sites
  - Buildings
  - Locations
- name: Feature Classification
  tags:
  - Systems
  - System Groups
  - System Classes
  - Asset Types
  - Asset Type Groups
  - Manufacturers
- name: Projects
  tags:
  - Projects
  - Project Sites
  - Project Buildings
  - Project Locations
  - Project System Classes
  - Project System Groups
  - Project Systems
  - Project Assets
  - Project Tasks
  - Project Milestones
  - Project Phases
  - Project Budget Items
  - Project Time Entries
  - Project Comments
  - Project Risks
  - Project Document Folder Templates
- name: Financial
  tags:
  - Budgets
  - Invoices
  - Purchase Orders
  - Expenses
  - Change Orders
  - Cost Categories
  - Asset Costs
  - Asset Replacement Plans
- name: Vendors & Contracts
  tags:
  - Vendors
  - Contracts
  - Vendor Site Assignments
  - Contract Sites
- name: Compliance
  tags:
  - Compliance
  - Compliance Records
- name: Parts & Inventory
  tags:
  - Parts
  - Part Categories
- name: Comments & Documents
  tags:
  - Asset Comments
  - Work Order Comments
  - Asset Documents
  - Project Documents
  - Contract Documents
  - Attachments
  - Upload URLs
- name: Level of Service
  tags:
  - Service Areas
  - Service Area System Classes
  - Service Area Sites
  - LoS Measures
  - LoS Measurements
  - LoS Proposed Targets
  - LoS Targets History
  - System LoS Targets
  - Infrastructure LoS Targets
  - Criticality Modifiers
  - LoS Consequences
  - LoS Status Snapshots
- name: Infrastructure
  tags:
  - Infrastructure Feature Classes
  - Infrastructure Networks
  - Infrastructure Assets
  - Infrastructure Asset Inspections
- name: Dashboard & Analytics
  tags:
  - Dashboard
  - Dashboard Snapshots
  - Site FCI History
  - Asset Risk History
  - Asset Condition Assessments
- name: Configuration
  tags:
  - Asset Statuses
  - Work Categories
  - Building Types
  - Location Types
  - Custom Field Definitions
  - Custom Field Values