AssetLab Dashboard Snapshots API

openapi: 3.2.0
info:
  title: Assetlab Ca Dashboard Snapshots API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged Dashboard 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: Dashboard Snapshots
  description: Monthly aggregate dashboard snapshots
paths:
  /dashboard-snapshots:
    get:
      operationId: listDashboardSnapshots
      summary: List dashboard snapshots
      tags:
      - Dashboard Snapshots
      description: Returns a paginated list of historical dashboard metric snapshots. Requires `dashboard_snapshots:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: year
        in: query
        schema:
          type: integer
        description: Filter by snapshot year
      - name: month
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 12
        description: Filter by snapshot month (1-12)
      responses:
        '200':
          description: Paginated dashboard snapshot list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DashboardSnapshot'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /dashboard-snapshots/{id}:
    get:
      operationId: getDashboardSnapshot
      summary: Get dashboard snapshot by ID
      tags:
      - Dashboard Snapshots
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Dashboard snapshot detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DashboardSnapshot'
        '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'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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
  schemas:
    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
    DashboardSnapshot:
      type: object
      properties:
        id:
          type: string
          format: uuid
        snapshot_date:
          type: string
          format: date
          nullable: true
        snapshot_month:
          type: integer
          nullable: true
        snapshot_year:
          type: integer
          nullable: true
        total_assets:
          type: integer
          nullable: true
        critical_assets:
          type: integer
          nullable: true
        avg_condition:
          type: number
          nullable: true
        end_of_life_assets:
          type: integer
          nullable: true
        total_crv:
          type: number
          nullable: true
          description: Money in the organization's currency - GET /v1/organization-settings for currency_code
        open_work_orders:
          type: integer
          nullable: true
        high_priority_work_orders:
          type: integer
          nullable: true
        overdue_work_orders:
          type: integer
          nullable: true
        completed_work_orders:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
  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